DictionaryRefresh (ETA ValueAdd)

All Superinterfaces:

DictionaryMsg, MsgBase
```
public interface DictionaryRefresh
extends DictionaryMsg
```
The RDM Dictionary Refresh. Used by an OMM Provider to provide the content of a Dictionary.

See Also:

DictionaryMsg, DictionaryRefreshFlags

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`applyClearCache()` Applies clear cache flag.
`void`	`applyHasInfo()` Applies the flag for presence of the dictionaryId, version, and type members. This flag is typically not used as this information is automatically added by the encode method when appropriate.
`void`	`applyHasSequenceNumber()` Applies the sequence number flag.
`void`	`applyRefreshComplete()` Applies refresh complete flag.
`void`	`applySolicited()` Applies solicited flag.
`boolean`	`checkClearCache()` Checks the presence of clear cache flag.
`boolean`	`checkHasInfo()` Checks presence of the dictionaryId, version, and type fields .
`boolean`	`checkHasSequenceNumber()` Checks the presence of sequence number field.
`boolean`	`checkRefreshComplete()` Checks the presence of refresh complete flag.
`boolean`	`checkSolicited()` Checks the presence of solicited flag.
`int`	`copy(DictionaryRefresh destRefreshMsg)` Performs a deep copy of `DictionaryRefresh` object.
`com.thomsonreuters.upa.codec.Buffer`	`dataBody()` When decoding, points to the payload of the message.
`com.thomsonreuters.upa.codec.DataDictionary`	`dictionary()` When encoding the message, this points to the dictionary object that is being encoded.
`void`	`dictionary(com.thomsonreuters.upa.codec.DataDictionary encDictionary)` encDictionary - When encoding the message, this points to the dictionary object that is being encoded.
`com.thomsonreuters.upa.codec.Buffer`	`dictionaryName()` dictionaryName - The name of the dictionary being provided.
`void`	`dictionaryName(com.thomsonreuters.upa.codec.Buffer dictionaryName)` Sets the the dictionaryName field for this message to the user specified buffer.
`int`	`dictionaryType()` The type of the dictionary.
`void`	`dictionaryType(int dictionaryType)` The type of the dictionary.
`int`	`flags()` The RDM Dictionary refresh flags.
`void`	`flags(int flags)` The RDM Dictionary refresh flags.
`long`	`sequenceNumber()` The sequence number of this message.
`void`	`sequenceNumber(long sequenceNumber)` sequenceNumber - The sequence number of this message.
`int`	`serviceId()` serviceId - The ID of the service providing the dictionary.
`void`	`serviceId(int serviceId)` serviceId - The ID of the service providing the dictionary.
`int`	`startEnumTableCount()` This field is initialized with 0 and after encoding each part, updated with the start Enum Table Count for next encoded part.
`void`	`startEnumTableCount(int startEnumTableCount)` This field is initialized with 0 and after encoding each part, updated with the start Enum Table Count for next encoded part.
`int`	`startFid()` This field is initialized with dictionary->minFid and after encoding each part, updated with the start Fid for next encoded part.
`void`	`startFid(int startFid)` This field is initialized with dictionary->minFid and after encoding each part, updated with the start Fid for next encoded part.
`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 refresh message.
`int`	`verbosity()` The verbosity of the dictionary being provided.
`void`	`verbosity(int verbosity)` The verbosity of the dictionary being provided.

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(DictionaryRefresh destRefreshMsg)
```
    Performs a deep copy of DictionaryRefresh object.
    
    Parameters:
    
    destRefreshMsg - Message to copy dictionary refresh object into. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of copy operation.
  - flags
```
int flags()
```
    The RDM Dictionary refresh flags. Populated by DictionaryRefreshFlags.
    
    Returns:
    
    RDM Dictionary refresh flag
  - flags
```
void flags(int flags)
```
    The RDM Dictionary refresh flags. Populated by DictionaryRefreshFlags.
    
    Parameters:
    
    flags - - RDM Dictionary refresh flags
  - verbosity
```
int verbosity()
```
    The verbosity of the dictionary being provided. Populated by DictionaryVerbosityValues.
    
    Returns:
    
    verbosity of the dictionary
    
    See Also:
    
    Dictionary.VerbosityValues
  - verbosity
```
void verbosity(int verbosity)
```
    The verbosity of the dictionary being provided. Populated by DictionaryVerbosityValues.
    
    Parameters:
    
    verbosity - - verbosity of the dictionary
    
    See Also:
    
    Dictionary.VerbosityValues
  - checkHasInfo
```
boolean checkHasInfo()
```
    Checks presence of the dictionaryId, version, and type fields . Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if exists; false if does not exist.
    
    See Also:
    
    flags()
  - applyHasInfo
```
void applyHasInfo()
```
    Applies the flag for presence of the dictionaryId, version, and type members.
    This flag is typically not used as this information is automatically added by the encode method when appropriate. Flags may also be bulk-set via flags(int).
    
    See Also:
    
    flags(int)
  - dictionary
```
com.thomsonreuters.upa.codec.DataDictionary dictionary()
```
    When encoding the message, this points to the dictionary object that is being encoded. When decoding, this is not used.
    
    Returns:
    
    DataDictionary
  - dictionary
```
void dictionary(com.thomsonreuters.upa.codec.DataDictionary encDictionary)
```
    encDictionary - When encoding the message, this points to the dictionary object that is being encoded. When decoding, this is not used.
    
    Parameters:
    
    encDictionary - the enc dictionary
  - dictionaryName
```
com.thomsonreuters.upa.codec.Buffer dictionaryName()
```
    dictionaryName - The name of the dictionary being provided.
    
    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
  - sequenceNumber
```
long sequenceNumber()
```
    The sequence number of this message.
    
    Returns:
    
    sequenceNumber
  - sequenceNumber
```
void sequenceNumber(long sequenceNumber)
```
    sequenceNumber - The 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 providing the dictionary.
    
    Returns:
    
    serviceId
  - serviceId
```
void serviceId(int serviceId)
```
    serviceId - The ID of the service providing the dictionary.
    
    Parameters:
    
    serviceId - the service id
  - 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 refresh message.
    
    Parameters:
    
    state - the state
  - dictionaryType
```
int dictionaryType()
```
    The type of the dictionary. Populated by Dictionary.Types.
    
    Returns:
    
    dictionaryType
  - dictionaryType
```
void dictionaryType(int dictionaryType)
```
    The type of the dictionary. Populated by Dictionary.Types.
    
    Parameters:
    
    dictionaryType - the dictionary type
  - dataBody
```
com.thomsonreuters.upa.codec.Buffer dataBody()
```
    When decoding, points to the payload of the message. The application should set the iterator to this buffer and call the appropriate decode method. This will add the data present to the DataDictionary object. When encoding, this member is not used.
    
    Returns:
    
    - payload buffer.
  - startFid
```
void startFid(int startFid)
```
    This field is initialized with dictionary->minFid and after encoding each part, updated with the start Fid for next encoded part. When decoding, this is not used.
    
    Parameters:
    
    startFid - the start fid
  - startEnumTableCount
```
void startEnumTableCount(int startEnumTableCount)
```
    This field is initialized with 0 and after encoding each part, updated with the start Enum Table Count for next encoded part. When decoding, this is not used.
    
    Parameters:
    
    startEnumTableCount - the start enum table count
  - startFid
```
int startFid()
```
    This field is initialized with dictionary->minFid and after encoding each part, updated with the start Fid for next encoded part. When decoding, this is not used.
    
    Returns:
    
    startFid
  - startEnumTableCount
```
int startEnumTableCount()
```
    This field is initialized with 0 and after encoding each part, updated with the start Enum Table Count for next encoded part. When decoding, this is not used.
    
    Returns:
    
    startEnumTableCount
  - 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).
  - checkRefreshComplete
```
boolean checkRefreshComplete()
```
    Checks the presence of refresh complete flag. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if exists; false if does not exist.
  - checkSolicited
```
boolean checkSolicited()
```
    Checks the presence of solicited flag. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if exists; false if does not exist.
  - applySolicited
```
void applySolicited()
```
    Applies solicited flag. Flags may also be bulk-set via flags(int).
  - applyRefreshComplete
```
void applyRefreshComplete()
```
    Applies refresh complete flag. Flags may also be bulk-set via flags(int).

Interface DictionaryRefresh

Method Summary

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

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

Method Detail

copy

flags

flags

verbosity

verbosity

checkHasInfo

applyHasInfo

dictionary

dictionary

dictionaryName

dictionaryName

sequenceNumber

sequenceNumber

checkHasSequenceNumber

applyHasSequenceNumber

serviceId

serviceId

state

state

dictionaryType

dictionaryType

dataBody

startFid

startEnumTableCount

startFid

startEnumTableCount

checkClearCache

applyClearCache

checkRefreshComplete

checkSolicited

applySolicited

applyRefreshComplete