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

Interface DirectoryRequest

All Superinterfaces:

DirectoryMsg, MsgBase

public interface DirectoryRequest
extends DirectoryMsg

A Directory request message is encoded and sent by OMM consumer applications. A consumer can request information about all services by omitting serviceId information, or specify a serviceId to request information about only that service.

See Also:

DirectoryMsg

Method Summary

Modifier and Type	Method and Description
void	applyHasServiceId() Applies the serviceId presence flag.
void	applyStreaming() Makes this request streaming request.
boolean	checkHasServiceId() Checks the presence of the serviceId field.
boolean	checkStreaming() Checks if this request is streaming or not.
int	copy(DirectoryRequest destRequestMsg) Performs a deep copy of DirectoryRequest object.
long	filter() A filter indicating which filters of information the Consumer is interested in.
void	filter(long filter) A filter indicating which filters of information the Consumer is interested in.
int	flags() The RDM Directory request flags.
void	flags(int flags) The RDM Directory request flags.
int	serviceId() serviceId - The ID of the service to request the directory from.
void	serviceId(int serviceId) The ID of the service to request the directory from.

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.directory.DirectoryMsg

rdmMsgType, rdmMsgType

Methods inherited from interface com.thomsonreuters.upa.valueadd.domainrep.rdm.MsgBase

clear, decode, domainType, encode, streamId, streamId

Method Detail

copy

int copy(DirectoryRequest destRequestMsg)

Performs a deep copy of DirectoryRequest object.

Parameters:

destRequestMsg - Message to copy directory request object into. It cannot be null.

Returns:

UPA return value indicating success or failure of copy operation.

flags

int flags()

The RDM Directory request flags. Populated by DirectoryRequestFlags.

Returns:

flags

flags

void flags(int flags)

The RDM Directory request flags. Populated by DirectoryRequestFlags.

Parameters:

flags - the flags

checkStreaming

boolean checkStreaming()

Checks if this request is streaming or not. This flag can also be bulk-get by flags()

Returns:

true - if request is streaming, false - if not.

applyStreaming

void applyStreaming()

Makes this request streaming request. This flag can also be bulk-set by flags(int)

applyHasServiceId

void applyHasServiceId()

Applies the serviceId presence flag. This flag can also be bulk-set by flags(int)

checkHasServiceId

boolean checkHasServiceId()

Checks the presence of the serviceId field. This flag can also be bulk-get by flags()

Returns:

true - if serviceId field is present, false - if not.

filter

long filter()

A filter indicating which filters of information the Consumer is interested in. Populated by Directory.ServiceFilterFlags.

Returns:

filter

filter

void filter(long filter)

A filter indicating which filters of information the Consumer is interested in. Populated by Directory.ServiceFilterFlags.

Parameters:

filter - the filter

serviceId

int serviceId()

serviceId - The ID of the service to request the directory from.

Returns:

serviceId

serviceId

void serviceId(int serviceId)

The ID of the service to request the directory from.

Parameters:

serviceId - the service id