com.exacttarget.fuelsdk

Class ETResponse<T extends ETApiObject>

java.lang.Object

com.exacttarget.fuelsdk.ETObject

com.exacttarget.fuelsdk.ETResponse<T>

public class ETResponse<T extends ETApiObject>
extends ETObject

An ETResponse object represents response from SOAP/REST call in the Salesforce Marketing Cloud.

Constructor Summary

Constructors

Constructor and Description
ETResponse()

Method Summary

Modifier and Type	Method and Description
void	addResult(ETResult<T> result)
T	getObject()
List<T>	getObjects()
Integer	getPage()
Integer	getPageSize()
String	getRequestId()
String	getResponseCode()
String	getResponseMessage()
ETResult<T>	getResult()
List<ETResult<T>>	getResults()
ETResult.Status	getStatus()
String	getStatusCode() Deprecated. Use getResponseCode.
String	getStatusMessage() Deprecated. Use getResponseMessage.
Integer	getTotalCount()
Boolean	hasMoreResults()
void	setMoreResults(Boolean moreResults)
void	setPage(Integer page)
void	setPageSize(Integer pageSize)
void	setRequestId(String requestId)
void	setResponseCode(String responseCode)
void	setResponseMessage(String responseMessage)
void	setStatus(ETResult.Status status)
void	setStatusCode(String statusCode) Deprecated. Use setResponseCode.
void	setStatusMessage(String statusMessage) Deprecated. Use setResponseMessage.
void	setTotalCount(Integer totalCount)

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

ETResponse

public ETResponse()

Method Detail

getStatus

public ETResult.Status getStatus()

Returns:

The Status of the ETResponse object.

setStatus

public void setStatus(ETResult.Status status)

Parameters:

status - The Status of the ETResponse object.

getRequestId

public String getRequestId()

Returns:

The Request Identifier of the ETResponse object.

setRequestId

public void setRequestId(String requestId)

Parameters:

requestId - The Request Identifier of the ETResponse object.

getResponseCode

public String getResponseCode()

Returns:

The response code of the ETResponse object.

setResponseCode

public void setResponseCode(String responseCode)

Parameters:

responseCode - The response code of the ETResponse object.

getResponseMessage

public String getResponseMessage()

Returns:

The response message of the ETResponse object.

setResponseMessage

public void setResponseMessage(String responseMessage)

Parameters:

responseMessage - The response message of the ETResponse object.

getObject

public T getObject()

Returns:

The Object from the ETResult.

getObjects

public List<T> getObjects()

Returns:

The List of individual Results Objects.

getResult

public ETResult<T> getResult()

Returns:

The ETResult Object associated with individual result of the ETResponse object.

getResults

public List<ETResult<T>> getResults()

Returns:

The List of ETResult Objects.

addResult

public void addResult(ETResult<T> result)

Parameters:

result - The ETResult object to add.

hasMoreResults

public Boolean hasMoreResults()

Returns:

true if there are more results, false otherwise.

setMoreResults

public void setMoreResults(Boolean moreResults)

Parameters:

moreResults - true if there are more results, false otherwise.

getPage

public Integer getPage()

Returns:

The page number of the ETResponse object.

setPage

public void setPage(Integer page)

Parameters:

page - The page number of the ETResponse object.

getPageSize

public Integer getPageSize()

Returns:

The page size of the ETResponse object.

setPageSize

public void setPageSize(Integer pageSize)

Parameters:

pageSize - The page size of the ETResponse object.

getTotalCount

public Integer getTotalCount()

Returns:

The total count of the ETResponse object.

setTotalCount

public void setTotalCount(Integer totalCount)

Parameters:

totalCount - The total count of the ETResponse object.

getStatusCode

@Deprecated
public String getStatusCode()

Deprecated. Use getResponseCode.

setStatusCode

@Deprecated
public void setStatusCode(String statusCode)

Deprecated. Use setResponseCode.

getStatusMessage

@Deprecated
public String getStatusMessage()

Deprecated. Use getResponseMessage.

setStatusMessage

@Deprecated
public void setStatusMessage(String statusMessage)

Deprecated. Use setResponseMessage.