com.thomsonreuters.upa.valueadd.domainrep.rdm.directory

Class Service.ServiceState

java.lang.Object

com.thomsonreuters.upa.valueadd.domainrep.rdm.directory.Service.ServiceState

Enclosing interface:

Service

public static class Service.ServiceState
extends java.lang.Object

The RDM Service State. Contains information provided by the Source Directory State filter.

See Also:

Service.ServiceStateFlags, ServiceImpl

Constructor Summary

Constructors

Constructor and Description
ServiceState() Instantiates a new service state.

Method Summary

Modifier and Type	Method and Description
long	acceptingRequests() Returns acceptingRequests - Flag indicating whether the service is accepting item requests.
void	acceptingRequests(long acceptingRequests) Sets acceptingRequests - Flag indicating whether the service is accepting item requests.
int	action() Returns action - Action associated with this Service Info.
void	action(int action) Sets action - Action associated with this Service Info.
void	applyHasAcceptingRequests() Applies acceptingRequests presence flag.
void	applyHasStatus() Applies status presence flag.
boolean	checkHasAcceptingRequests() Indicates presence of the acceptingRequests field.
boolean	checkHasStatus() Indicates presence of the status field.
void	clear() Clears a ServiceState.
int	copy(Service.ServiceState destServiceState) Performs a deep copy of Service.ServiceState object.
int	decode(com.thomsonreuters.upa.codec.DecodeIterator dIter) Decode a UPA service status filter into an RDM service status filter.
int	encode(com.thomsonreuters.upa.codec.EncodeIterator encIter) Encode an RDM Service State filter.
int	filterId() Returns filterId - Populated by Directory.ServiceFilterIds.
int	flags() Returns service state flags.
void	flags(int flags) Sets service state flags.
long	serviceState() Returns current state of the service.
void	serviceState(long serviceState) Sets current state of the service.
com.thomsonreuters.upa.codec.State	status() Returns status to be applied to all items being provided by this service.
void	status(com.thomsonreuters.upa.codec.State status) Sets status to be applied to all items being provided by this service.
java.lang.String	toString()
int	update(Service.ServiceState destServiceState) Performs an update of Service.ServiceState object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceState

public ServiceState()

Instantiates a new service state.

Method Detail

clear

public void clear()

Clears a ServiceState.

flags

public int flags()

Returns service state flags. It is populated by Service.ServiceStateFlags.

Returns:

flags.

flags

public void flags(int flags)

Sets service state flags. Populate with Service.ServiceStateFlags.

Parameters:

flags - the flags

copy

public int copy(Service.ServiceState destServiceState)

Performs a deep copy of Service.ServiceState object.

Parameters:

destServiceState - ServiceState object to copy this object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

update

public int update(Service.ServiceState destServiceState)

Performs an update of Service.ServiceState object.

Parameters:

destServiceState - ServiceState object to update with information from this object. It cannot be null.

Returns:

UPA return value indicating success or failure of update operation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

action

public int action()

Returns action - Action associated with this Service Info.

Returns:

action

action

public void action(int action)

Sets action - Action associated with this Service Info.

Parameters:

action - the action

serviceState

public long serviceState()

Returns current state of the service.

Returns:

service state.

serviceState

public void serviceState(long serviceState)

Sets current state of the service.

Parameters:

serviceState - the service state

acceptingRequests

public long acceptingRequests()

Returns acceptingRequests - Flag indicating whether the service is accepting item requests.

Returns:

acceptingRequests

acceptingRequests

public void acceptingRequests(long acceptingRequests)

Sets acceptingRequests - Flag indicating whether the service is accepting item requests.

Parameters:

acceptingRequests - the accepting requests

checkHasAcceptingRequests

public boolean checkHasAcceptingRequests()

Indicates presence of the acceptingRequests field. Flags may also be bulk-get via flags().

Returns:

true - if acceptingRequests present, false - if not.

applyHasAcceptingRequests

public void applyHasAcceptingRequests()

Applies acceptingRequests presence flag. Flags may also be bulk-set via flags(int).

status

public com.thomsonreuters.upa.codec.State status()

Returns status to be applied to all items being provided by this service.

Returns:

status

status

public void status(com.thomsonreuters.upa.codec.State status)

Sets status to be applied to all items being provided by this service.

Parameters:

status - the status

checkHasStatus

public boolean checkHasStatus()

Indicates presence of the status field. Flags may also be bulk-get via flags().

Returns:

true - if status present, false - if not.

applyHasStatus

public void applyHasStatus()

Applies status presence flag. Flags may also be bulk-set via flags(int).

filterId

public int filterId()

Returns filterId - Populated by Directory.ServiceFilterIds.

Returns:

filterId

encode

public int encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)

Encode an RDM Service State filter.

Parameters:

encIter - The Encode Iterator

Returns:

UPA return value

decode

public int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)

Decode a UPA service status filter into an RDM service status filter.

Parameters:

dIter - The Decode Iterator

Returns:

UPA return value