com.thomsonreuters.upa.valueadd.domainrep.rdm.directory

Class Service.ServiceData

java.lang.Object

com.thomsonreuters.upa.valueadd.domainrep.rdm.directory.Service.ServiceData

Enclosing interface:

Service

public static class Service.ServiceData
extends java.lang.Object

The RDM Service Data. Contains information provided by the Source Directory Data filter.

See Also:

Service.ServiceDataFlags, ServiceImpl

Constructor Summary

Constructors

Constructor and Description
ServiceData() Instantiates a new service data.

Method Summary

Modifier and Type	Method and Description
int	action() Returns action associated with data filter.
void	action(int action) Sets action associated with data filter.
void	applyHasData() Applies data presence flag.
boolean	checkHasData() Checks the presence of the data field.
void	clear() Clears an RDM Service Data.
int	copy(Service.ServiceData destServiceData) Performs a deep copy of Service.ServiceData object.
com.thomsonreuters.upa.codec.Buffer	data() Returns buffer representing the encoded data, to be applied to all items being provided by this service.
void	data(com.thomsonreuters.upa.codec.Buffer data) Sets encoded data for this service to the user specified buffer.
int	dataType() Returns dataType - The OMM type of the data.
void	dataType(int dataType) dataType - The OMM type of the data.
int	decode(com.thomsonreuters.upa.codec.DecodeIterator dIter) Decode a UPA service data field into an RDM service data field.
int	encode(com.thomsonreuters.upa.codec.EncodeIterator encIter) Encode an RDM Service Data.
int	filterId() Returns filterId - Populated by Directory.ServiceFilterIds.
int	flags() Returns service data flags.
void	flags(int flags) Sets service data flags.
java.lang.String	toString()
long	type() Directory data type.
void	type(long type) Directory data type.
int	update(Service.ServiceData destServiceData) Performs an update of Service.ServiceData object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServiceData

public ServiceData()

Instantiates a new service data.

Method Detail

clear

public void clear()

Clears an RDM Service Data.

applyHasData

public void applyHasData()

Applies data presence flag. Flags may also be bulk-get via flags().

checkHasData

public boolean checkHasData()

Checks the presence of the data field. Flags may also be bulk-set via flags(int).

Returns:

true - if info field exists, false - if not.

See Also:

flags(int)

encode

public int encode(com.thomsonreuters.upa.codec.EncodeIterator encIter)

Encode an RDM Service Data.

Parameters:

encIter - The Encode Iterator

Returns:

UPA return value

decode

public int decode(com.thomsonreuters.upa.codec.DecodeIterator dIter)

Decode a UPA service data field into an RDM service data field.

Parameters:

dIter - The Decode Iterator

Returns:

UPA return value

copy

public int copy(Service.ServiceData destServiceData)

Performs a deep copy of Service.ServiceData object.

Parameters:

destServiceData - ServiceData 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.ServiceData destServiceData)

Performs an update of Service.ServiceData object.

Parameters:

destServiceData - ServiceData object to update with information from this object. It cannot be null.

Returns:

UPA return value indicating success or failure of update operation.

flags

public void flags(int flags)

Sets service data flags. Populate with Service.ServiceDataFlags.

Parameters:

flags - the flags

flags

public int flags()

Returns service data flags. Populated by Service.ServiceDataFlags.

Returns:

flags

action

public void action(int action)

Sets action associated with data filter.

Parameters:

action - the action

action

public int action()

Returns action associated with data filter.

Returns:

action

dataType

public int dataType()

Returns dataType - The OMM type of the data. Populated by DataTypes.

Returns:

dataType

dataType

public void dataType(int dataType)

dataType - The OMM type of the data. Populated by DataTypes.

Parameters:

dataType - the data type

type

public long type()

Directory data type. Populated by Directory.DataTypes.

Returns:

type

type

public void type(long type)

Directory data type. Populated by Directory.DataTypes.

Parameters:

type - the type

data

public com.thomsonreuters.upa.codec.Buffer data()

Returns buffer representing the encoded data, to be applied to all items being provided by this service.

Returns:

data.

data

public void data(com.thomsonreuters.upa.codec.Buffer data)

Sets encoded data for this service to the user specified buffer. Data and position of encoded data of this service will be set to passed in buffer's data and position. Note that this creates garbage if buffer is backed by String object.

Parameters:

data - the data

filterId

public int filterId()

Returns filterId - Populated by Directory.ServiceFilterIds.

Returns:

filterId

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object