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

Interface DictionaryRequest

All Superinterfaces:

DictionaryMsg, MsgBase

public interface DictionaryRequest
extends DictionaryMsg

The RDM Dictionary Request. Used by an OMM Consumer to request a dictionary from a services that provides it.

See Also:

MsgBase, DictionaryMsg

Method Summary

Modifier and Type	Method and Description
void	applyStreaming() Makes this request streaming request.
boolean	checkStreaming() Checks if this request is streaming or not.
int	copy(DictionaryRequest destRequestMsg) Performs a deep copy of DictionaryRequest object.
com.thomsonreuters.upa.codec.Buffer	dictionaryName() dictionaryName - The name of the dictionary being requested.
void	dictionaryName(com.thomsonreuters.upa.codec.Buffer dictionaryName) Sets the the dictionaryName field for this message to the user specified buffer.
int	flags() The RDM Dictionary request flags.
void	flags(int flags) The RDM Dictionary request flags.
int	serviceId() serviceId - The ID of the service to request the dictionary from.
void	serviceId(int serviceId) serviceId - The ID of the service to request the dictionary from.
int	verbosity() verbosity - The verbosity of information desired.
void	verbosity(int verbosity) verbosity - The verbosity of information desired.

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

copy

int copy(DictionaryRequest destRequestMsg)

Performs a deep copy of DictionaryRequest object.

Parameters:

destRequestMsg - Message to copy dictionary request object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

dictionaryName

com.thomsonreuters.upa.codec.Buffer dictionaryName()

dictionaryName - The name of the dictionary being requested.

Returns:

- dictionaryName

dictionaryName

void dictionaryName(com.thomsonreuters.upa.codec.Buffer dictionaryName)

Sets the the dictionaryName field for this message to the user specified buffer. Buffer used by this object's dictionaryName field will be set to passed in buffer's data and position. Note that this creates garbage if buffer is backed by String object.

Parameters:

dictionaryName - the dictionary name

verbosity

int verbosity()

verbosity - The verbosity of information desired. Populated by Dictionary.VerbosityValues.

Returns:

verbosity

verbosity

void verbosity(int verbosity)

verbosity - The verbosity of information desired. Populated by Dictionary.VerbosityValues.

Parameters:

verbosity - the verbosity

serviceId

int serviceId()

serviceId - The ID of the service to request the dictionary from.

Returns:

serviceId

serviceId

void serviceId(int serviceId)

serviceId - The ID of the service to request the dictionary from.

Parameters:

serviceId - the service id

flags

int flags()

The RDM Dictionary request flags. Populated by DictionaryRequestFlags.

Returns:

RDM Dictionary request flag

flags

void flags(int flags)

The RDM Dictionary request flags. Populated by DictionaryRequestFlags.

Parameters:

flags - the flags

checkStreaming

boolean checkStreaming()

Checks if this request is streaming or not. This flag can also be bulk-get by flags()

Returns:

true - if request is streaming, false - if not.

applyStreaming

void applyStreaming()

Makes this request streaming request. This flag can also be bulk-set by flags(int)