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

Interface DirectoryUpdate

All Superinterfaces:

DirectoryMsg, MsgBase

public interface DirectoryUpdate
extends DirectoryMsg

The RDM Directory Update. Used by an OMM Provider to provide updates about available services.

See Also:

DirectoryMsg, ServiceImpl

Method Summary

Modifier and Type	Method and Description
void	applyHasFilter() Applies the presence of the filter field.
void	applyHasSequenceNumber() Applies the sequence number flag.
void	applyHasServiceId() Applies the service id flag.
boolean	checkHasFilter() Checks the presence of the filter field.
boolean	checkHasSequenceNumber() Checks the presence of sequence number field.
boolean	checkHasServiceId() Checks the presence of service id field.
int	copy(DirectoryUpdate destUpdateMsg) Performs a deep copy of DirectoryUpdate object.
long	filter() Filter indicating which filters may appear on this stream.
void	filter(long filter) Filter indicating which filters may appear on this stream.
int	flags() The RDM Directory Update flags.
void	flags(int flags) The RDM Directory Update flags.
long	sequenceNumber() sequenceNumber- Sequence number of this message.
void	sequenceNumber(long sequenceNumber) sequenceNumber - Sequence number of this message.
int	serviceId() serviceId - The ID of the service whose information is provided by this stream(if not present, all services should be provided).
void	serviceId(int serviceId) serviceId - The ID of the service whose information is provided by this stream(if not present, all services should be provided).
java.util.List<Service>	serviceList() List of service entries.
void	serviceList(java.util.List<Service> serviceList) Sets service entries into the directory refresh message.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.directory.DirectoryMsg

rdmMsgType, rdmMsgType

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.MsgBase

clear, decode, domainType, encode, streamId, streamId

Method Detail

flags

void flags(int flags)

The RDM Directory Update flags.

Parameters:

flags - the flags

See Also:

DirectoryUpdateFlags

flags

int flags()

The RDM Directory Update flags.

Returns:

flags.

See Also:

DirectoryUpdateFlags

copy

int copy(DirectoryUpdate destUpdateMsg)

Performs a deep copy of DirectoryUpdate object.

Parameters:

destUpdateMsg - Message to copy directory update object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

serviceList

java.util.List<Service> serviceList()

List of service entries.

Returns:

service list

serviceList

void serviceList(java.util.List<Service> serviceList)

Sets service entries into the directory refresh message. This object's Service elements will be set to Service elements from list in the parameter passed in.

Parameters:

serviceList - -list of service entries.

filter

long filter()

Filter indicating which filters may appear on this stream. Where possible, this should match the consumer's request. Populated by Directory.ServiceFilterFlags.

Returns:

filter

filter

void filter(long filter)

Filter indicating which filters may appear on this stream. Where possible, this should match the consumer's request. Populated by Directory.ServiceFilterFlags.

Parameters:

filter - the filter

checkHasFilter

boolean checkHasFilter()

Checks the presence of the filter field. Flags may also be bulk-set via flags(int).

Returns:

true - if filter field exists, false - if not.

See Also:

flags(int)

applyHasFilter

void applyHasFilter()

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

See Also:

flags()

sequenceNumber

long sequenceNumber()

sequenceNumber- Sequence number of this message.

Returns:

sequenceNumber

sequenceNumber

void sequenceNumber(long sequenceNumber)

sequenceNumber - Sequence number of this message.

Parameters:

sequenceNumber - the sequence number

checkHasSequenceNumber

boolean checkHasSequenceNumber()

Checks the presence of sequence number field. Flags may also be bulk-get via flags().

Returns:

true - if exists; false if does not exist.

applyHasSequenceNumber

void applyHasSequenceNumber()

Applies the sequence number flag. Flags may also be bulk-set via flags(int).

serviceId

int serviceId()

serviceId - The ID of the service whose information is provided by this stream(if not present, all services should be provided). Should match the Consumer's request if possible.

Returns:

serviceId

serviceId

void serviceId(int serviceId)

serviceId - The ID of the service whose information is provided by this stream(if not present, all services should be provided). Should match the Consumer's request if possible.

Parameters:

serviceId - the service id

checkHasServiceId

boolean checkHasServiceId()

Checks the presence of service id field. Flags may also be bulk-get via flags().

Returns:

true - if exists; false if does not exist.

applyHasServiceId

void applyHasServiceId()

Applies the service id flag. Flags may also be bulk-set via flags(int).