com.bloomberglp.blpapi

Class Operation

java.lang.Object

com.bloomberglp.blpapi.Operation

public abstract class Operation
extends Object

Operation objects are obtained from a Service object and it represents an Operation that can be executed on a Service. Operation provides read-only access to the schema of the Operation's Request and the schema of the possible responses.

Author:

ssomu

Constructor Summary

Constructors

Constructor and Description
Operation()

Method Summary

Modifier and Type	Method and Description
abstract String	description() Return String which contains a human readable description of this Operation.
abstract Name	name() Return the name of this Operation
abstract int	numResponseDefinitions() Returns the number of the response types that can be returned by this Operation.
abstract SchemaElementDefinition	requestDefinition() Returns a read-only SchemaElementDefinition which defines the schema for this Operation
abstract SchemaTypeDefinition	requestType() Deprecated. as of 3.2.1, use requestDefinition() instead
abstract SchemaElementDefinition	responseDefinition(int index) Returns a read-only SchemaElementDefinition which defines the schema of the 'index'th possible response that this Operation delivers.
abstract SchemaTypeDefinition[]	responseType() Deprecated. As of new release, replaced by numResponseDefinitions() and responseDefinition(int)
abstract Schema.Status	status() Return the status of this Operation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operation

public Operation()

Method Detail

name

public abstract Name name()

Return the name of this Operation

status

public abstract Schema.Status status()

Return the status of this Operation

requestType

public abstract SchemaTypeDefinition requestType()

Deprecated. as of 3.2.1, use requestDefinition() instead

Return the TypeDefinition of request for this Operation

requestDefinition

public abstract SchemaElementDefinition requestDefinition()

Returns a read-only SchemaElementDefinition which defines the schema for this Operation

responseType

public abstract SchemaTypeDefinition[] responseType()

Deprecated. As of new release, replaced by numResponseDefinitions() and responseDefinition(int)

Return the TypeDefinitions of the possible responses for this Operation

numResponseDefinitions

public abstract int numResponseDefinitions()

Returns the number of the response types that can be returned by this Operation.

responseDefinition

public abstract SchemaElementDefinition responseDefinition(int index)

Returns a read-only SchemaElementDefinition which defines the schema of the 'index'th possible response that this Operation delivers.

Throws:

IndexOutOfBoundsException - if index >= numResponseDefinitions()

description

public abstract String description()

Return String which contains a human readable description of this Operation.