io.javadog.cws.api.responses

Class FetchDataResponse

java.lang.Object

io.javadog.cws.api.responses.CwsResponse

io.javadog.cws.api.responses.FetchDataResponse

All Implemented Interfaces:

Serializable

public final class FetchDataResponse
extends CwsResponse

If the request was made generally, i.e. without a Data Id, then a list of Metadata Objects is being returned. The list is limited to the number which was requested - and the records field will then contain the total amount of entries which was found, so it is possible to perform the lookup with pagination information.

If the request was made for a specific Data Id, and the Object exists in the database, then the list of Metadata will return a single entry, and the data field will be set with the unencrypted data.

Please see CwsResponse for information about the result of the processing.

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FetchDataResponse() Empty Constructor, to use if the setters are invoked.
FetchDataResponse(ReturnCode returnCode, String returnMessage) Error Constructor, used if an error occurred, and the request could not complete successfully.

Method Summary

Modifier and Type	Method and Description
byte[]	getData()
List<Metadata>	getMetadata()
long	getRecords()
void	setData(byte[] data)
void	setMetadata(List<Metadata> metadata)
void	setRecords(long records)

Methods inherited from class io.javadog.cws.api.responses.CwsResponse

getReturnCode, getReturnMessage, isOk, setReturnCode, setReturnMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchDataResponse

public FetchDataResponse()

Empty Constructor, to use if the setters are invoked. This is required for WebServices to work properly.

FetchDataResponse

public FetchDataResponse(ReturnCode returnCode,
                         String returnMessage)

Error Constructor, used if an error occurred, and the request could not complete successfully.

Parameters:

returnCode - The CWS Return Code

returnMessage - The CWS Return Message

Method Detail

setMetadata

public void setMetadata(List<Metadata> metadata)

getMetadata

public List<Metadata> getMetadata()

setRecords

public void setRecords(long records)

getRecords

public long getRecords()

setData

public void setData(byte[] data)

getData

public byte[] getData()