|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
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,
java.lang.String value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
boolean value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
byte[] value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
char value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
Constant value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
Datetime value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
double value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
float value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
int value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
long value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
Name value)
Append the specified value to the named array element of this request |
void |
append(java.lang.String name,
java.lang.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(java.lang.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(java.lang.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(java.io.OutputStream output)
Prints the contents of this message to the specified OutputStream. |
void |
print(java.io.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,
java.lang.String value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
boolean value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
char value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
Constant value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
Datetime value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
double value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
float value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
int value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
long value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
Name value)
Set the element of this request having the specified name to the specified value. |
void |
set(java.lang.String name,
java.lang.String value)
Set the element of this request having the specified name to the specified value. |
Method Detail |
---|
Operation operation()
Element asElement()
boolean hasElement(Name name)
same as calling asElement()
.
hasElement(Name)
boolean hasElement(java.lang.String name)
same as calling asElement()
.
hasElement(String)
Element getElement(Name name)
same as calling asElement()
.
getElement(Name)
Element getElement(java.lang.String name)
same as calling asElement()
.
getElement(String)
void append(Name name, boolean value)
same as calling asElement()
.
getElement(Name)
.
appendValue(boolean)
void append(java.lang.String name, boolean value)
same as calling asElement()
.
getElement(String)
.
appendValue(boolean)
void append(Name name, byte[] value)
same as calling asElement()
.
getElement(Name)
.
appendValue(byte[])
void append(java.lang.String name, byte[] value)
same as calling asElement()
.
getElement(String)
.
appendValue(byte[])
void append(Name name, char value)
same as calling asElement()
.
getElement(Name)
.
appendValue(char)
void append(java.lang.String name, char value)
same as calling asElement()
.
getElement(String)
.
appendValue(char)
void append(Name name, int value)
same as calling asElement()
.
getElement(Name)
.
appendValue(int)
void append(java.lang.String name, int value)
same as calling asElement()
.
getElement(String)
.
appendValue(int)
void append(Name name, long value)
same as calling asElement()
.
getElement(Name)
.
appendValue(long)
void append(java.lang.String name, long value)
same as calling asElement()
.
getElement(String)
.
appendValue(long)
void append(Name name, double value)
same as calling asElement()
.
getElement(Name)
.
appendValue(double)
void append(java.lang.String name, double value)
same as calling asElement()
.
getElement(String)
.
appendValue(double)
void append(Name name, float value)
same as calling asElement()
.
getElement(Name)
.
getElement(Name)
void append(java.lang.String name, float value)
same as calling asElement()
.
getElement(String)
.
appendValue(float)
void append(Name name, Datetime value)
same as calling asElement()
.
getElement(Name)
.
appendValue(Datetime)
void append(java.lang.String name, Datetime value)
same as calling asElement()
.
getElement(String)
.
appendValue(Datetime)
void append(Name name, Constant value)
same as calling asElement()
.Element.getElement(Name)
.
Element.appendValue(Constant)
void append(java.lang.String name, Constant value)
same as calling asElement()
.
getElement(String)
.
appendValue(Constant)
void append(Name name, Name value)
same as calling asElement()
.
getElement(Name)
.
appendValue(Name)
void append(java.lang.String name, Name value)
same as calling asElement()
.
getElement(String)
.
appendValue(Name)
void append(Name name, java.lang.String value)
same as calling asElement()
.
getElement(Name)
.
appendValue(String)
void append(java.lang.String name, java.lang.String value)
same as calling asElement()
.
getElement(String)
.
appendValue(String)
void set(Name name, boolean value)
same as calling asElement()
.
setElement(Name, boolean)
void set(java.lang.String name, boolean value)
same as calling asElement()
.
setElement(String, boolean)
void set(Name name, char value)
same as calling asElement()
.
setElement(Name, char)
void set(java.lang.String name, char value)
same as calling asElement()
.
setElement(String, char)
void set(Name name, int value)
same as calling asElement()
.
setElement(Name, int)
void set(java.lang.String name, int value)
same as calling asElement()
.
setElement(String, int)
void set(Name name, long value)
same as calling asElement()
.
setElement(Name, long)
void set(java.lang.String name, long value)
same as calling asElement()
.
setElement(String, long)
void set(Name name, double value)
same as calling asElement()
.
setElement(Name, double)
void set(java.lang.String name, double value)
same as calling asElement()
.
setElement(String, double)
void set(Name name, float value)
same as calling asElement()
.
setElement(Name, float)
void set(java.lang.String name, float value)
same as calling asElement()
.
setElement(String, float)
void set(Name name, Datetime value)
same as calling asElement()
.
setElement(Name, Datetime)
void set(java.lang.String name, Datetime value)
same as calling asElement()
.
setElement(String, Datetime)
void set(Name name, Constant value)
same as calling asElement()
.
setElement(Name, Constant)
void set(java.lang.String name, Constant value)
same as calling asElement()
.
setElement(String, Constant)
void set(Name name, Name value)
same as calling asElement()
.
setElement(Name, Name)
void set(java.lang.String name, Name value)
same as calling asElement()
.
setElement(String, Name)
void set(Name name, java.lang.String value)
same as calling asElement()
.
setElement(Name, String)
void set(java.lang.String name, java.lang.String value)
same as calling asElement()
.
setElement(String, String)
void set(Name name, byte[] value)
void print(java.io.OutputStream output) throws java.io.IOException
java.io.IOException
void print(java.io.Writer writer) throws java.io.IOException
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |