org.gecko.emf.utilities

Interface Response

All Known Implementing Classes:

ResponseImpl

public interface Response

A representation of the model object 'Response'. Response wrapper object. Usually used in combination with the request object

The following features are supported:

• Timestamp
• Result Size
• Response Code
• Response Message
• Data

See Also:

UtilPackage.getResponse()

Method Summary

Modifier and Type	Method and Description
<any>	getData() Returns the value of the 'Data' containment reference list.
java.lang.String	getResponseCode() Returns the value of the 'Response Code' attribute.
java.lang.String	getResponseMessage() Returns the value of the 'Response Message' attribute.
int	getResultSize() Returns the value of the 'Result Size' attribute.
java.util.Date	getTimestamp() Returns the value of the 'Timestamp' attribute.
void	setResponseCode(java.lang.String value) Sets the value of the 'Response Code' attribute.
void	setResponseMessage(java.lang.String value) Sets the value of the 'Response Message' attribute.
void	setResultSize(int value) Sets the value of the 'Result Size' attribute.
void	setTimestamp(java.util.Date value) Sets the value of the 'Timestamp' attribute.

Method Detail

getTimestamp

java.util.Date getTimestamp()

Returns the value of the 'Timestamp' attribute. Response timestamp

Returns:

the value of the 'Timestamp' attribute.

See Also:

setTimestamp(Date), UtilPackage.getResponse_Timestamp()

setTimestamp

void setTimestamp(java.util.Date value)

Sets the value of the 'Timestamp' attribute.

Parameters:

value - the new value of the 'Timestamp' attribute.

See Also:

getTimestamp()

getResultSize

int getResultSize()

Returns the value of the 'Result Size' attribute. Returns the whole query return size, if 'returnResultSize' was set to true in the request

Returns:

the value of the 'Result Size' attribute.

See Also:

setResultSize(int), UtilPackage.getResponse_ResultSize()

setResultSize

void setResultSize(int value)

Sets the value of the 'Result Size' attribute.

Parameters:

value - the new value of the 'Result Size' attribute.

See Also:

getResultSize()

getResponseCode

java.lang.String getResponseCode()

Returns the value of the 'Response Code' attribute. Can be used to return a response code, when working outside protocols like HTTP

Returns:

the value of the 'Response Code' attribute.

See Also:

setResponseCode(String), UtilPackage.getResponse_ResponseCode()

setResponseCode

void setResponseCode(java.lang.String value)

Sets the value of the 'Response Code' attribute.

Parameters:

value - the new value of the 'Response Code' attribute.

See Also:

getResponseCode()

getResponseMessage

java.lang.String getResponseMessage()

Returns the value of the 'Response Message' attribute. Can be used for an error text

Returns:

the value of the 'Response Message' attribute.

See Also:

setResponseMessage(String), UtilPackage.getResponse_ResponseMessage()

setResponseMessage

void setResponseMessage(java.lang.String value)

Sets the value of the 'Response Message' attribute.

Parameters:

value - the new value of the 'Response Message' attribute.

See Also:

getResponseMessage()

getData

<any> getData()

Returns the value of the 'Data' containment reference list. The list contents are of type org.eclipse.emf.ecore.EObject. General purpose data, dpending on the request

Returns:

the value of the 'Data' containment reference list.

See Also:

UtilPackage.getResponse_Data()