org.omg.CORBA

Class Request

public abstract class Request extends Object

An object, containing the information, needed to invoke the method of the local or remote CORBA object. The Request is used in Dynamic Invocation Interface (DII) which allows dynamic creation of requests.

Method Summary
abstract Any	add_inout_arg() Add the input/output parameter that passes value both to and from the method being invoked.
abstract Any	add_in_arg() Add the named input parameter that passes value to the method being invoked.
abstract Any	add_named_inout_arg(String name) Add the named input/output parameter that passes value both to and from the method being invoked.
abstract Any	add_named_in_arg(String name) Add the named input parameter that passes value to the method being invoked.
abstract Any	add_named_out_arg(String name) Add the named output parameter that passes value from the method being invoked.
abstract Any	add_out_arg() Add the output parameter that passes value from the method being invoked.
abstract NVList	arguments() Return the list of all previously added parameters.
abstract ContextList	contexts() Get the context list object for this request.
abstract Context	ctx() Get the context, previously set using {@link #ctx(Context)}.
abstract void	ctx(Context a_context) Set the context that shuld be later returned by {@link #ctx()}.
abstract Environment	env() Returns the container, eclosing an exception that the invoked method has thrown.
abstract ExceptionList	exceptions() List the exceptions that may be thrown by the CORBA object method being invoked.
abstract void	get_response() Allow to access the response that has been previously sent using {@link #send_deferred()}.
abstract void	invoke() Submit the request, suspending the current thread until the answer is received.
abstract String	operation() Get the name of the method being invoked.
abstract boolean	poll_response() Check if the response is received to the request that was previously send using {@link #send_deferred()}.
abstract NamedValue	result() Get the value, returned by the method, together with its name.
abstract Any	return_value() Get the value, returned by the method.
abstract void	send_deferred() Send a request without suspending the current thread.
abstract void	send_oneway() Send a request and forget about it, not waiting for a response.
abstract void	set_return_type(TypeCode returns) Set the return type.
abstract Object	target() Return the CORBA object on that the method would be invoked.

Method Detail

add_inout_arg

public abstract Any add_inout_arg()

Add the input/output parameter that passes value both to and from the method being invoked. This is similar to the "passing by reference" conception. The created parameter is returned allowing to set the value.

Returns: the created parameter.

add_in_arg

public abstract Any add_in_arg()

Add the named input parameter that passes value to the method being invoked. This is similar to the "passing by value" conception. The created parameter is returned allowing to set the value.

Returns: the created parameter.

add_named_inout_arg

public abstract Any add_named_inout_arg(String name)

Add the named input/output parameter that passes value both to and from the method being invoked. This is similar to the "passing by reference" conception. The created parameter is returned allowing to set the value.

Parameters: name the parameter name.

Returns: the created parameter.

add_named_in_arg

public abstract Any add_named_in_arg(String name)

Add the named input parameter that passes value to the method being invoked. This is similar to the "passing by value" conception. The created parameter is returned allowing to set the value.

Parameters: name the parameter name.

Returns: the created parameter.

add_named_out_arg

public abstract Any add_named_out_arg(String name)

Add the named output parameter that passes value from the method being invoked. Differently from the java language, the CORBA IDL method can return multiple values. The created parameter is returned allowing to set the value.

Parameters: name the parameter name.

Returns: the created parameter.

add_out_arg

public abstract Any add_out_arg()

Add the output parameter that passes value from the method being invoked. Differently from the java language, the CORBA IDL method can return multiple values. The created parameter is returned allowing to set the value.

Returns: the created parameter.

arguments

public abstract NVList arguments()

Return the list of all previously added parameters.

Returns: the list of parameters.

contexts

public abstract ContextList contexts()

Get the context list object for this request.

Returns: a list of strings that must be resolved and sent with the invocation.

ctx

public abstract Context ctx()

Get the context, previously set using {@link #ctx(Context)}. The context contains the details about this request.

ctx

public abstract void ctx(Context a_context)

Set the context that shuld be later returned by {@link #ctx()}. This context contains the details about this request.

Parameters: a_context a context to set.

env

public abstract Environment env()

Returns the container, eclosing an exception that the invoked method has thrown.

Returns: the Environment object, containng the exception.

exceptions

public abstract ExceptionList exceptions()

List the exceptions that may be thrown by the CORBA object method being invoked.

Returns: the list of exceptions.

get_response

public abstract void get_response()

Allow to access the response that has been previously sent using {@link #send_deferred()}.

Throws: WrongTransaction if the transaction scope mismatches.

invoke

public abstract void invoke()

Submit the request, suspending the current thread until the answer is received.

operation

public abstract String operation()

Get the name of the method being invoked.

Returns: the name of the method being invoked.

poll_response

public abstract boolean poll_response()

Check if the response is received to the request that was previously send using {@link #send_deferred()}.

Returns: true if the response has been already received, false otherwise.

result

public abstract NamedValue result()

Get the value, returned by the method, together with its name.

Returns: the value, returned by the method.

return_value

public abstract Any return_value()

Get the value, returned by the method.

Returns: the value, returned by the method.

send_deferred

public abstract void send_deferred()

Send a request without suspending the current thread. Allow later check of the request status by {@link #poll_response()} and retrieving the results by {@link #get_response()}.

send_oneway

public abstract void send_oneway()

Send a request and forget about it, not waiting for a response. This can be done also for methods that normally are expected to return some values.

set_return_type

public abstract void set_return_type(TypeCode returns)

Set the return type.

Parameters: returns the type of the value, returned in response to this request.

target

public abstract Object target()

Return the CORBA object on that the method would be invoked.

Returns: the invocation target.