io.javadog.cws.api.requests

Class FetchDataRequest

java.lang.Object

io.javadog.cws.api.requests.Verifiable

io.javadog.cws.api.requests.Authentication

io.javadog.cws.api.requests.FetchDataRequest

All Implemented Interfaces:

CircleIdRequest, Serializable

public final class FetchDataRequest
extends Authentication
implements CircleIdRequest

The Request Object must be filled with either a DataId or a CircleId and pagination information. The pagination include the page size which must be at least 1 and maximum 100. The page number starts with 1 for the first page, and any positive number. If the number exceeds the number of records, it will simply result in an empty list of Objects being returned.

For more details, please see the 'fetchData' request in the Share interface: Share.fetchData(FetchDataRequest)

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FetchDataRequest()

Method Summary

Modifier and Type	Method and Description
String	getCircleId()
String	getDataId()
int	getPageNumber()
Integer	getPageSize()
void	setCircleId(String circleId)
void	setDataId(String dataId)
void	setPageNumber(int pageNumber)
void	setPageSize(Integer pageSize)
Map<String,String>	validate() Simple Validation method, which checks if the required values are usable or not.

Methods inherited from class io.javadog.cws.api.requests.Authentication

getAccountName, getCredential, getCredentialType, setAccountName, setCredential, setCredentialType

Methods inherited from class io.javadog.cws.api.requests.Verifiable

checkIntegerWithMax, checkNotNull, checkNotNullAndValidId, checkNotNullEmptyOrTooLong, checkNotNullOrEmpty, checkNotNullOrEmpty, checkNotTooLong, checkUrl, checkValidId, isEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchDataRequest

public FetchDataRequest()

Method Detail

setCircleId

public void setCircleId(String circleId)

Specified by:

setCircleId in interface CircleIdRequest

getCircleId

public String getCircleId()

Specified by:

getCircleId in interface CircleIdRequest

setDataId

public void setDataId(String dataId)

getDataId

public String getDataId()

setPageNumber

public void setPageNumber(int pageNumber)

getPageNumber

public int getPageNumber()

setPageSize

public void setPageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

validate

public Map<String,String> validate()

Simple Validation method, which checks if the required values are usable or not.

Overrides:

validate in class Authentication

Returns:

Map with Fields and error information