OperationDef::describe

Overview The describe operation returns a structure containing information about a CORBA::OperationDef Interface Repository object.
Original interface OperationDef Interface
Exceptions CORBA::SystemException


Intended Usage

The inherited describe operation returns a structure (CORBA::Contained::Description) that contains information about a CORBA::OperationDef Interface Repository object. The CORBA::Contained::Description structure has two fields: kind (CORBA::DefinitionKind data type), and value (CORBA::Any data type).

The kind of definition described by the returned structure is provided using the kind field, and the value field is a CORBA::Any that contains the description that is specific to the kind of object described. When the describe operation is invoked on an operation (CORBA::OperationDef) object, the kind field is equal to CORBA::dk_Operation and the value field contains the CORBA::OperationDescription structure.

Syntax

  struct OperationDescription {
     Identifier name;
     RepositoryId id;
     RepositoryId defined_in;
     VersionSpec version;
     TypeCode result;
     OperationMode mode;
     ContextIdSeq contexts;
     ParDescriptionSeq parameters;
     ExcDescriptionSeq exceptions;
     };
     struct Description {
     DefinitionKind kind;
     any value;
     };
     Description describe ();  

Input parameters

None.

Return values

Description *
The returned value is a pointer to a CORBA::Contained::Description structure. The memory is owned by the caller and can be removed by invoking delete.

Example

  // C++
     // assume that 'this_operation' has already been initialized
     CORBA::OperationDef * this_operation;
 
     // retrieve a description of the operation
     CORBA::OperationDef::Description * returned_description; 
     returned_description = this_operation-> describe ();
 
     // retrieve the operation description from the returned description 
     // structure
     CORBA::OperationDescription * operation_description;
     operation_description = (CORBA::OperationDescription *) 
        returned_description value.value ();

Related reference
CORBA module



Searchable topic ID:   rcor_modop2
Last updated: Jun 21, 2007 8:07:48 PM CDT    WebSphere Business Integration Server Foundation, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.wasee.doc/info/ee/corba/ref/rcor_modop2.html

Library | Support | Terms of Use | Feedback