Package com.bloomberglp.blpapi

Interface Request

public interface Request

This class represents a single request to a particular service

Request objects are created using Service.createRequest(String) or Service.createAuthorizationRequest(). They are used with Session.sendRequest(Request, UserHandle, EventQueue, CorrelationID, String) or AbstractSession.sendAuthorizationRequest(Request, UserHandle, EventQueue, CorrelationID, String). The Request object contains the parameters for a single request to a single service. Once a Request has been created its fields can be populated directly using the convenience functions set() and append() or using the Element interface on the Element returned by asElement().

The schema for the Request can be queried using the Element interface on the Element returned by asElement().

Method Summary

Modifier and Type	Method	Description
void	append(Name name, boolean value)	Append the specified value to the named array element of this request
void	append(Name name, byte[] value)	Deprecated. Arrays of byte arrays are not supported.
void	append(Name name, char value)	Append the specified value to the named array element of this request
void	append(Name name, double value)	Append the specified value to the named array element of this request
void	append(Name name, float value)	Append the specified value to the named array element of this request
void	append(Name name, int value)	Append the specified value to the named array element of this request
void	append(Name name, long value)	Append the specified value to the named array element of this request
void	append(Name name, Constant value)	Append the specified value to the named array element of this request
void	append(Name name, Datetime value)	Append the specified value to the named array element of this request
void	append(Name name, Name value)	Append the specified value to the named array element of this request
void	append(Name name, String value)	Append the specified value to the named array element of this request
void	append(String name, boolean value)	Deprecated. Use append(Name, boolean) instead.
void	append(String name, byte[] value)	Deprecated. Arrays of byte arrays are not supported.
void	append(String name, char value)	Deprecated. Use append(Name, char) instead.
void	append(String name, double value)	Deprecated. Use append(Name, double) instead.
void	append(String name, float value)	Deprecated. Use append(Name, float) instead.
void	append(String name, int value)	Deprecated. Use append(Name, int) instead.
void	append(String name, long value)	Deprecated. Use append(Name, long) instead.
void	append(String name, Constant value)	Deprecated. Use append(Name, Constant) instead.
void	append(String name, Datetime value)	Deprecated. Use append(Name, Datetime) instead.
void	append(String name, Name value)	Deprecated. Use append(Name, Name) instead.
void	append(String name, String value)	Deprecated. Use append(Name, String) instead.
Element	asElement()	Return the contents of this Request as an element.
Element	getElement(Name name)	Return the modifiable element of this request having the specified name creating it if doesn't exist already.
Element	getElement(String name)	Deprecated. Use getElement(Name) instead.
String	getRequestId()	Returns request id if one exists, otherwise, null.
boolean	hasElement(Name name)	Return true if this request contains the element having the specified name false otherwise
boolean	hasElement(String name)	Deprecated. Use hasElement(Name) instead.
Operation	operation()	Return the Operation this Request is intended to invoke on the associated Service.
void	print(OutputStream output)	Prints the contents of this message to the specified OutputStream.
void	print(Writer writer)	Prints the contents of this message to the specified Writer.
void	set(Name name, boolean value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, byte[] value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, char value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, double value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, float value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, int value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, long value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, Constant value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, Datetime value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, Name value)	Set the element of this request having the specified name to the specified value.
void	set(Name name, String value)	Set the element of this request having the specified name to the specified value.
void	set(String name, boolean value)	Deprecated. Use set(Name, boolean) instead.
void	set(String name, char value)	Deprecated. Use set(Name, char) instead.
void	set(String name, double value)	Deprecated. Use set(Name, double) instead.
void	set(String name, float value)	Deprecated. Use set(Name, float) instead.
void	set(String name, int value)	Deprecated. Use set(Name, int) instead.
void	set(String name, long value)	Deprecated. Use set(Name, long) instead.
void	set(String name, Constant value)	Deprecated. Use set(Name, Constant) instead.
void	set(String name, Datetime value)	Deprecated. Use set(Name, Datetime) instead.
void	set(String name, Name value)	Deprecated. Use set(Name, Name) instead.
void	set(String name, String value)	Deprecated. Use set(Name, String) instead.

Method Details

operation

Operation operation()

Return the Operation this Request is intended to invoke on the associated Service.

asElement

Element asElement()

Return the contents of this Request as an element.

hasElement

boolean hasElement(Name name)

Return true if this request contains the element having the specified name false otherwise

same as calling asElement(). hasElement(Name)

hasElement

@Deprecated
boolean hasElement(String name)

Deprecated.

Use hasElement(Name) instead.

Return true if this request contains the element having the specified name false otherwise

same as calling asElement(). hasElement(String)

getElement

Element getElement(Name name)

Return the modifiable element of this request having the specified name creating it if doesn't exist already.

same as calling asElement(). getElement(Name)

getElement

@Deprecated
Element getElement(String name)

Deprecated.

Use getElement(Name) instead.

Return the modifiable element of this request having the specified name creating it if doesn't exist already.

same as calling asElement(). getElement(String)

getRequestId

String getRequestId()

Returns request id if one exists, otherwise, null.

If there are issues with this request, the request id can be reported to Bloomberg for troubleshooting purposes.

Note that request id is not the same as correlation id and should not be used for correlation purposes.

append

void append(Name name,
 boolean value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(boolean)

append

@Deprecated
void append(String name,
 boolean value)

Deprecated.

Use append(Name, boolean) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(boolean)

append

@Deprecated
void append(Name name,
 byte[] value)

Deprecated.

Arrays of byte arrays are not supported. This method will always throw an * UnsupportedOperationException. See Element.appendValue(byte[])

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(byte[])

Throws:

UnsupportedOperationException - in all cases, since arrays of byte arrays are not supported.

append

@Deprecated
void append(String name,
 byte[] value)

Deprecated.

Arrays of byte arrays are not supported. This method will always throw an UnsupportedOperationException. See Element.appendValue(byte[])

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(byte[])

Throws:

UnsupportedOperationException - in all cases, since arrays of byte arrays are not supported.

append

void append(Name name,
 char value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(char)

append

@Deprecated
void append(String name,
 char value)

Deprecated.

Use append(Name, char) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(char)

append

void append(Name name,
 int value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(int)

append

@Deprecated
void append(String name,
 int value)

Deprecated.

Use append(Name, int) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(int)

append

void append(Name name,
 long value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(long)

append

@Deprecated
void append(String name,
 long value)

Deprecated.

Use append(Name, long) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(long)

append

void append(Name name,
 double value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(double)

append

@Deprecated
void append(String name,
 double value)

Deprecated.

Use append(Name, double) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(double)

append

void append(Name name,
 float value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). getElement(Name)

append

@Deprecated
void append(String name,
 float value)

Deprecated.

Use append(Name, float) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(float)

append

void append(Name name,
 Datetime value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(Datetime)

append

@Deprecated
void append(String name,
 Datetime value)

Deprecated.

Use append(Name, Datetime) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(Datetime)

append

void append(Name name,
 Constant value)

Append the specified value to the named array element of this request

same as calling asElement().Element.getElement(Name). Element.appendValue(Constant)

append

@Deprecated
void append(String name,
 Constant value)

Deprecated.

Use append(Name, Constant) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(Constant)

append

void append(Name name,
 Name value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(Name)

append

@Deprecated
void append(String name,
 Name value)

Deprecated.

Use append(Name, Name) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(Name)

append

void append(Name name,
 String value)

Append the specified value to the named array element of this request

same as calling asElement(). getElement(Name). appendValue(String)

append

@Deprecated
void append(String name,
 String value)

Deprecated.

Use append(Name, String) instead.

Append the specified value to the named array element of this request

same as calling asElement(). getElement(String). appendValue(String)

set

void set(Name name,
 boolean value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, boolean)

set

@Deprecated
void set(String name,
 boolean value)

Deprecated.

Use set(Name, boolean) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, boolean)

set

void set(Name name,
 char value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, char)

set

@Deprecated
void set(String name,
 char value)

Deprecated.

Use set(Name, char) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, char)

set

void set(Name name,
 int value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, int)

set

@Deprecated
void set(String name,
 int value)

Deprecated.

Use set(Name, int) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, int)

set

void set(Name name,
 long value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, long)

set

@Deprecated
void set(String name,
 long value)

Deprecated.

Use set(Name, long) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, long)

set

void set(Name name,
 double value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, double)

set

@Deprecated
void set(String name,
 double value)

Deprecated.

Use set(Name, double) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, double)

set

void set(Name name,
 float value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, float)

set

@Deprecated
void set(String name,
 float value)

Deprecated.

Use set(Name, float) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, float)

set

void set(Name name,
 Datetime value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, Datetime)

set

@Deprecated
void set(String name,
 Datetime value)

Deprecated.

Use set(Name, Datetime) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, Datetime)

set

void set(Name name,
 Constant value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, Constant)

set

@Deprecated
void set(String name,
 Constant value)

Deprecated.

Use set(Name, Constant) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, Constant)

set

void set(Name name,
 Name value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, Name)

set

@Deprecated
void set(String name,
 Name value)

Deprecated.

Use set(Name, Name) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, Name)

set

void set(Name name,
 String value)

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(Name, String)

set

@Deprecated
void set(String name,
 String value)

Deprecated.

Use set(Name, String) instead.

Set the element of this request having the specified name to the specified value.

same as calling asElement(). setElement(String, String)

set

void set(Name name,
 byte[] value)

Set the element of this request having the specified name to the specified value.

print

void print(OutputStream output)
    throws IOException

Prints the contents of this message to the specified OutputStream.

Throws:

IOException

print

void print(Writer writer)
    throws IOException

Prints the contents of this message to the specified Writer.

Throws:

IOException