Service (ETA ValueAdd)

```
public interface Service
```
The RDM Service. Contains information about a particular service.

See Also:

Service.ServiceFlags, Service.ServiceInfo, Service.ServiceState, Service.ServiceGroup, Service.ServiceLoad, Service.ServiceData, Service.ServiceLinkInfo

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Service.RDMAddressPortInfo` Contains RDM Address and port information and getter/setter/clear methods for all of it
`static class`	`Service.RDMMCAddressPortInfo` Contains RDM Address, port, and domain information and getter/setter/clear methods for all of it
`static class`	`Service.ServiceData` The RDM Service Data.
`static class`	`Service.ServiceDataFlags` The RDM Service Data flags.
`static class`	`Service.ServiceFlags` The RDM Service filter flags.
`static class`	`Service.ServiceGroup` The RDM Service Group State.
`static class`	`Service.ServiceGroupFlags` The RDM Service Group flags.
`static class`	`Service.ServiceInfo` The RDM Service Info.
`static class`	`Service.ServiceInfoFlags` The RDM Service Info flags.
`static class`	`Service.ServiceLink` The RDM Service Link.
`static class`	`Service.ServiceLinkFlags` The RDM Service Link flags.
`static class`	`Service.ServiceLinkInfo` The RDM Service Link Info.
`static class`	`Service.ServiceLoad` The RDM Service Load.
`static class`	`Service.ServiceLoadFlags` The RDM Service Load flags.
`static class`	`Service.ServiceSeqMcast` The RDM Service Sequenced Multicast.
`static class`	`Service.ServiceSeqMcastFlags` The RDM Service Sequenced Multicast flags.
`static class`	`Service.ServiceSeqMcastInfo` The RDM Service Sequenced Multicast Info.
`static class`	`Service.ServiceState` The RDM Service State.
`static class`	`Service.ServiceStateFlags` The RDM Service State flags.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`action()` Returns action associated with this service.
`void`	`action(int action)` Sets action associated with this service.
`void`	`applyHasData()` Applies data presence flag.
`void`	`applyHasInfo()` Applies info presence flag.
`void`	`applyHasLink()` Applies link presence flag.
`void`	`applyHasLoad()` Applies load presence flag.
`void`	`applyHasState()` Applies state presence flag.
`int`	`applyUpdate(Service destService)` Performs an update of this `ServiceImpl` object to the destination `ServiceImpl` object.
`boolean`	`checkHasData()` Checks the presence of the data field.
`boolean`	`checkHasInfo()` Checks the presence of the info field.
`boolean`	`checkHasLink()` Checks the presence of the link field.
`boolean`	`checkHasLoad()` Checks the presence of the load field.
`boolean`	`checkHasState()` Checks the presence of the state field.
`void`	`clear()` Clears an RDMService.
`int`	`copy(Service destService)` Performs a deep copy of `ServiceImpl` object.
`Service.ServiceData`	`data()` Returns data filter for this service.
`void`	`data(Service.ServiceData data)` Sets data filter for this service.
`int`	`decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)` Decode a UPA service entry into an RDM service entry.
`int`	`encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)` Encode an RDM Service entry.
`int`	`flags()` Returns service state flags.
`void`	`flags(int flags)` Sets service state flags.
`java.util.List<Service.ServiceGroup>`	`groupStateList()` Returns list of group filters for this service.
`void`	`groupStateList(java.util.List<Service.ServiceGroup> groupStateList)` Sets group filter elements for this service.
`Service.ServiceInfo`	`info()` Returns info filter for this service.
`void`	`info(Service.ServiceInfo info)` Sets info filter for this service.
`Service.ServiceLinkInfo`	`link()` Returns link filter for this service.
`void`	`link(Service.ServiceLinkInfo link)` Sets link filter for this service.
`Service.ServiceLoad`	`load()` Returns load filter for this service.
`void`	`load(Service.ServiceLoad load)` Sets load filter for this service.
`Service.ServiceSeqMcastInfo`	`seqMcastInfo()` Returns information about Sequenced Multicast connections with regards to EDF connections to Snapshot server, Reference Data Server, Gap Fill and Request servers, and multicast groups.
`int`	`serviceId()` Returns serviceId - number identifying this service.
`void`	`serviceId(int serviceId)` Sets serviceId - number identifying this service.
`Service.ServiceState`	`state()` Returns state filter for this service.
`void`	`state(Service.ServiceState state)` Sets state filter for this service.

- Method Detail
  - clear
```
void clear()
```
    Clears an RDMService.
  - action
```
int action()
```
    Returns action associated with this service.
    
    Returns:
    
    action
  - action
```
void action(int action)
```
    Sets action associated with this service.
    
    Parameters:
    
    action - the action
  - flags
```
int flags()
```
    Returns service state flags. Populated with Service.ServiceFlags
    
    Returns:
    
    flags
  - flags
```
void flags(int flags)
```
    Sets service state flags. Populate with Service.ServiceFlags
    
    Parameters:
    
    flags - the flags
  - applyHasInfo
```
void applyHasInfo()
```
    Applies info presence flag. Flags may also be bulk-get via flags().
  - checkHasInfo
```
boolean checkHasInfo()
```
    Checks the presence of the info field. Flags may also be bulk-set via flags(int).
    
    Returns:
    
    true - if info field exists, false - if not.
  - applyHasData
```
void applyHasData()
```
    Applies data presence flag. Flags may also be bulk-get via flags().
  - checkHasData
```
boolean checkHasData()
```
    Checks the presence of the data field. Flags may also be bulk-set via flags(int).
    
    Returns:
    
    true - if data field exists, false - if not.
  - applyHasLoad
```
void applyHasLoad()
```
    Applies load presence flag. Flags may also be bulk-get via flags().
  - checkHasLoad
```
boolean checkHasLoad()
```
    Checks the presence of the load field. Flags may also be bulk-set via flags(int).
    
    Returns:
    
    true, if successful
  - applyHasLink
```
void applyHasLink()
```
    Applies link presence flag. Flags may also be bulk-get via flags().
  - checkHasLink
```
boolean checkHasLink()
```
    Checks the presence of the link field. Flags may also be bulk-set via flags(int).
    
    Returns:
    
    true - if link field exists, false - if not.
  - applyHasState
```
void applyHasState()
```
    Applies state presence flag. Flags may also be bulk-get via flags().
  - checkHasState
```
boolean checkHasState()
```
    Checks the presence of the state field. Flags may also be bulk-set via flags(int).
    
    Returns:
    
    true - if state field exists, false - if not.
  - encode
```
int encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)
```
    Encode an RDM Service entry.
    
    Parameters:
    
    encIter - The Encode Iterator
    
    Returns:
    
    UPA return value
  - decode
```
int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)
```
    Decode a UPA service entry into an RDM service entry.
    
    Parameters:
    
    dIter - The Decode Iterator
    
    Returns:
    
    UPA return value
  - serviceId
```
int serviceId()
```
    Returns serviceId - number identifying this service.
    
    Returns:
    
    serviceId
  - serviceId
```
void serviceId(int serviceId)
```
    Sets serviceId - number identifying this service.
    
    Parameters:
    
    serviceId - the service id
  - info
```
Service.ServiceInfo info()
```
    Returns info filter for this service.
    
    Returns:
    
    info filter.
  - info
```
void info(Service.ServiceInfo info)
```
    Sets info filter for this service.
    
    Parameters:
    
    info - -info filter.
  - state
```
Service.ServiceState state()
```
    Returns state filter for this service.
    
    Returns:
    
    state filter.
  - state
```
void state(Service.ServiceState state)
```
    Sets state filter for this service.
    
    Parameters:
    
    state - -service state filter.
  - groupStateList
```
java.util.List<Service.ServiceGroup> groupStateList()
```
    Returns list of group filters for this service.
    
    Returns:
    
    list of group filters.
  - groupStateList
```
void groupStateList(java.util.List<Service.ServiceGroup> groupStateList)
```
    Sets group filter elements for this service.
    
    Parameters:
    
    groupStateList - the group state list
  - load
```
Service.ServiceLoad load()
```
    Returns load filter for this service.
    
    Returns:
    
    load filter.
  - load
```
void load(Service.ServiceLoad load)
```
    Sets load filter for this service.
    
    Parameters:
    
    load - -service load filter.
  - data
```
Service.ServiceData data()
```
    Returns data filter for this service.
    
    Returns:
    
    data filter.
  - data
```
void data(Service.ServiceData data)
```
    Sets data filter for this service.
    
    Parameters:
    
    data - -service data filter.
  - link
```
Service.ServiceLinkInfo link()
```
    Returns link filter for this service.
    
    Returns:
    
    link filter.
  - link
```
void link(Service.ServiceLinkInfo link)
```
    Sets link filter for this service.
    
    Parameters:
    
    link - -service link filter.
  - copy
```
int copy(Service destService)
```
    Performs a deep copy of ServiceImpl object.
    
    Parameters:
    
    destService - Service object to copy this object into. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of copy operation.
  - applyUpdate
```
int applyUpdate(Service destService)
```
    Performs an update of this ServiceImpl object to the destination ServiceImpl object. Only updated filter entries are copied to the destination.
    
    Parameters:
    
    destService - Service object to be updated by this object. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of update operation.
  - seqMcastInfo
```
Service.ServiceSeqMcastInfo seqMcastInfo()
```
    Returns information about Sequenced Multicast connections with regards to EDF connections to Snapshot server, Reference Data Server, Gap Fill and Request servers, and multicast groups.
    
    Returns:
    
    Service Sequenced Multicast information

Interface Service

Nested Class Summary

Method Summary

Method Detail

clear

action

action

flags

flags

applyHasInfo

checkHasInfo

applyHasData

checkHasData

applyHasLoad

checkHasLoad

applyHasLink

checkHasLink

applyHasState

checkHasState

encode

decode

serviceId

serviceId

info

info

state

state

groupStateList

groupStateList

load

load

data

data

link

link

copy

applyUpdate

seqMcastInfo