com.thomsonreuters.upa.valueadd.domainrep.rdm.dictionary

Interface DictionaryStatus

All Superinterfaces:

DictionaryMsg, MsgBase

public interface DictionaryStatus
extends DictionaryMsg

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

See Also:

DictionaryMsg

Method Summary

Modifier and Type	Method and Description
void	applyClearCache() Applies clear cache flag.
void	applyHasState() Applies state presence flag.
boolean	checkClearCache() Checks the presence of clear cache flag.
boolean	checkHasState() Checks the presence of state field.
int	copy(DictionaryStatus destStatusMsg) Performs a deep copy of DictionaryStatus object.
int	flags() The RDM Dictionary status flags.
void	flags(int flags) The RDM Dictionary status flags.
com.thomsonreuters.upa.codec.State	state() state - The current state of the stream.
void	state(com.thomsonreuters.upa.codec.State state) Sets the state field for the dictionary status message.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.dictionary.DictionaryMsg

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 Dictionary status flags. Populated by DictionaryStatusFlags.

Parameters:

flags - the flags

flags

int flags()

The RDM Dictionary status flags. Populated by DictionaryStatusFlags.

Returns:

flags - RDM Dictionary status flags

checkHasState

boolean checkHasState()

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

Returns:

true - if state field is present, false - if not.

applyHasState

void applyHasState()

Applies state presence flag. This flag can also be bulk-set by flags(int)

state

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

state - The current state of the stream.

Returns:

state

state

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

Sets the state field for the dictionary status message.

Parameters:

state - the state

copy

int copy(DictionaryStatus destStatusMsg)

Performs a deep copy of DictionaryStatus object.

Parameters:

destStatusMsg - Message to copy dictionary 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)