Service.ServiceLoad (ETA ValueAdd)

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

Enclosing interface:

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

See Also:

Service.ServiceLoadFlags, ServiceImpl

Constructor Summary

Constructors
Constructor and Description

ServiceLoad()
Instantiates a new service load.

Constructors
Constructor and Description
`ServiceLoad()` Instantiates a new service load.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`action()` Returns action associated with this Load filter.
`void`	`action(int action)` Sets action associated with this Load filter.
`void`	`applyHasLoadFactor()` Applies loadFactor presence flag.
`void`	`applyHasOpenLimit()` Applies openLimit presence flag.
`void`	`applyHasOpenWindow()` Applies openWindow presence flag.
`boolean`	`checkHasLoadFactor()` Indicates presence of the loadFactor field.
`boolean`	`checkHasOpenLimit()` Indicates presence of the openLimit field.
`boolean`	`checkHasOpenWindow()` Indicates presence of the openWindow field.
`void`	`clear()` Clears an RDM Service Load.
`int`	`copy(Service.ServiceLoad destServiceLoad)` Performs a deep copy of `Service.ServiceLoad` object.
`int`	`decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)` Decode a UPA service load filter into an RDM service load filter.
`int`	`encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)` Encode an RDM Service Load filter.
`int`	`filterId()` Returns filterId - Populated by `Directory.ServiceFilterIds`.
`int`	`flags()` Returns the service load flags.
`void`	`flags(int flags)` Sets service load flags.
`long`	`loadFactor()` Returns the load factor - a number indicating the current workload of the source providing the data.
`void`	`loadFactor(long loadFactor)` Sets load factor - a number indicating the current workload of the source providing the data.
`long`	`openLimit()` Returns openLimit - The maximum number of items the Consumer is allowed to open from this service.
`void`	`openLimit(long openLimit)` Sets openLimit - The maximum number of items the Consumer is allowed to open from this service.
`long`	`openWindow()` Returns openWindow - The maximum number of items the Consumer may have outstanding(i.e.
`void`	`openWindow(long openWindow)` Sets openWindow - The maximum number of items the Consumer may have outstanding(i.e.
`java.lang.String`	`toString()`
`int`	`update(Service.ServiceLoad destServiceLoad)` Performs an update of `Service.ServiceLoad` object.

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

- Constructor Detail
  - ServiceLoad
```
public ServiceLoad()
```
    Instantiates a new service load.
- Method Detail
  - clear
```
public void clear()
```
    Clears an RDM Service Load.
    
    See Also:
    
    Service.ServiceLoad
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - flags
```
public int flags()
```
    Returns the service load flags. It is populated by Service.ServiceLoadFlags
    
    Returns:
    
    flags
  - flags
```
public void flags(int flags)
```
    Sets service load flags. Populate with Service.ServiceLoadFlags
    
    Parameters:
    
    flags - the flags
  - action
```
public int action()
```
    Returns action associated with this Load filter.
    
    Returns:
    
    action
  - action
```
public void action(int action)
```
    Sets action associated with this Load filter.
    
    Parameters:
    
    action - the action
  - openLimit
```
public long openLimit()
```
    Returns openLimit - The maximum number of items the Consumer is allowed to open from this service.
    
    Returns:
    
    openLimit
  - openLimit
```
public void openLimit(long openLimit)
```
    Sets openLimit - The maximum number of items the Consumer is allowed to open from this service.
    
    Parameters:
    
    openLimit - the open limit
  - checkHasOpenLimit
```
public boolean checkHasOpenLimit()
```
    Indicates presence of the openLimit field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if openLimit field is present, false - if not.
  - applyHasOpenLimit
```
public void applyHasOpenLimit()
```
    Applies openLimit presence flag. Flags may also be bulk-set via flags(int).
  - openWindow
```
public long openWindow()
```
    Returns openWindow - The maximum number of items the Consumer may have outstanding(i.e. waiting for a RefreshMsg) from this service.
    
    Returns:
    
    openWindow
  - openWindow
```
public void openWindow(long openWindow)
```
    Sets openWindow - The maximum number of items the Consumer may have outstanding(i.e. waiting for a RefreshMsg) from this service.
    
    Parameters:
    
    openWindow - the open window
  - checkHasOpenWindow
```
public boolean checkHasOpenWindow()
```
    Indicates presence of the openWindow field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if openWindow field is present, false - if not.
  - applyHasOpenWindow
```
public void applyHasOpenWindow()
```
    Applies openWindow presence flag. Flags may also be bulk-set via flags(int).
  - loadFactor
```
public long loadFactor()
```
    Returns the load factor - a number indicating the current workload of the source providing the data.
    
    Returns:
    
    loadFactor
  - loadFactor
```
public void loadFactor(long loadFactor)
```
    Sets load factor - a number indicating the current workload of the source providing the data.
    
    Parameters:
    
    loadFactor - the load factor
  - checkHasLoadFactor
```
public boolean checkHasLoadFactor()
```
    Indicates presence of the loadFactor field. Flags may also be bulk-get via flags().
    
    Returns:
    
    true - if loadFactor field is present, false - if not.
  - applyHasLoadFactor
```
public void applyHasLoadFactor()
```
    Applies loadFactor presence flag. Flags may also be bulk-set via flags(int).
  - copy
```
public int copy(Service.ServiceLoad destServiceLoad)
```
    Performs a deep copy of Service.ServiceLoad object.
    
    Parameters:
    
    destServiceLoad - ServiceLoad 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.ServiceLoad destServiceLoad)
```
    Performs an update of Service.ServiceLoad object.
    
    Parameters:
    
    destServiceLoad - ServiceLoad object to update with information from this object. It cannot be null.
    
    Returns:
    
    UPA return value indicating success or failure of update operation.
  - filterId
```
public int filterId()
```
    Returns filterId - Populated by Directory.ServiceFilterIds.
    
    Returns:
    
    filterId
  - encode
```
public int encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)
```
    Encode an RDM Service Load filter.
    
    Parameters:
    
    encIter - The Encode Iterator
    
    Returns:
    
    UPA return value
  - decode
```
public int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)
```
    Decode a UPA service load filter into an RDM service load filter.
    
    Parameters:
    
    dIter - The Decode Iterator
    
    Returns:
    
    UPA return value

Class Service.ServiceLoad

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceLoad

Method Detail

clear

toString

flags

flags

action

action

openLimit

openLimit

checkHasOpenLimit

applyHasOpenLimit

openWindow

openWindow

checkHasOpenWindow

applyHasOpenWindow

loadFactor

loadFactor

checkHasLoadFactor

applyHasLoadFactor

copy

update

filterId

encode

decode