UserWebServiceResponse

Method Summary
	bindList(String target, DataList list) Adds the list to the payload and instructs the client to bind the list to the specified field target (of type 'Pick List'). See setAction which should be called prior to this method.
Payload	getPayload() Creates and/or returns the Payload for this response. If one does not already exist, it will be created when this method is called.
	setAction(String action, String name, Data data) Sets the action and ServiceResponse target of 'action'.
	setCurrentPage(int totalPages) Sets current page for target data list in response
	setError(String errorMessage) Sets the ServiceResponse success to false and errorMessage to message.
	setFile(Data data) Sets the file and ServiceResponse target of 'file'.
	setFile(File file) Sets the file and ServiceResponse target of 'file'.
	setHtml(String html) Sets the html content and ServiceResponse target of 'html'.
	setList(DataList list) Adds the list to the payload and sets the ServiceResponse target of 'list' and ServiceResponse list to the name of the list.
	setList(DataList list, String icon) Adds the list to the payload and sets the ServiceResponse target of 'list' and ServiceResponse list to the name of the list. Optionally allows to specify list icon
	setSuccess(String successMessage) Sets the ServiceResponse success to true and successMessage to message.
	setToken(String tokenUrl) Sets the single use token and ServiceResponse target of 'token'.
	setTotalPages(int totalPages) Sets total number of pages for target data list in response
String	toString() Returns a description of this object.

Method Detail

bindList(String target, DataList list)

Adds the list to the payload and instructs the client to bind the list to the specified field target (of type 'Pick List'). See setAction which should be called prior to this method.

Parameters:

String target Required parameter.
DataList list Required parameter.

Since: 11-28-2011

top

Payload getPayload()

Creates and/or returns the Payload for this response. If one does not already exist, it will be created when this method is called.

Returns: Payload

Since: 05-13-2011

top

setAction(String action, String name, Data data)

Sets the action and ServiceResponse target of 'action'.

Parameters:

String action - action to perform. Required parameter.
String name - name of data entry in payload.
Data data - data object to add to payload.

Since: 06-17-2011

top

setCurrentPage(int totalPages)

Sets current page for target data list in response

Parameters:

int totalPages - current page.

Since: 05-17-2011

top

setError(String errorMessage)

Sets the ServiceResponse success to false and errorMessage to message.

Parameters:

String errorMessage Required parameter.

Since: 05-13-2011

top

setFile(Data data)

Sets the file and ServiceResponse target of 'file'.

Parameters:

Data data - Data object to add to payload as a file. See File.toData. Required parameter.

Since: 11-11-2011

top

setFile(File file)

Sets the file and ServiceResponse target of 'file'.

Parameters:

File file - File object to add to payload as a file. See File.toData. Required parameter.

Since: 11-11-2011

top

setHtml(String html)

Sets the html content and ServiceResponse target of 'html'.

Parameters:

String html Required parameter.

Since: 05-13-2011

top

setList(DataList list)

Adds the list to the payload and sets the ServiceResponse target of 'list' and ServiceResponse list to the name of the list.

Parameters:

DataList list Required parameter.

Since: 05-13-2011

top

setList(DataList list, String icon)

Adds the list to the payload and sets the ServiceResponse target of 'list' and ServiceResponse list to the name of the list. Optionally allows to specify list icon

Parameters:

DataList list Required parameter.
String icon

Since: 11-24-2011

top

setSuccess(String successMessage)

Sets the ServiceResponse success to true and successMessage to message.

Parameters:

String successMessage Required parameter.

Since: 05-13-2011

top

setToken(String tokenUrl)

Sets the single use token and ServiceResponse target of 'token'.

Parameters:

String tokenUrl Required parameter.

Since: 05-13-2011

top

setTotalPages(int totalPages)

Sets total number of pages for target data list in response

Parameters:

int totalPages - total number of pages.

Since: 05-17-2011

top

String toString()

Returns a description of this object.

Returns: String

Since: 05-13-2011

top

API Date: Dec 03, 2024 10:24 AM