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().

Author:

Siva Somu (ssomu)

Method Summary

Modifier and Type	Method and 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) Append the specified value to the named array element of this request
void	append(Name name, char 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, 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, 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) Append the specified value to the named array element of this request
void	append(String name, byte[] value) Append the specified value to the named array element of this request
void	append(String name, char value) Append the specified value to the named array element of this request
void	append(String name, Constant value) Append the specified value to the named array element of this request
void	append(String name, Datetime value) Append the specified value to the named array element of this request
void	append(String name, double value) Append the specified value to the named array element of this request
void	append(String name, float value) Append the specified value to the named array element of this request
void	append(String name, int value) Append the specified value to the named array element of this request
void	append(String name, long value) Append the specified value to the named array element of this request
void	append(String name, Name value) Append the specified value to the named array element of this request
void	append(String name, String value) Append the specified value to the named array element of this request
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) Return the modifiable element of this request having the specified name creating it if doesn't exist already.
boolean	hasElement(Name name) Return true if this request contains the element having the specified name false otherwise
boolean	hasElement(String name) Return true if this request contains the element having the specified name false otherwise
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, 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, 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, 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) Set the element of this request having the specified name to the specified value.
void	set(String name, char value) Set the element of this request having the specified name to the specified value.
void	set(String name, Constant value) Set the element of this request having the specified name to the specified value.
void	set(String name, Datetime value) Set the element of this request having the specified name to the specified value.
void	set(String name, double value) Set the element of this request having the specified name to the specified value.
void	set(String name, float value) Set the element of this request having the specified name to the specified value.
void	set(String name, int value) Set the element of this request having the specified name to the specified value.
void	set(String name, long value) Set the element of this request having the specified name to the specified value.
void	set(String name, Name value) Set the element of this request having the specified name to the specified value.
void	set(String name, String value) Set the element of this request having the specified name to the specified value.

Method Detail

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

boolean hasElement(String name)

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

Element getElement(String name)

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

same as calling asElement(). getElement(String)

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

void append(String name,
            boolean value)

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

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

append

void append(Name name,
            byte[] value)

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

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

append

void append(String name,
            byte[] value)

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

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

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

void append(String name,
            char value)

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

void append(String name,
            int value)

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

void append(String name,
            long value)

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

void append(String name,
            double value)

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

void append(String name,
            float value)

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

void append(String name,
            Datetime value)

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

void append(String name,
            Constant value)

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

void append(String name,
            Name value)

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

void append(String name,
            String value)

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

void set(String name,
         boolean value)

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

void set(String name,
         char value)

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

void set(String name,
         int value)

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

void set(String name,
         long value)

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

void set(String name,
         double value)

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

void set(String name,
         float value)

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

void set(String name,
         Datetime value)

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

void set(String name,
         Constant value)

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

void set(String name,
         Name value)

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

void set(String name,
         String value)

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