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

Interface DirectoryRefresh

All Superinterfaces:

DirectoryMsg, MsgBase

public interface DirectoryRefresh
extends DirectoryMsg

The RDM Directory Refresh. Used by an OMM Provider to provide information about available services.

See Also:

DirectoryMsg, ServiceImpl

Method Summary

Modifier and Type	Method and Description
void	applyClearCache() Applies clear cache flag.
void	applyHasSequenceNumber() Applies the sequence number flag.
void	applyHasServiceId() Applies the service id flag.
void	applySolicited() Applies solicited flag.
boolean	checkClearCache() Checks the presence of clear cache flag.
boolean	checkHasSequenceNumber() Checks the presence of sequence number field.
boolean	checkHasServiceId() Checks the presence of service id field.
boolean	checkSolicited() Checks the presence of solicited flag.
int	copy(DirectoryRefresh destRefreshMsg) Performs a deep copy of DirectoryRefresh 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 refresh flags.
void	flags(int flags) The RDM Directory refresh 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 to the directory refresh message.
com.thomsonreuters.upa.codec.State	state() Returns the current state of the stream.
void	state(com.thomsonreuters.upa.codec.State state) Sets state for 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 refresh flags. Populated by DirectoryRefreshFlags.

Parameters:

flags - the flags

flags

int flags()

The RDM Directory refresh flags. Populated by DirectoryRefreshFlags.

Returns:

flags

copy

int copy(DirectoryRefresh destRefreshMsg)

Performs a deep copy of DirectoryRefresh object.

Parameters:

destRefreshMsg - Message to copy directory refresh 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 to 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

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).

See Also:

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).

checkClearCache

boolean checkClearCache()

Checks the presence of clear cache flag. Flags may also be bulk-get via flags().

Returns:

true - if exists; false if does not exist.

applyClearCache

void applyClearCache()

Applies clear cache flag. Flags may also be bulk-set via flags(int).

checkSolicited

boolean checkSolicited()

Checks the presence of solicited flag.

Returns:

true - if solicited flag is set, false if not.

applySolicited

void applySolicited()

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

state

com.thomsonreuters.upa.codec.State state()

Returns the current state of the stream.

Returns:

state.

state

void state(com.thomsonreuters.upa.codec.State state)

Sets state for the directory refresh message.

Parameters:

state - the state