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

Interface ConsumerStatusService

public interface ConsumerStatusService

Information about how a Consumer is using a particular service with regard to Source Mirroring.

See Also:

DirectoryConsumerStatus

Method Summary

Modifier and Type	Method and Description
int	action() action - Action associated with this status.
void	action(int action) action - Action associated with this status.
void	clear() Clears a ConsumerStatusService.
int	copy(ConsumerStatusService destConsumerStatusService) Performs a deep copy of ConsumerStatusService object.
int	decode(com.thomsonreuters.upa.codec.DecodeIterator dIter, com.thomsonreuters.upa.codec.Msg msg) Decode a UPA message into an RDM message.
int	encode(com.thomsonreuters.upa.codec.EncodeIterator encodeIter) Encode an RDM consumer status service object in to the encode iterator.
long	serviceId() serviceId - ID of the service this status concerns.
void	serviceId(long serviceId) serviceId - ID of the service this status concerns.
long	sourceMirroringMode() sourceMirroringMode - The Source Mirroring Mode for this service.
void	sourceMirroringMode(long sourceMirroringMode) sourceMirroringMode - The Source Mirroring Mode for this service.

Method Detail

clear

void clear()

Clears a ConsumerStatusService.

See Also:

ConsumerStatusService

copy

int copy(ConsumerStatusService destConsumerStatusService)

Performs a deep copy of ConsumerStatusService object.

Parameters:

destConsumerStatusService - Message to copy consumer status service object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

decode

int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter,
           com.thomsonreuters.upa.codec.Msg msg)

Decode a UPA message into an RDM message.

Parameters:

dIter - The Decode Iterator

msg - the msg

Returns:

UPA return value

encode

int encode(com.thomsonreuters.upa.codec.EncodeIterator encodeIter)

Encode an RDM consumer status service object in to the encode iterator.

Parameters:

encodeIter - The Encode Iterator

Returns:

UPA return value

serviceId

long serviceId()

serviceId - ID of the service this status concerns.

Returns:

serviceId

serviceId

void serviceId(long serviceId)

serviceId - ID of the service this status concerns.

Parameters:

serviceId - the service id

action

int action()

action - Action associated with this status.

Returns:

action

action

void action(int action)

action - Action associated with this status.

Parameters:

action - the action

sourceMirroringMode

long sourceMirroringMode()

sourceMirroringMode - The Source Mirroring Mode for this service. Populated by Directory.SourceMirroringMode.

Returns:

Source Mirroring Mode.

sourceMirroringMode

void sourceMirroringMode(long sourceMirroringMode)

sourceMirroringMode - The Source Mirroring Mode for this service. Populated by Directory.SourceMirroringMode.

Parameters:

sourceMirroringMode - the source mirroring mode