Service.ServiceLink (ETA ValueAdd)

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

Enclosing interface:

Service
```
public static class Service.ServiceLink
extends java.lang.Object
```
The RDM Service Link. Contains information about an upstream source associated with the service.

See Also:

Service.ServiceLinkFlags, ServiceImpl

Constructor Summary

Constructors
Constructor and Description

ServiceLink()
Instantiates a new service link.

Constructors
Constructor and Description
`ServiceLink()` Instantiates a new service link.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`action()` Returns the action associated with this link filter.
`void`	`action(int action)` Sets action associated with this link filter.
`void`	`applyHasCode()` Applies link code flag.
`void`	`applyHasText()` Applies text presence flag.
`void`	`applyHasType()` Applies link code flag.
`boolean`	`checkHasCode()` Indicates presence of the link code field.
`boolean`	`checkHasText()` Indicates presence of the link text field.
`boolean`	`checkHasType()` Indicates presence of the link type field.
`void`	`clear()` Clears an RDMServiceLink.
`int`	`copy(Service.ServiceLink destServiceLink)` Performs a deep copy of `Service.ServiceLink` object.
`int`	`decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)` Decode a UPA service link filter into an RDM service link filter.
`int`	`encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)` Encode a single RDM Service Link filter entry.
`int`	`filterId()` Returns filterId - Populated by `Directory.ServiceFilterIds`.
`int`	`flags()` Returns the service sink flags.
`void`	`flags(int flags)` Sets service link flags.
`long`	`linkCode()` Returns linkCode - Code indicating additional information about the status of the source.
`void`	`linkCode(long linkCode)` Sets linkCode - Code indicating additional information about the status of the source.
`long`	`linkState()` Returns linkState - Flag indicating whether the source is up or down.
`void`	`linkState(long linkState)` Sets linkState - Flag indicating whether the source is up or down.
`com.thomsonreuters.upa.codec.Buffer`	`linkText()` Deprecated.
`com.thomsonreuters.upa.codec.Buffer`	`name()` Returns name identifying this upstream source.
`void`	`name(com.thomsonreuters.upa.codec.Buffer name)` Sets upstream source name to the user specified buffer.
`com.thomsonreuters.upa.codec.Buffer`	`text()` Returns text - Text further describing the state provided by the linkState and linkCode members.
`void`	`text(com.thomsonreuters.upa.codec.Buffer text)` Sets text field buffer for this service to the user specified buffer.
`java.lang.String`	`toString()`
`long`	`type()` Returns type of this service link.
`void`	`type(long type)` Sets type of this service link.

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

- Constructor Detail
  - ServiceLink
```
public ServiceLink()
```
    Instantiates a new service link.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clear
```
public void clear()
```
    Clears an RDMServiceLink.
  - copy
```
public int copy(Service.ServiceLink destServiceLink)
```
    Performs a deep copy of Service.ServiceLink object.
    
    Parameters:
    
    destServiceLink - ServiceLink object to copy this object into. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of copy operation.
  - name
```
public com.thomsonreuters.upa.codec.Buffer name()
```
    Returns name identifying this upstream source.
    
    Returns:
    
    type
  - name
```
public void name(com.thomsonreuters.upa.codec.Buffer name)
```
    Sets upstream source name to the user specified buffer. Data and position of name 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:
    
    name - the name
  - type
```
public long type()
```
    Returns type of this service link. Populated by Directory.LinkTypes
    
    Returns:
    
    type
  - type
```
public void type(long type)
```
    Sets type of this service link. Populated by Directory.LinkTypes
    
    Parameters:
    
    type - the type
  - linkState
```
public long linkState()
```
    Returns linkState - Flag indicating whether the source is up or down. Populated by Directory.LinkStates.
    
    Returns:
    
    linkState
  - linkState
```
public void linkState(long linkState)
```
    Sets linkState - Flag indicating whether the source is up or down. Populated by Directory.LinkStates.
    
    Parameters:
    
    linkState - the link state
  - linkCode
```
public long linkCode()
```
    Returns linkCode - Code indicating additional information about the status of the source. Populated by Directory.LinkCodes.
    
    Returns:
    
    linkCode
  - linkCode
```
public void linkCode(long linkCode)
```
    Sets linkCode - Code indicating additional information about the status of the source. Populated by Directory.LinkCodes.
    
    Parameters:
    
    linkCode - the link code
  - linkText
```
@Deprecated
public com.thomsonreuters.upa.codec.Buffer linkText()
```
    Deprecated.
    
    Returns text - Text further describing the state provided by the linkState and linkCode members.
    
    Returns:
    
    text
  - text
```
public com.thomsonreuters.upa.codec.Buffer text()
```
    Returns text - Text further describing the state provided by the linkState and linkCode members.
    
    Returns:
    
    text
  - text
```
public void text(com.thomsonreuters.upa.codec.Buffer text)
```
    Sets text field buffer for this service to the user specified buffer. Data and position of text 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:
    
    text - the text
  - flags
```
public int flags()
```
    Returns the service sink flags. It is populated by Service.ServiceLinkFlags
    
    Returns:
    
    flags
  - flags
```
public void flags(int flags)
```
    Sets service link flags. Populate with Service.ServiceLinkFlags
    
    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 encIter)
```
    Encode a single RDM Service Link filter entry.
    
    Parameters:
    
    encIter - The Encode Iterator
    
    Returns:
    
    UPA return value
  - checkHasText
```
public boolean checkHasText()
```
    Indicates presence of the link text field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if text field is present, false - if not.
  - applyHasText
```
public void applyHasText()
```
    Applies text presence flag. Flags may also be bulk-set via flags(int).
  - checkHasCode
```
public boolean checkHasCode()
```
    Indicates presence of the link code field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if link code field is present, false - if not.
  - applyHasCode
```
public void applyHasCode()
```
    Applies link code flag. Flags may also be bulk-set via flags(int).
  - checkHasType
```
public boolean checkHasType()
```
    Indicates presence of the link type field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if link code field is present, false - if not.
  - applyHasType
```
public void applyHasType()
```
    Applies link code flag. Flags may also be bulk-set via flags(int).
  - decode
```
public int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)
```
    Decode a UPA service link filter into an RDM service link filter.
    
    Parameters:
    
    dIter - The Decode Iterator
    
    Returns:
    
    UPA return value
  - action
```
public int action()
```
    Returns the action associated with this link filter. action - MapEntryActions
    
    Returns:
    
    the int
  - action
```
public void action(int action)
```
    Sets action associated with this link filter.
    
    Parameters:
    
    action - - Populated by MapEntryActions

Class Service.ServiceLink

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceLink

Method Detail

toString

clear

copy

name

name

type

type

linkState

linkState

linkCode

linkCode

linkText

text

text

flags

flags

filterId

encode

checkHasText

applyHasText

checkHasCode

applyHasCode

checkHasType

applyHasType

decode

action

action