com.exacttarget.fuelsdk

Class ETRestObject

java.lang.Object

com.exacttarget.fuelsdk.ETObject

com.exacttarget.fuelsdk.ETApiObject

com.exacttarget.fuelsdk.ETRestObject

Direct Known Subclasses:

ETAsset, ETCampaign, ETCampaignAsset

public abstract class ETRestObject
extends ETApiObject

An ETRestObject represents an object available via the REST API.

Constructor Summary

Constructors

Constructor and Description
ETRestObject()

Method Summary

Modifier and Type	Method and Description
static <T extends ETRestObject> ETResponse<T>	create(ETClient client, List<T> objects)
static <T extends ETRestObject> ETResponse<T>	delete(ETClient client, List<T> objects)
static <T extends ETRestObject> T	deserialize(ETClient client, String payload, Class<T> type)
static <T extends ETRestObject> ETResponse<T>	deserialize(ETClient client, String payload, Class<T> type, String totalCount, String collection)
protected static String	getInternalProperty(Class<? extends ETRestObject> type, String name)
static <T extends ETRestObject> ETResponse<T>	retrieve(ETClient client, Class<T> type, Integer page, Integer pageSize, ETFilter filter)
String	serialize()
static String	toFilterString(ETExpression expression)
static <T extends ETRestObject> 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

Constructor Detail

ETRestObject

public ETRestObject()

Method Detail

retrieve

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

Type Parameters:

T - The type which extends from ETRestObject

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 ETRestObject

Throws:

ETSdkException

create

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

Type Parameters:

T - The type which extends from ETRestObject

Parameters:

client - The ETClient object

objects - The List of objects to create

Returns:

The ETResponse object of type T which extends from ETRestObject

Throws:

ETSdkException

update

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

Type Parameters:

T - The type which extends from ETRestObject

Parameters:

client - The ETClient object

objects - The List of objects to update

Returns:

The ETResponse object of type T which extends from ETRestObject

Throws:

ETSdkException

delete

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

Type Parameters:

T - The type which extends from ETRestObject

Parameters:

client - The ETClient object

objects - The List of objects to delete

Returns:

The ETResponse object of type T which extends from ETRestObject

Throws:

ETSdkException

serialize

public String serialize()

Returns:

The serialized JSON response.

deserialize

public static <T extends ETRestObject> T deserialize(ETClient client,
                                                     String payload,
                                                     Class<T> type)

Type Parameters:

T - The type which extends from ETRestObject

Parameters:

client - The ETClient object

payload - The payload to deserialize

type - The class type to deserialize

Returns:

The ETResponse object of type T which extends from ETRestObject

deserialize

public static <T extends ETRestObject> ETResponse<T> deserialize(ETClient client,
                                                                 String payload,
                                                                 Class<T> type,
                                                                 String totalCount,
                                                                 String collection)

Type Parameters:

T - The type which extends from ETRestObject

Parameters:

client - The ETClient object

payload - The payload to deserialize

type - The class type to deserialize

totalCount - The total count

collection - The collection

Returns:

The ETResponse object of type T which extends from ETRestObject

getInternalProperty

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

Throws:

ETSdkException

toFilterString

public static String toFilterString(ETExpression expression)
                             throws ETSdkException

Parameters:

expression - The ETExpression object as filter

Returns:

Converted filter string

Throws:

ETSdkException