Service.ServiceInfo (ETA ValueAdd)

java.lang.Object
- com.thomsonreuters.upa.valueadd.domainrep.rdm.directory.Service.ServiceInfo

Enclosing interface:

Service
```
public static class Service.ServiceInfo
extends java.lang.Object
```
The RDM Service Info. Contains information provided by the Source Directory Info filter.

See Also:

Service.ServiceInfoFlags, ServiceImpl

Constructor Summary

Constructors
Constructor and Description

ServiceInfo()
Instantiates a new service info.

Constructors
Constructor and Description
`ServiceInfo()` Instantiates a new service info.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`acceptingConsumerStatus()` Returns acceptingConsumerStatus - Field that indicates whether the service accepts messages related to Source Mirroring.
`void`	`acceptingConsumerStatus(long acceptingConsumerStatus)` Sets acceptingConsumerStatus - Field that indicates whether the service accepts messages related to Source Mirroring.
`int`	`action()` action - Action associated with this info filter.
`void`	`action(int action)` Sets action associated with this info filter.
`void`	`applyHasAcceptingConsumerStatus()` Applies the acceptingConsumerStatus presence flag.
`void`	`applyHasDictionariesProvided()` Applies the dictionariesProvided presence field.
`void`	`applyHasDictionariesUsed()` Applies the dictionariesUsed presence field.
`void`	`applyHasIsSource()` Applies isSource flag.
`void`	`applyHasItemList()` Applies the itemList presence field.
`void`	`applyHasQos()` Applies the qosList presence field.
`void`	`applyHasSupportsOutOfBandSnapshots()` Applies the supportsOutOfBandSnapshots presence flag.
`void`	`applyHasSupportsQosRange()` Applies supportsQosRange flag.
`void`	`applyHasVendor()` Applies vendor flag.
`com.thomsonreuters.upa.codec.Qos`	`bestQos()` Returns the best quality of service that this service provides.
`java.util.List<java.lang.Long>`	`capabilitiesList()` Returns list of capabilities the service supports.
`void`	`capabilitiesList(java.util.List<java.lang.Long> capabilitiesList)` Sets capabilities for this service.
`boolean`	`checkHasAcceptingConsumerStatus()` Checks the presence of the acceptingConsumerStatus field.
`boolean`	`checkHasDictionariesProvided()` Checks the presence of the dictionariesProvided field.
`boolean`	`checkHasDictionariesUsed()` dictionariesUsed - Checks the presence of the dictionariesUsed field.
`boolean`	`checkHasIsSource()` Checks the presence of the isSource field.
`boolean`	`checkHasItemList()` Checks the presence of the itemList field.
`boolean`	`checkHasQos()` Checks the presence of the qosList field.
`boolean`	`checkHasSupportsOutOfBandSnapshots()` Checks the presence of the supportsOutOfBandSnapshots field.
`boolean`	`checkHasSupportsQosRange()` Checks the presence of the supportsQosRange field.
`boolean`	`checkHasVendor()` Checks the presence of the vendor field.
`void`	`clear()` Clears an RDMService info filter.
`int`	`copy(Service.ServiceInfo destServiceInfo)` Performs a deep copy of `Service.ServiceInfo` object.
`int`	`decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)` Decode a UPA service data filter into an RDM service info filter.
`java.util.List<java.lang.String>`	`dictionariesProvidedList()` Returns the list of dictionary names that this service provides.
`void`	`dictionariesProvidedList(java.util.List<java.lang.String> dictionariesProvidedList)` Sets dictionary names provided by this service.
`java.util.List<java.lang.String>`	`dictionariesUsedList()` returns the list of dictionary names that a Consumer will require to decode the service's market data.
`void`	`dictionariesUsedList(java.util.List<java.lang.String> dictionariesUsedList)` Sets dictionary names that a consumer will require to decode the service's market data content.
`int`	`encode(com.thomsonreuters.upa.codec.EncodeIterator encodeIter)` Encode an RDM Service info filter.
`int`	`filterId()` Returns filterId - Populated by `Directory.ServiceFilterIds`.
`int`	`flags()` Returns service info flags.
`void`	`flags(int flags)` The service info flags.
`long`	`isSource()` Returns isSource field that indicates whether the service is provided directly by a publisher or consolidated from multiple sources.
`void`	`isSource(long isSource)` Sets isSource field that indicates whether the service is provided directly by a publisher or consolidated from multiple sources.
`com.thomsonreuters.upa.codec.Buffer`	`itemList()` Returns the list of item names a Consumer can request to get a symbol list of all item names available from this service.
`void`	`itemList(com.thomsonreuters.upa.codec.Buffer itemList)` Sets itemList for this service to the user specified buffer.
`java.util.List<com.thomsonreuters.upa.codec.Qos>`	`qosList()` Returns the list of qualities of service that this service provides.
`void`	`qosList(java.util.List<com.thomsonreuters.upa.codec.Qos> qosList)` Sets qualities of service that this service provides.
`com.thomsonreuters.upa.codec.Buffer`	`serviceName()` Returns the service name that identifies this service.
`void`	`serviceName(com.thomsonreuters.upa.codec.Buffer serviceName)` Sets serviceName for this service to the user specified buffer.
`long`	`supportsOutOfBandSnapshots()` supportsOutOfBandSnapshots - Field that indicates whether Snapshot(requests without the STREAMING flag) can be made when the OpenLimit is reached.
`void`	`supportsOutOfBandSnapshots(long supportsOutOfBandSnapshots)` supportsOutOfBandSnapshots - Field that indicates whether Snapshot(requests without the STREAMING flag) can be made when the OpenLimit is reached.
`long`	`supportsQosRange()` supportsQosRange - Field that indicates whether items can be requested using a QoS range(using both the qos and worstQos members of a `RequestMsg`).
`void`	`supportsQosRange(long supportsQosRange)` Sets supportsQosRange - Field that indicates whether items can be requested using a QoS range(using both the qos and worstQos members of a `RequestMsg`).
`java.lang.String`	`toString()`
`int`	`update(Service.ServiceInfo destServiceInfo)` Performs an update of `Service.ServiceInfo` object.
`com.thomsonreuters.upa.codec.Buffer`	`vendor()` Returns the vendor name of data provided by this service.
`void`	`vendor(com.thomsonreuters.upa.codec.Buffer vendor)` Sets vendor name for this service to the user specified buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ServiceInfo
```
public ServiceInfo()
```
    Instantiates a new service info.
- Method Detail
  - clear
```
public void clear()
```
    Clears an RDMService info filter.
  - serviceName
```
public com.thomsonreuters.upa.codec.Buffer serviceName()
```
    Returns the service name that identifies this service.
    
    Returns:
    
    service name.
  - serviceName
```
public void serviceName(com.thomsonreuters.upa.codec.Buffer serviceName)
```
    Sets serviceName for this service to the user specified buffer. Data and position of serviceName buffer will be set to passed in buffer's data and position. Note that this creates garbage if buffer is backed by String object.
    
    Parameters:
    
    serviceName - the service name
  - vendor
```
public com.thomsonreuters.upa.codec.Buffer vendor()
```
    Returns the vendor name of data provided by this service.
    
    Returns:
    
    Vendor.
  - vendor
```
public void vendor(com.thomsonreuters.upa.codec.Buffer vendor)
```
    Sets vendor name for this service to the user specified buffer. Data and position of vendor field buffer will be set to passed in buffer's data and position. Note that this creates garbage if buffer is backed by String object.
    
    Parameters:
    
    vendor - the vendor
  - applyHasVendor
```
public void applyHasVendor()
```
    Applies vendor flag. Flags may also be bulk-set via flags(int).
  - checkHasVendor
```
public boolean checkHasVendor()
```
    Checks the presence of the vendor field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if vendor field exists, false - if not.
  - isSource
```
public long isSource()
```
    Returns isSource field that indicates whether the service is provided directly by a publisher or consolidated from multiple sources.
    
    Returns:
    
    isSource
  - isSource
```
public void isSource(long isSource)
```
    Sets isSource field that indicates whether the service is provided directly by a publisher or consolidated from multiple sources.
    
    Parameters:
    
    isSource - the is source
  - applyHasIsSource
```
public void applyHasIsSource()
```
    Applies isSource flag. Flags may also be bulk-set via flags(int).
  - checkHasIsSource
```
public boolean checkHasIsSource()
```
    Checks the presence of the isSource field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if isSource field exists, false - if not.
  - supportsQosRange
```
public long supportsQosRange()
```
    supportsQosRange - Field that indicates whether items can be requested using a QoS range(using both the qos and worstQos members of a RequestMsg).
    
    Returns:
    
    supportsQosRange field.
  - supportsQosRange
```
public void supportsQosRange(long supportsQosRange)
```
    Sets supportsQosRange - Field that indicates whether items can be requested using a QoS range(using both the qos and worstQos members of a RequestMsg).
    
    Parameters:
    
    supportsQosRange - the supports qos range
  - applyHasSupportsQosRange
```
public void applyHasSupportsQosRange()
```
    Applies supportsQosRange flag. Flags may also be bulk-set via flags(int).
  - checkHasSupportsQosRange
```
public boolean checkHasSupportsQosRange()
```
    Checks the presence of the supportsQosRange field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if supportsQosRange field exists, false - if not.
  - supportsOutOfBandSnapshots
```
public long supportsOutOfBandSnapshots()
```
    supportsOutOfBandSnapshots - Field that indicates whether Snapshot(requests without the STREAMING flag) can be made when the OpenLimit is reached.
    
    Returns:
    
    supportsOutOfBandSnapshots
  - supportsOutOfBandSnapshots
```
public void supportsOutOfBandSnapshots(long supportsOutOfBandSnapshots)
```
    supportsOutOfBandSnapshots - Field that indicates whether Snapshot(requests without the STREAMING flag) can be made when the OpenLimit is reached.
    
    Parameters:
    
    supportsOutOfBandSnapshots - the supports out of band snapshots
  - applyHasSupportsOutOfBandSnapshots
```
public void applyHasSupportsOutOfBandSnapshots()
```
    Applies the supportsOutOfBandSnapshots presence flag.
  - checkHasSupportsOutOfBandSnapshots
```
public boolean checkHasSupportsOutOfBandSnapshots()
```
    Checks the presence of the supportsOutOfBandSnapshots field.
    
    Returns:
    
    true - if supportsOutOfBandSnapshots field present, false - if not.
  - acceptingConsumerStatus
```
public long acceptingConsumerStatus()
```
    Returns acceptingConsumerStatus - Field that indicates whether the service accepts messages related to Source Mirroring.
    
    Returns:
    
    acceptingConsumerStatus
    
    See Also:
    
    DirectoryConsumerStatus
  - acceptingConsumerStatus
```
public void acceptingConsumerStatus(long acceptingConsumerStatus)
```
    Sets acceptingConsumerStatus - Field that indicates whether the service accepts messages related to Source Mirroring.
    
    Parameters:
    
    acceptingConsumerStatus - the accepting consumer status
    
    See Also:
    
    DirectoryConsumerStatus
  - applyHasAcceptingConsumerStatus
```
public void applyHasAcceptingConsumerStatus()
```
    Applies the acceptingConsumerStatus presence flag.
  - checkHasAcceptingConsumerStatus
```
public boolean checkHasAcceptingConsumerStatus()
```
    Checks the presence of the acceptingConsumerStatus field.
    
    Returns:
    
    true - if acceptingConsumerStatus field present, false - if not.
  - itemList
```
public com.thomsonreuters.upa.codec.Buffer itemList()
```
    Returns the list of item names a Consumer can request to get a symbol list of all item names available from this service.
    
    Returns:
    
    itemList
  - itemList
```
public void itemList(com.thomsonreuters.upa.codec.Buffer itemList)
```
    Sets itemList for this service to the user specified buffer. Data and position of itemList buffer will be set to passed in buffer's data and position. Note that this creates garbage if buffer is backed by String object.
    
    Parameters:
    
    itemList - the item list
  - applyHasItemList
```
public void applyHasItemList()
```
    Applies the itemList presence field. Flags may also be bulk-set via flags(int).
  - checkHasItemList
```
public boolean checkHasItemList()
```
    Checks the presence of the itemList field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if itemList field exists, false - if not.
  - capabilitiesList
```
public java.util.List<java.lang.Long> capabilitiesList()
```
    Returns list of capabilities the service supports. Capability in the list is populated by DomainTypes.
    
    Returns:
    
    capabilities list.
  - capabilitiesList
```
public void capabilitiesList(java.util.List<java.lang.Long> capabilitiesList)
```
    Sets capabilities for this service.
    
    Parameters:
    
    capabilitiesList - the capabilities list
  - dictionariesProvidedList
```
public java.util.List<java.lang.String> dictionariesProvidedList()
```
    Returns the list of dictionary names that this service provides.
    
    Returns:
    
    dictionariesProvided list.
  - dictionariesProvidedList
```
public void dictionariesProvidedList(java.util.List<java.lang.String> dictionariesProvidedList)
```
    Sets dictionary names provided by this service.
    
    Parameters:
    
    dictionariesProvidedList - the dictionaries provided list
  - applyHasDictionariesProvided
```
public void applyHasDictionariesProvided()
```
    Applies the dictionariesProvided presence field. Flags may also be bulk-set via flags(int).
  - checkHasDictionariesProvided
```
public boolean checkHasDictionariesProvided()
```
    Checks the presence of the dictionariesProvided field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if dictionariesProvided field exists, false - if not.
  - dictionariesUsedList
```
public java.util.List<java.lang.String> dictionariesUsedList()
```
    returns the list of dictionary names that a Consumer will require to decode the service's market data.
    
    Returns:
    
    list of dictionary names.
  - dictionariesUsedList
```
public void dictionariesUsedList(java.util.List<java.lang.String> dictionariesUsedList)
```
    Sets dictionary names that a consumer will require to decode the service's market data content.
    
    Parameters:
    
    dictionariesUsedList - the dictionaries used list
  - applyHasDictionariesUsed
```
public void applyHasDictionariesUsed()
```
    Applies the dictionariesUsed presence field. Flags may also be bulk-set via flags(int).
  - checkHasDictionariesUsed
```
public boolean checkHasDictionariesUsed()
```
    dictionariesUsed - Checks the presence of the dictionariesUsed field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if dictionariesUsed field exists, false - if not.
  - qosList
```
public java.util.List<com.thomsonreuters.upa.codec.Qos> qosList()
```
    Returns the list of qualities of service that this service provides.
    
    Returns:
    
    qosList
  - qosList
```
public void qosList(java.util.List<com.thomsonreuters.upa.codec.Qos> qosList)
```
    Sets qualities of service that this service provides.
    
    Parameters:
    
    qosList - the qos list
  - bestQos
```
public com.thomsonreuters.upa.codec.Qos bestQos()
```
    Returns the best quality of service that this service provides.
    
    Returns:
    
    bestQos
  - applyHasQos
```
public void applyHasQos()
```
    Applies the qosList presence field. Flags may also be bulk-set via flags(int).
  - checkHasQos
```
public boolean checkHasQos()
```
    Checks the presence of the qosList field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if qosList field exists, false - if not.
  - action
```
public int action()
```
    action - Action associated with this info filter.
    
    Returns:
    
    action -MapEntryActions
  - action
```
public void action(int action)
```
    Sets action associated with this info filter.
    
    Parameters:
    
    action - -MapEntryActions
  - flags
```
public int flags()
```
    Returns service info flags. Populated by Service.ServiceInfoFlags
    
    Returns:
    
    flags
  - flags
```
public void flags(int flags)
```
    The service info flags. Populate with Service.ServiceInfoFlags
    
    Parameters:
    
    flags - the flags
  - filterId
```
public int filterId()
```
    Returns filterId - Populated by Directory.ServiceFilterIds.
    
    Returns:
    
    filterId
  - encode
```
public int encode(com.thomsonreuters.upa.codec.EncodeIterator encodeIter)
```
    Encode an RDM Service info filter.
    
    Parameters:
    
    encodeIter - The Encode Iterator
    
    Returns:
    
    UPA return value
  - decode
```
public int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)
```
    Decode a UPA service data filter into an RDM service info filter.
    
    Parameters:
    
    dIter - The Decode Iterator
    
    Returns:
    
    UPA return value
  - copy
```
public int copy(Service.ServiceInfo destServiceInfo)
```
    Performs a deep copy of Service.ServiceInfo object.
    
    Parameters:
    
    destServiceInfo - ServiceInfo object to copy this object into. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of copy operation.
  - update
```
public int update(Service.ServiceInfo destServiceInfo)
```
    Performs an update of Service.ServiceInfo object.
    
    Parameters:
    
    destServiceInfo - ServiceInfo object to update with information from this object. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of update operation.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Service.ServiceInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceInfo

Method Detail

clear

serviceName

serviceName

vendor

vendor

applyHasVendor

checkHasVendor

isSource

isSource

applyHasIsSource

checkHasIsSource

supportsQosRange

supportsQosRange

applyHasSupportsQosRange

checkHasSupportsQosRange

supportsOutOfBandSnapshots

supportsOutOfBandSnapshots

applyHasSupportsOutOfBandSnapshots

checkHasSupportsOutOfBandSnapshots

acceptingConsumerStatus

acceptingConsumerStatus

applyHasAcceptingConsumerStatus

checkHasAcceptingConsumerStatus

itemList

itemList

applyHasItemList

checkHasItemList

capabilitiesList

capabilitiesList

dictionariesProvidedList

dictionariesProvidedList

applyHasDictionariesProvided

checkHasDictionariesProvided

dictionariesUsedList

dictionariesUsedList

applyHasDictionariesUsed

checkHasDictionariesUsed

qosList

qosList

bestQos

applyHasQos

checkHasQos

action

action

flags

flags

filterId

encode

decode

copy

update

toString