universum.studios.android.officium.service

Interface ServiceObject

All Known Implementing Classes:

BaseServiceObject, ErrorResponse, ServiceCallback, ServiceError, ServiceResponse

public interface ServiceObject

Interface for objects that may be associated with services and theirs requests. A service to which is a specific service object associated may be identified by getServiceId().

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_REQUEST Constant used to identify that a specific ServiceObject is not associated with any particular service request.
static int	NO_SERVICE Constant used to identify that a specific ServiceObject is not associated with any service.

Method Summary

Modifier and Type	Method and Description
String	getRequestId() Returns the unique id of the request with which is this service object associated.
int	getServiceId() Returns the id of service with which is this service object associated.
void	setRequestId(String requestId) Sets an id of the request with which is this service object associated.
void	setServiceId(int serviceId) Specifies an id of the service with which is this service object associated.

Field Detail

NO_SERVICE

static final int NO_SERVICE

Constant used to identify that a specific ServiceObject is not associated with any service.

See Also:

Constant Field Values

NO_REQUEST

static final String NO_REQUEST

Constant used to identify that a specific ServiceObject is not associated with any particular service request.

See Also:

Constant Field Values

Method Detail

setServiceId

void setServiceId(int serviceId)

Specifies an id of the service with which is this service object associated.

Note, that changing of this id should not be permitted if it has been already specified, so service object implementations are allowed to throw an exception if such action is to be performed.

Parameters:

serviceId - The desired service id.

See Also:

getServiceId()

getServiceId

int getServiceId()

Returns the id of service with which is this service object associated.

Returns:

Service id specified for this object or NO_SERVICE if there was no service id provided.

See Also:

setServiceId(int)

setRequestId

void setRequestId(String requestId)

Sets an id of the request with which is this service object associated.

Note, that changing of this id should not be permitted if it has been already specified, so service object implementations are allowed to throw an exception if such action is to be performed.

Parameters:

requestId - The desired request id. Should be unique among all requests made for a specific service or better, unique among all requests made through services API to really uniquely identify a desired request.

See Also:

getRequestId()

getRequestId

String getRequestId()

Returns the unique id of the request with which is this service object associated.

Returns:

Request id specified for this object or NO_REQUEST if there was no request id provided.

See Also:

setRequestId(String)