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

Interface DirectoryStatus

All Superinterfaces:

DirectoryMsg, MsgBase

public interface DirectoryStatus
extends DirectoryMsg

The RDM Directory Status. Used by an OMM Provider to indicate changes to the Directory stream.

See Also:

DirectoryMsg

Method Summary

Modifier and Type	Method and Description
void	applyClearCache() Applies clear cache flag.
void	applyHasFilter() Applies the presence of the filter field.
void	applyHasServiceId() Applies the service id flag.
void	applyHasState() Applies state presence flag.
boolean	checkClearCache() Checks the presence of clear cache flag.
boolean	checkHasFilter() Checks the presence of the filter field.
boolean	checkHasServiceId() Checks the presence of service id field.
boolean	checkHasState() Checks the presence of state field.
int	copy(DirectoryStatus destStatusMsg) Performs a deep copy of DirectoryStatus 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 Status flags.
int	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).
com.thomsonreuters.upa.codec.State	state() Returns current state of the stream.
void	state(com.thomsonreuters.upa.codec.State state) Sets state for the directory status 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 Status flags.

Parameters:

flags - the flags

See Also:

DirectoryStatusFlags

flags

int flags()

The RDM Directory Update flags.

Returns:

flags.

See Also:

DirectoryStatusFlags

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

applyHasFilter

void applyHasFilter()

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

See Also:

flags()

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)

serviceId

int 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:

service id.

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

applyHasServiceId

void applyHasServiceId()

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

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.

state

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

Returns current state of the stream.

Returns:

state

state

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

Sets state for the directory status message.

Parameters:

state - the state

applyHasState

void applyHasState()

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

checkHasState

boolean checkHasState()

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

Returns:

true - if exists; false if does not exist.

copy

int copy(DirectoryStatus destStatusMsg)

Performs a deep copy of DirectoryStatus object.

Parameters:

destStatusMsg - Message to copy directory status object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

checkClearCache

boolean checkClearCache()

Checks the presence of clear cache flag. This flag can also be bulk-get by flags()

Returns:

true - if exists; false if does not exist.

applyClearCache

void applyClearCache()

Applies clear cache flag. This flag can also be bulk-set by flags(int)