com.exacttarget.fuelsdk

Class ETSoapObject

java.lang.Object

com.exacttarget.fuelsdk.ETObject

com.exacttarget.fuelsdk.ETApiObject

com.exacttarget.fuelsdk.ETSoapObject

Direct Known Subclasses:

ETBounceEvent, ETClickEvent, ETContentArea, ETDataExtension, ETDataExtensionColumn, ETDataExtensionRow, ETEmail, ETExtractDescription, ETFolder, ETList, ETOpenEvent, ETProfileAttribute, ETResultMessage, ETSentEvent, ETSubscriber, ETSubscriberList, ETTriggeredEmail, ETTriggeredSendSummary, ETUnsubEvent

public abstract class ETSoapObject
extends ETApiObject

An ETSoapObject represents an object available via the SOAP API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ETSoapObject.DataExtensionRowConverter
class	ETSoapObject.EnumConverter
class	ETSoapObject.ExternalObjectConverter
class	ETSoapObject.InternalObjectConverter

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE The page size

Constructor Summary

Constructors

Constructor and Description
ETSoapObject() Class constructor, Initializes a new instance of the class.

Method Summary

Modifier and Type	Method and Description
static <T extends ETSoapObject> ETResponse<T>	create(ETClient client, List<T> objects)
protected static <T extends ETSoapObject> ETResponse<T>	delete(ETClient client, List<APIObject> objects, boolean internal)
static <T extends ETSoapObject> ETResponse<T>	delete(ETClient client, List<T> objects)
ETSoapObject	fromInternal(APIObject internalObject)
protected static List<String>	getInternalProperties(Class<? extends ETSoapObject> type)
protected static String	getInternalProperty(Class<? extends ETSoapObject> type, String name)
static <T extends ETSoapObject> ETResponse<T>	retrieve(ETClient client, Class<T> type, Integer page, Integer pageSize, ETFilter filter)
protected static <T extends ETSoapObject> ETResponse<T>	retrieve(ETClient client, String continueRequest, Class<T> type)
protected static <T extends ETSoapObject> ETResponse<T>	retrieve(ETClient client, String soapObjectName, ETFilter filter, Class<T> type) ETSoapObject has additional retrieve methods that take the SOAP object name and request ID for continuing requests.
protected static <T extends ETSoapObject> ETResponse<T>	retrieve(ETClient client, String soapObjectName, ETFilter filter, String continueRequest, Class<T> type)
static FilterPart	toFilterPart(ETExpression expression)
APIObject	toInternal()
static <T extends ETSoapObject> ETResponse<T>	update(ETClient client, List<T> objects)

Methods inherited from class com.exacttarget.fuelsdk.ETApiObject

getAllModified, getId, getModified, setId, setModified

Methods inherited from class com.exacttarget.fuelsdk.ETObject

getAllFields, getAllFields, getClient, getField, getField, setClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PAGE_SIZE

public static final int PAGE_SIZE

The page size

See Also:

Constant Field Values

Constructor Detail

ETSoapObject

public ETSoapObject()

Class constructor, Initializes a new instance of the class.

Method Detail

retrieve

public static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client,
                                                              Class<T> type,
                                                              Integer page,
                                                              Integer pageSize,
                                                              ETFilter filter)
                                                       throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

type - The class type to retrieve

page - The page number

pageSize - The page size

filter - The ETFilter object

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

retrieve

protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client,
                                                                 String soapObjectName,
                                                                 ETFilter filter,
                                                                 Class<T> type)
                                                          throws ETSdkException

ETSoapObject has additional retrieve methods that take the SOAP object name and request ID for continuing requests. In most cases, the SOAP object name is the same as the internal class name, but in a few cases, it is not (e.g., DataExtensionObjects require the name of the data extension in brackets: DataExtensionObject[foo]).

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

soapObjectName - The object name to retrieve for SOAP

filter - The ETFilter object

type - The class type to retrieve

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

retrieve

protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client,
                                                                 String continueRequest,
                                                                 Class<T> type)
                                                          throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

type - The class type to retrieve

continueRequest - The continue request

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

retrieve

protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client,
                                                                 String soapObjectName,
                                                                 ETFilter filter,
                                                                 String continueRequest,
                                                                 Class<T> type)
                                                          throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

soapObjectName - The object name to retrieve for SOAP

filter - The ETFilter object

continueRequest - The continue request

type - The class type to retrieve

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

create

public static <T extends ETSoapObject> ETResponse<T> create(ETClient client,
                                                            List<T> objects)
                                                     throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

objects - The List of objects to create

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

update

public static <T extends ETSoapObject> ETResponse<T> update(ETClient client,
                                                            List<T> objects)
                                                     throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

objects - The List of objects to update

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

delete

public static <T extends ETSoapObject> ETResponse<T> delete(ETClient client,
                                                            List<T> objects)
                                                     throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

objects - The List of objects to delete

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

delete

protected static <T extends ETSoapObject> ETResponse<T> delete(ETClient client,
                                                               List<APIObject> objects,
                                                               boolean internal)
                                                        throws ETSdkException

Type Parameters:

T - The type which extends from ETSoapObject

Parameters:

client - The ETClient object

objects - The List of APIObjects to delete

internal - true if it is internal, false otherwise

Returns:

The ETResponse object of type T which extends from ETSoapObject

Throws:

ETSdkException

fromInternal

public ETSoapObject fromInternal(APIObject internalObject)
                          throws ETSdkException

Parameters:

internalObject - The internal APIObject

Returns:

The ETSoapObject that is create from the internal APIObject parameter

Throws:

ETSdkException

toInternal

public APIObject toInternal()
                     throws ETSdkException

Returns:

The internal APIObject

Throws:

ETSdkException

getInternalProperty

protected static String getInternalProperty(Class<? extends ETSoapObject> type,
                                            String name)
                                     throws ETSdkException

Throws:

ETSdkException

getInternalProperties

protected static List<String> getInternalProperties(Class<? extends ETSoapObject> type)
                                             throws ETSdkException

Throws:

ETSdkException

toFilterPart

public static FilterPart toFilterPart(ETExpression expression)

Parameters:

expression - The ETExpression to create FilterPart

Returns:

The FilterPart object, can be SimpleFilterPart or ComplexFilterPart