universum.studios.android.officium.service

Class BaseServiceObject

java.lang.Object

universum.studios.android.officium.service.BaseServiceObject

All Implemented Interfaces:

ServiceObject

Direct Known Subclasses:

ServiceCallback, ServiceError, ServiceResponse

public abstract class BaseServiceObject
extends Object
implements ServiceObject

Base implementation of ServiceObject for objects associated to services.

Author:

Martin Albedinsky

Field Summary

Fields inherited from interface universum.studios.android.officium.service.ServiceObject

NO_REQUEST, NO_SERVICE

Constructor Summary

Constructors

Constructor and Description
BaseServiceObject()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseServiceObject

public BaseServiceObject()

Method Detail

setServiceId

public final void setServiceId(int serviceId)

Description copied from interface: ServiceObject

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.

Specified by:

setServiceId in interface ServiceObject

Parameters:

serviceId - The desired service id.

Throws:

UnsupportedOperationException - If service id has been already specified for this service object.

See Also:

ServiceObject.getServiceId()

getServiceId

public final int getServiceId()

Description copied from interface: ServiceObject

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

Specified by:

getServiceId in interface ServiceObject

Returns:

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

See Also:

ServiceObject.setServiceId(int)

setRequestId

public final void setRequestId(String requestId)

Description copied from interface: ServiceObject

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.

Specified by:

setRequestId in interface ServiceObject

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.

Throws:

UnsupportedOperationException - If request id has been already specified for this service object.

See Also:

ServiceObject.getRequestId()

getRequestId

public final String getRequestId()

Description copied from interface: ServiceObject

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

Specified by:

getRequestId in interface ServiceObject

Returns:

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

See Also:

ServiceObject.setRequestId(String)