org.omg.CORBA
package that are used with the interface repository.
public interface AliasDef extends org.omg.CORBA.TypedefDefThe interface is used to represent an alias for a typedef that is stored in the Interface Repository. This interface provides methods for setting and obtaining the IDLType of the original typedef. For more information, see the TypedefDef interface.
Helper and Holder versions of this class are also provided.
This method sets the IDLType of this object.
Parameter | Description |
---|---|
original_type_def | The IDLType of this object. |
public org.omg.CORBA.IDLType original_type_def()
This method returns the IDLType of the original typedef for which this object is an alias.
ArrayDef
public interface ArrayDef extends org.omg.CORBA.IDLType
The interface is used to represent an array that is stored in the Interface Repository. This interface provides methods for setting and obtaining the type of elements in the array as well as the length of the array.
Helper and Holder versions of this class are also provided.
public void element_type_def(org.omg.CORBA.IDLType element_type_def)This method sets the IDLType of the elements stored in the array.
Parameter | Description |
---|---|
original_type_def | The IDLType of the elements in the array. |
public org.omg.CORBA.IDLType element_type_def()
This method returns the IDLType of the elements stored in this array.
public void length(int length)
This method sets the number of elements in the array.
Parameter | Description |
---|---|
length | The number of elements in the array. |
AttributeDef
public interface AttributeDef extends org.omg.CORBA.Contained
The interface is used to represent an interface attribute that is stored in the Interface Repository. This interface provides methods for setting and obtaining the attribute's mode, type and typedef.
Helper and Holder versions of this class are also provided.
public void type_def(org.omg.CORBA.IDLType type_def)This method sets the IDLType for which this object.
Parameter | Description |
---|---|
type_def | The IDLType of this object. |
public org.omg.CORBA.IDLType type_def()
This method returns this object's IDLType.
AttributeDescription
public class AttributeDescription
The AttributeDescription class describes an attribute that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public AttributeDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.TypeCode type,
org.omg.CORBA.AttributeMode mode)This method constructs an AttributeDescription, using the supplied parameters.
AttributeMode
public class AttributeMode
The class is used to represent the mode of an attribute; either read-only or normal (read-write).
Helper and Holder versions of this class are also provided.
Constant | Represents |
---|---|
_ATTR_NORMAL | A read-write attribute. |
_ATTR_READONLY | A read-only attribute. |
ATTR_NORMAL | An attribute definition as Normal. |
ATTR_READONLY | An attribute definition as read-only. |
public interface ConstantDef extends org.omg.CORBA.ContainedThe interface is used to represent a constant definition that is stored in the interface repository. This interface provides methods for setting and obtaining the constant's type, value and typedef. Helper and Holder versions of this class are also provided. This method returns the TypeCode representing the object's type.
public org.omg.CORBA.IDLType type_def()This method returns this object's IDLType.
public void type_def(org.omg.CORBA.IDLType type_def)This method sets the IDLType of the original typedef for this object.
Parameter | Description |
---|---|
type_def | The IDLType of this object. |
public org.omg.CORBA.Any value()
This method returns an Any object representing this object's value.
public void value(org.omg.CORBA.Any value)
This method sets the value for this constant.
Parameter | Description |
---|---|
value | An Any object that represents this object's value. |
ConstantDescription
public class ConstantDescription
The ConstantDescription class describes a constant that is stored in the interface repository.
Variables
public ConstantDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.TypeCode type,
org.omg.CORBA.Any value)This method constructs an ConstantDescription, using the supplied parameters.
Contained
public interface Contained extends org.omg.CORBA.IRObject
The interface is used to represent Interface Repository objects that are, themselves, contained within another Interface Repository object. This interface provides methods for:
IDL Definition
interface Contained : CORBA::IRObject {
readonly attribute CORBA::ScopedName absolute_name;
readonly attribute CORBA::Repository containing_repository;
readonly attribute CORBA::Container defined_in;
CORBA::Contained::Description describe();
struct Description {
CORBA::DefinitionKind kind;
any value;
};
attribute CORBA::RepositoryId id;
void move(
in CORBA::Container new_container,
in CORBA::Identifier new_name,
in CORBA::VersionSpec new_version
);
attribute CORBA::Identifier name;
attribute CORBA::VersionSpec version;
};
Methods
public String absolute_name()
This method returns this object's absolute name.
public org.omg.CORBA.Repository containing_repository()
This method returns the repository that contains this object.
public org.omg.CORBA.Container defined_in()
This method returns the Container where this object is defined.
public org.omg.CORBA.ContainedPackage.Description describe()
This method returns this object's description.
public String id()
This method returns this object's repository identifier.
public void id(String id)
This method sets the repository identification that uniquely identifies this object.
Parameter | Description |
---|---|
id | The repository identifier for this object. |
public string name()
This method returns this object's name.
public void name(String name)
This method sets the name for this object.
Parameter | Description |
---|---|
name | The object's name. |
public org.omg.CORBA.VersionSpec version()
This method returns this object's version.
public void version(org.omg.CORBA.VersionSpec version)
This method sets the version for this object.
Parameter | Description |
---|---|
version | The object's version. |
public void move(org.omg.CORBA.Container new_container,
String new_name,
org.omg.CORBA.VersionSpec new_version)This method moves this object to another container.
Parameter | Description |
---|---|
new_container | The Container to which the object is to be moved. |
new_name | The new name for the object. |
new_version | The new version specification for the object. |
ContainedPackage.Description
public class Description
This class provides a generic description for items in the interface repository that are derived from the Contained interface.
Helper and Holder versions of this class are also provided.
| The kind of the item. |
| The value of the item. |
public Description(org.omg.CORBA.DefinitionKind kind,
org.omg.CORBA.Any value)This method constructs an Description, using the supplied parameters.
Parameter | Description |
---|---|
kind | This item's kind. See DefinitionKind for more information. |
value | An Any object that represents the value for this item. |
Container
public interface Container extends org.omg.CORBA.IRObject
The Container interface is used to create a containment hierarchy in the Interface Repository. A Container object holds object definitions derived from the Contained class. All object definitions derived from the Container class, with the exception of the Repository class, also inherit from the Contained class.
Helper and Holder versions of this class are also provided.
IDL Definition
interface Container : CORBA::IRObject {
CORBA::AliasDef create_alias(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::IDLType original_type
);
CORBA::ConstantDef create_constant(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::IDLType type,
in any value
);
CORBA::EnumDef create_enum(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::EnumMemberSeq members
);
CORBA::EstructDef create_estruct(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::EstructDef base,
in CORBA::StructMemberSeq members
);
CORBA::ExceptionDef create_exception(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::StructMemberSeq members
);
CORBA::InterfaceDef create_interface(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::InterfaceDefSeq base_interfaces
);
CORBA::ModuleDef create_module(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version
);
CORBA::StructDef create_struct(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::StructMemberSeq members
);
CORBA::UnionDef create_union(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::IDLType discriminator_type,
in CORBA::UnionMemberSeq members
);
CORBA::ContainedSeq contents(
in CORBA::DefinitionKind limit_type,
in boolean exclude_inherited
);
CORBA::Contained lookup(
in CORBA::ScopedName search_name
);
CORBA::ContainedSeq lookup_name(
in CORBA::Identifier search_name,
in long levels_to_search,
in CORBA::DefinitionKind limit_type,
in boolean exclude_inherited
);
struct Description {
CORBA::Contained contained_object;
CORBA::DefinitionKind kind;
any value;
};
typedef sequence <CORBA::Container::Description> DescriptionSeq;
CORBA::Container::DescriptionSeq describe_contents(
in CORBA::DefinitionKind limit_type,
in boolean exclude_inherited,
in long max_returned_objs
);
CORBA::ContainedSeq private_lookup(
in CORBA::Identifier search_name,
in long levels_to_search,
in CORBA::DefinitionKind limit_type,
in boolean exclude_inherited,
in long max_returned_objs
);
void private_add_name(
in CORBA::Contained cont
);
void private_remove_name(
in CORBA::Contained cont
);
CORBA::InterfaceDef forward_declare_interface(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version
);
};
Methods
public org.omg.CORBA.Contained[] contents(
org.omg.CORBA.DefinitionKind limit_type,
boolean exclude_inherited)
This method sets the repository identification that uniquely identifies this object.
Parameter | Description |
---|---|
limit_type | The interface object types to be returned. |
exclude_inherited | If set to true, inherited objects will not be returned. |
public AliasDef create_alias (String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.IDLType original_type)
This method creates a AliasDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The alias' repository id. |
name | The alias' name. |
version | The alias' version. |
original_type | The IDL type of the original object for which this is an alias. |
public org.omg.CORBA.ConstantDef create_constant(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.IDLType type,
org.omg.CORBA.Any value)
This method creates a ConstantDef object in this Container with the specified attributes and returns a reference to the newly created object.
public org.omg.CORBA.EnumDef create_enum(String id,
String name,
org.omg.CORBA.VersionSpec version,
String members[])
This method creates an EnumDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The enumeration's repository id. |
name | The enumeration's name. |
version | The enumeration's version. |
members | A list of the enumeration's values. |
public org.omg.CORBA.EstructDef create_estruct(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.EstructDef base,
org.omg.CORBA.StructMember members[])
This method creates an EstructDef object in this Container with the specified attributes and returns a reference to the newly created object.
public org.omg.CORBA.ExceptionDef create_exception(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.StructMember members[])
This method creates an ExceptionDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The exception's repository id. |
name | The exception's name. |
version | The exception's version. |
members | A list of all the types of the members of the exception, if any. |
public org.omg.CORBA.InterfaceDef create_interface(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.InterfaceDef base_interfaces)
This method creates an InterfaceDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The interface's repository id. |
name | The interface's name. |
version | The interface's version. |
base_interfaces | A list of all interfaces from which this interface inherits. |
public org.omg.CORBA.ModuleDef create_module(String id,
String name,
org.omg.CORBA.VersionSpec version)
This method creates a ModuleDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The module's repository id. |
name | The module's name. |
version | The module's version. |
public org.omg.CORBA.StructDef create_struct(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.StructMember members[])
This method creates a StructDef object in this Container with the specified attributes and returns a reference to the newly created object.
Parameter | Description |
---|---|
id | The structure's repository id. |
name | The structure's name. |
version | The structure's version. |
members | The values for the structure's fields. |
public org.omg.CORBA.UnionDef create_union(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.IDLType discriminator_type,
org.omg.CORBA.UnionMember members[])
This method creates a UnionDef object in this Container with the specified attributes and returns a reference to the newly created object.
public org.omg.CORBA.ContainerPackage.Description[] describe_contents(
org.omg.CORBA.DefinitionKind limit_type,
boolean exclude_inherited,
int max_returned_objs)
This method returns a description for all definitions directly contained by, or inherited into this container.
public org.omg.CORBA.Contained lookup(String search_name)
This method locates a definition relative to this container, given a scoped name. An absolute scoped name, one beginning with "::", may be specified to locate a definition within the enclosing repository. If no object is found, a NULL value is returned.
Parameter | Description |
---|---|
search_name | The name of the object to be located. |
public org.omg.CORBA.Contained[] lookup_name(String search_name,
int levels_to_search,
org.omg.CORBA.DefinitionKind limit_type,
boolean exclude_inherited)
This method locates an object by name within a particular object. The search can be constrained by the number of levels in the hierarchy to be searched, the type of object, and whether or not inherited objects should be returned.
ContainerPackage.Description
public class Description
This class provides a generic description for items in the interface repository that are derived from the Contained interface.
Helper and Holder versions of this class are also provided.
public org.omg.CORBA.Contained contained_object | The contained item. |
public org.omg.CORBA.DefinitionKind kind | The kind of the item. |
public org.omg.CORBA.Any value | The value of the item. |
public Description(org.omg.CORBA.Contained contained_object,
org.omg.CORBA.DefinitionKind kind,
org.omg.CORBA.Any value)This method constructs an Description, using the supplied parameters.
Parameter | Description |
---|---|
contained_object | The contained item. |
kind | This item's kind. See "DefinitionKind" for more information. |
value | An Any object that represents the value for this item. |
DefinitionKind
public class DefinitionKind
The DefinitionKind class contains the constants that define the possible types of interface repository objects. There are a set of integer constants, prefixed with dk_
, that correspond to all the possible definition kinds. For example, the DefinitionKind code for float is dk_float
.
Helper and Holder versions of this class are also provided.
public interface EnumDef extends org.omg.CORBA.TypeDefThe interface is used to represent an enumeration that is stored in the Interface Repository. This interface provides methods for setting and retrieving the enumeration's list of members. Helper and Holder versions of this class are also provided. This method returns the enumeration's list of members.
public void members(String members[])This method sets the enumeration's list of members.
Parameter | Description |
---|---|
members | The list of members. |
EstructDef
public interface EstructDef extends org.omg.CORBA.TypeDef
The interface is used to represent an extensible structure that is stored in the Interface Repository. This interface provides methods for setting and retrieving the structure's list of members and base class definition. Extensible structures are used to represent classes that are passed as parameters for an operation request.
Helper and Holder versions of this class are also provided.
public void base_def(org.omg.CORBA.EstructDef base_def)This method sets the base class for this EstructDef.
Parameter | Description |
---|---|
base_def | An EstructDef that represents the base class. |
public org.omg.CORBA.EstructDef base_def()
This method returns the EstructDef that represents the base class for this Estruct.
public org.omg.CORBA.StructMember[] members()
This method returns the list of members for this EstructDef.
public void members(StructMember members[])
This method sets the list of members for this EstructDef.
Parameter | Description |
---|---|
members | The list of members for this EstructDef. |
public void members(String members[])
This method sets the enumeration's list of members.
Parameter | Description |
---|---|
members | The list of members. |
ExceptionDef
public interface ExceptionDef extends org.omg.CORBA.Contained
The interface is used to represent an exception that is stored in the Interface Repository. This interface provides methods for setting and retrieving the exception's list of members as well as a method for retrieving the exception's TypeCode.
Helper and Holder versions of this class are also provided.
public void members(org.omg.CORBA.StructMember members[])This method sets the exception's list of members.
Parameter | Description |
---|---|
members | The list of members. |
public org.omg.CORBA.TypeCode type()
This method returns the TypeCode that represents this exception's type.
ExceptionDescription
public class ExceptionDescription
The ExceptionDescription class describes a exception that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public ExceptionDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.TypeCode type,
org.omg.CORBA.Any value)This method constructs an ExceptionDescription, using the supplied parameters.
IDLType
public interface IDLType extends org.omg.CORBA.IRObject
The IDLType interface is used to represent the TypeCode associated with an interface repository object. The TypeCode uniquely identifies the object's type.
Helper and Holder versions of this class are also provided.
IDL Definition
interface IDLType : CORBA::IRObject {
readonly attribute TypeCode type;
};
Methods
public interface InterfaceDef extends org.omg.CORBA.Container,
org.omg.CORBA.Contained,
org.omg.CORBA.IDLTypeThe interface is used to represent an object implementation interface that is stored in the Interface Repository. This interface provides methods for setting and retrieving the base interface as well as creating attributes, operations and an interface description. Helper and Holder versions of this class are also provided.
IDL Definition
interface InterfaceDef : CORBA::Container,
CORBA::Contained,
CORBA::IDLType {
attribute CORBA::InterfaceDefSeq base_interfaces;
struct FullInterfaceDescription {
CORBA::Identifier name;
CORBA::RepositoryId id;
CORBA::RepositoryId defined_in;
CORBA::VersionSpec version;
CORBA::OpDescriptionSeq operations;
CORBA::AttrDescriptionSeq attributes;
CORBA::RepositoryIdSeq base_interfaces;
TypeCode type;
};
CORBA::AttributeDef create_attribute(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::IDLType type,
in CORBA::AttributeMode mode
);
CORBA::OperationDef create_operation(
in CORBA::RepositoryId id,
in CORBA::Identifier name,
in CORBA::VersionSpec version,
in CORBA::IDLType result,
in CORBA::OperationMode mode,
in CORBA::ParDescriptionSeq params,
in CORBA::ExceptionDefSeq exceptions,
in CORBA::ContextIdSeq contexts
CORBA::InterfaceDef::FullInterfaceDescription describe_interface();
boolean is_a(in CORBA::RepositoryId interface_id);
);
};
Methods
public org.omg.CORBA.InterfaceDef[] base_interfaces()
This method returns the base interface list for this object.
public void base_interfaces(org.omg.CORBA.InterfaceDef
base_interfaces[])
This method sets the base interface list for this object.
Parameter | Description |
---|---|
base_interfaces | The list of base interfaces to be set. |
public org.omg.CORBA.AttributeDef create_attribute(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.IDLType type,
org.omg.CORBA.AttributeMode mode)
This method adds an attribute to an interface definition.
public org.omg.CORBA.OperationDef create_operation(String id,
String name,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.IDLType result,
org.omg.CORBA.OperationMode mode,
org.omg.CORBA.ParameterDescription[] params,
org.omg.CORBA.ExceptionDef[] exceptions,
String[] contexts)
This method adds an operation to an interface definition.
public org.omg.CORBA.InterfaceDef.FullInterfaceDescription
describe_interface()
This method returns an interface description for this object.
public boolean is_a(String interface_id)
This method returns true if this object has the specified interface identifier.
Parameter | Description |
---|---|
interface_id | The interface identifier to compare with this object. |
InterfaceDefPackage.FullInterfaceDescription
public class FullInterfaceDescription
This class provides a description of an interface that is stored in the interface repository.
Variables
public FullInterfaceDescription(String name, String id, String defined_in,This method constructs an FullInterfaceDescription, using the supplied parameters.
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.OperationDescription[] operations,
org.omg.CORBA.AttributeDescription[] attributes,
org.omg.CORBA.TypeCode type)
InterfaceDescription
public class InterfaceDescription
The InterfaceDescription class describes a constant that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public InterfaceDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
String[] base_interfaces)This method constructs an InterfaceDescription, using the supplied parameters.
IRObject
public interface IRObject extends org.omg.CORBA.Object
The IRObject interface offers a generic interface to any object stored in the Interface Repository.
Helper and Holder versions of this class are also provided.
IDL Definition
interface IRObject {
readonly attribute CORBA::DefinitionKind def_kind;
attribute string comment;
void destroy();
};
Methods
public org.omg.CORBA.DefinitionKind def_kind()
This method returns the type of this IRObject. For a list of defined types, see "TCKind."
public void destroy()
This method deletes this IRObject from the Interface Repository.
ModuleDef
public interface ModuleDef extends org.omg.CORBA.Container,
org.omg.CORBA.Contained
The interface is used to represent an IDL module in the interface repository.
Helper and Holder versions of this class are also provided.
ModuleDescription
public class ModuleDescription
The ModuleDescription class describes a constant that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public ModuleDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version)This method constructs an ModuleDescription, using the supplied parameters.
Parameter | Description |
---|---|
name | The name of this interface. |
id | The repository id for this interface. |
defined_in | The module or interface in which this interface is defined. |
version | The object's version. |
OperationDef
public interface OperationDef extends org.omg.CORBA.Contained
The interface is used to represent an interface operation that is stored in the Interface Repository. This interface provides methods for setting and retrieving the operation's contexts, mode, parameters, and result value. A method is also provided for retrieving a list of exceptions that may be raised by this operation.
Helper and Holder versions of this class are also provided.
public String[] contexts()
public void contexts(String[] contexts)This method sets this operation's list of context.
Parameter | Description |
---|---|
contexts | The list of contexts. |
public org.omg.CORBA.ExceptionDef[] exceptions()
This method returns a list of exceptions that may be raised by this operation.
public void exceptions(org.omg.CORBA.ExceptionDef[] exceptions)
This method sets the list of exceptions that may be raised by this operation.
Parameter | Description |
---|---|
exceptions | The list of exceptions. |
public org.omg.CORBA.OperationMode mode()
This method returns the mode of this operation.
public void mode(org.omg.CORBA.OperationMode mode)
This method sets the mode of this operation.
Parameter | Description |
---|---|
mode | The mode to be set. See OperationMode for more details. |
public org.omg.CORBA.ParameterDescription[] params()
This method returns a description of the parameters for this operation.
public void params(org.omg.CORBA.ParameterDescription[] params)
This method sets the parameter description for this operation.
Parameter | Description |
---|---|
params | The description of the parameters. |
public org.omg.CORBA.TypeCode result()
This method returns the TypeCode of the result returned by this operation.
public org.omg.CORBA.IDLType result_def()
This method returns the IDL type of this operation's return value.
public void result_def(org.omg.CORBA.IDLType result_def)
This method sets the IDL type for this operation's return value.
Parameter | Description |
---|---|
result_def | The IDL type to set for the return value. |
OperationDescription
public class OperationDescription
The OperationDescription class describes a constant that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public OperationDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.TypeCode result,
org.omg.CORBA.OperationMode mode,
String[] contexts,
org.omg.CORBA.ParameterDescriptions parameters,
org.omg.CORBA.ExceptionDescription[] exceptions)This method constructs an OperationDescription, using the supplied parameters.
OperationMode
public class OperationMode
The class is used to represent the mode of an operation; either oneway or normal. Oneway operations are those for which the client application does not expect a response. Normal requests involve a response being sent to the client by the object implementation that contains the results of the request.
Helper and Holder versions of this class are also provided.
Constant | Represents |
---|---|
_OP_NORMAL | A normal operation. |
_OP_ONEWAY | A one-way operation. |
public class ParameterDescriptionThe ParameterDescription class describes a parameter for an operation that is stored in the interface repository. Helper and Holder versions of this class are also provided.
public ParameterDescription(String name,
org.omg.CORBA.TypeCode type,
org.omg.CORBA.IDLType type_def,
org.omg.CORBA.ParameterMode mode)This method constructs an ParameterDescription, using the supplied parameters.
Parameter | Description |
---|---|
name | The name of the parameter. |
type | The type of the parameter. |
type_def | The IDL type of the parameter. |
mode | The mode of the parameter. |
ParameterMode
public class ParameterMode
The class is used to represent the mode of a parameter. Parameters may be used in one of the following three ways:
Constant | Represents |
---|---|
_PARAM_IN | A IN parameter. |
_OP_PARAM_OUT | An OUT parameter. |
_OP_PARAM_INOUT | An INOUT parameter. |
public interface PrimitiveDef extends org.omg.CORBA.IDLTypeThe interface is used to represent an primitive (such as an int or a long) that is stored in the Interface Repository. This interface provides a methods for retrieving the kind of primitive that is being represented. Helper and Holder versions of this class are also provided. This method returns the kind of primitive represented by this object.
public class PrimitiveKindThe PrimitiveKind class contains the constants that define the possible types of primitives interface repository objects. There are a set of integer constants, prefixed with pk_, that correspond to all the possible kinds of primitives. Helper and Holder versions of this class are also provided. This method returns an integral value representing the constant.
Repository
public interface Repository extends org.omg.CORBA.Container
The Repository provides an interface to the Interface Repository, which is used to contain the definitions of objects that are available to clients. The Repository interface provides methods for storing and retrieving definitions.
Helper and Holder versions of this class are also provided.
public org.omg.CORBA.ArrayDef create_array(int length,
org.omg.CORBA.IDLType element_type)
Parameter | Description |
---|---|
length | The number of elements in the array. This value must be greater than zero. |
element_type | The IDL type of the elements contained in the array. |
A reference to the ArrayDef that is created is returned.
public org.omg.CORBA.SequenceDef create_sequence(int bound,
org.omg.CORBA.IDLType element_type)
This method creates an array definition in the repository with the specified bound and element type. A reference to the SequenceDef that is created is returned.
Parameter | Description |
---|---|
bound | The maximum length of the sequence. This value must be greater than zero. |
element_type | The IDL type of the elements contained in the sequence. |
public org.omg.CORBA.StringDef create_string(int bound)
This method creates an string definition in the repository with the specified bound. A reference to the StringDef that is created is returned.
Parameter | Description |
---|---|
bound | The maximum bounds of the string. This value must be greater than zero. |
public org.omg.CORBA.WstringDef create_wstring(int bound)
This method creates a Unicode string definition in the repository with the specified bound. A reference to the WstringDef that is created is returned.
Parameter | Description |
---|---|
bound | The maximum bounds of the string. This value must be greater than zero. |
public org.omg.CORBA.PrimitiveDef get_primitive(org.omg.CORBA.PrimitiveKind kind)
This method returns a
Parameter | Description |
---|---|
kind | The primitive's kind. |
PrimitiveDef object for the specified PrimitiveKind.
public Contained lookup_id(String search_id)
This method searches for an object in the interface repository that matches the specified search id. If a match is not found, a null value is returned.
Parameter | Description |
---|---|
search_id | The identifier to use for the search. |
SequenceDef
public interface SequenceDef extends org.omg.CORBA.IDLType
The interface is used to represent an sequence that is stored in the Interface Repository. This interface provides methods for setting and retrieving the sequence's bound and element type.
Helper and Holder versions of this class are also provided.
public int bound()
public void bound(int bound)This method sets the bound of the sequence.
Parameter | Description |
---|---|
members | The list of members. |
public org.omg.CORBA.TypeCode element_type()
This method returns a TypeCode representing the type of elements in this sequence.
public org.omg.CORBA.IDLType element_type_def()
This method returns the IDL type of the elements stored in this sequence.
public void element_type_def(org.omg.CORBA.IDLType element_type_def)
This method sets the IDL type for the elements stored in this sequence.
Parameter | Description |
---|---|
element_type_def | The IDL type to set. |
StringDef
public interface StringDef extends org.omg.CORBA.IDLType
The interface is used to represent a String that is stored in the Interface Repository. This interface provides methods for setting and retrieving the bounds of the string.
Helper and Holder versions of this class are also provided.
public void members(int bound)This method sets the bounds of the String.
Parameter | Description |
---|---|
members | The list of members. |
StructDef
public interface StructDef extends org.omg.CORBA.TypedefDef
The interface is used to represent a structure that is stored in the Interface Repository. This interface provides methods for setting and retrieving the structure's list of members.
Helper and Holder versions of this class are also provided.
public void members(org.omg.CORBA.StructMember[] members)This method sets the structure's list of members.
Parameter | Description |
---|---|
members | The list of members. |
TypedefDef
public interface TypedefDef extends org.omg.CORBA.Contained,
org.omg.CORBA.IDLType
This abstract interface represents a user-defined structure that is stored in the Interface Repository. The following interfaces all inherit from this interface:
TypeDescription
public class TypeDescription
The TypeDescription class describes a type for an operation that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
public TypeDescription(String name, String id, String defined_in,
org.omg.CORBA.VersionSpec version,
org.omg.CORBA.TypeCode type)This method constructs an TypeDescription, using the supplied parameters.
UnionDef
public interface UnionDef extends org.omg.CORBA.TypedefDef
The interface is used to represent an Union that is stored in the Interface Repository. This interface provides methods for setting and retrieving the union's list of members and discriminator type.
Helper and Holder versions of this class are also provided.
public org.omg.CORBA.TypeCode discriminator_type()
public org.omg.CORBAIDLType discriminator_type_def()This method returns the IDL type of the union's discriminator.
public void discriminator_type_def(
org.omg.CORBA.IDLType discriminator_type_def)This method sets the IDL type of the union's discriminator.
Parameter | Description |
---|---|
discriminator_type_def | The list of members. |
public org.omg.CORBA.UnionMember[] members()
This method returns the union's list of members.
public void members(org.omg.CORBA.UnionMembers[] members)
This method sets the union's list of members.
Parameter | Description |
---|---|
members | The list of members. |
UnionMember
public class UnionMember
The UnionMember class describes a union that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
label | The label for this union. |
name | The name of this union. |
type | The union's type. |
type_def | The union's IDL type code. |
public UnionMember()
public UnionMember(String name, org.omg.CORBA.Any label,
org.omg.CORBA.TypeCode type,
org.omg.CORBA.IDLType type_def)This method constructs an UnionMember, using the supplied parameters.
Parameter | Description |
---|---|
name | The name of this union. |
label | The label for this union. |
type | The union's type. |
type_def | The union's IDL type code. |
VersionSpec
public interface VersionSpec
The VersionSpec interface describes the version of an object that is stored in the interface repository.
Helper and Holder versions of this class are also provided.
major | The major version number. |
minor | The minor version number. |
public VersionSpec(short major, short minor)This method constructs an VersionSpec, using the supplied parameters.
Parameter | Description |
---|---|
major | The major version number. |
minor | The minor version number. |
WstringDef
public interface WstringDef extends org.omg.CORBA.IDLType
The interface is used to represent a Unicode string that is stored in the Interface Repository.
Helper and Holder versions of this class are also provided.
public void members(int bound)This method sets the bounds of the WString.
Parameter | Description |
---|---|
members | The list of members. |
Last Updated: 02/04/98 14:19:47
Any sample code included above is provided for your use on an "AS IS" basis, under the Netscape License Agreement - Terms of Use