public abstract class ETSoapObject extends ETApiObject
ETSoapObject
represents an object
available via the SOAP API.Modifier and Type | Class and Description |
---|---|
class |
ETSoapObject.DataExtensionRowConverter |
class |
ETSoapObject.EnumConverter |
class |
ETSoapObject.ExternalObjectConverter |
class |
ETSoapObject.InternalObjectConverter |
Modifier and Type | Field and Description |
---|---|
static int |
PAGE_SIZE
The page size
|
Constructor and Description |
---|
ETSoapObject()
Class constructor, Initializes a new instance of the class.
|
Modifier and Type | Method and Description |
---|---|
static <T extends ETSoapObject> |
create(ETClient client,
List<T> objects) |
protected static <T extends ETSoapObject> |
delete(ETClient client,
List<APIObject> objects,
boolean internal) |
static <T extends ETSoapObject> |
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> |
retrieve(ETClient client,
Class<T> type,
Integer page,
Integer pageSize,
ETFilter filter) |
protected static <T extends ETSoapObject> |
retrieve(ETClient client,
String continueRequest,
Class<T> type) |
protected static <T extends ETSoapObject> |
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> |
retrieve(ETClient client,
String soapObjectName,
ETFilter filter,
String continueRequest,
Class<T> type) |
static FilterPart |
toFilterPart(ETExpression expression) |
APIObject |
toInternal() |
static <T extends ETSoapObject> |
update(ETClient client,
List<T> objects) |
getAllModified, getId, getModified, setId, setModified
getAllFields, getAllFields, getClient, getField, getField, setClient, toString
public static final int PAGE_SIZE
public ETSoapObject()
public static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client, Class<T> type, Integer page, Integer pageSize, ETFilter filter) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objecttype
- The class type to retrievepage
- The page numberpageSize
- The page sizefilter
- The ETFilter objectETSdkException
protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client, String soapObjectName, ETFilter filter, Class<T> type) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectsoapObjectName
- The object name to retrieve for SOAPfilter
- The ETFilter objecttype
- The class type to retrieveETSdkException
protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client, String continueRequest, Class<T> type) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objecttype
- The class type to retrievecontinueRequest
- The continue requestETSdkException
protected static <T extends ETSoapObject> ETResponse<T> retrieve(ETClient client, String soapObjectName, ETFilter filter, String continueRequest, Class<T> type) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectsoapObjectName
- The object name to retrieve for SOAPfilter
- The ETFilter objectcontinueRequest
- The continue requesttype
- The class type to retrieveETSdkException
public static <T extends ETSoapObject> ETResponse<T> create(ETClient client, List<T> objects) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectobjects
- The List of objects to createETSdkException
public static <T extends ETSoapObject> ETResponse<T> update(ETClient client, List<T> objects) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectobjects
- The List of objects to updateETSdkException
public static <T extends ETSoapObject> ETResponse<T> delete(ETClient client, List<T> objects) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectobjects
- The List of objects to deleteETSdkException
protected static <T extends ETSoapObject> ETResponse<T> delete(ETClient client, List<APIObject> objects, boolean internal) throws ETSdkException
T
- The type which extends from ETSoapObjectclient
- The ETClient objectobjects
- The List of APIObjects to deleteinternal
- true if it is internal, false otherwiseETSdkException
public ETSoapObject fromInternal(APIObject internalObject) throws ETSdkException
internalObject
- The internal APIObjectETSdkException
public APIObject toInternal() throws ETSdkException
ETSdkException
protected static String getInternalProperty(Class<? extends ETSoapObject> type, String name) throws ETSdkException
ETSdkException
protected static List<String> getInternalProperties(Class<? extends ETSoapObject> type) throws ETSdkException
ETSdkException
public static FilterPart toFilterPart(ETExpression expression)
expression
- The ETExpression to create FilterPartCopyright © 2017. All rights reserved.