org.omg.CORBA
Interface ContainerOperations

All Superinterfaces:

IRObjectOperations

All Known Subinterfaces:

AbstractInterfaceDef, AbstractInterfaceDefOperations, Container, ExceptionDef, ExceptionDefOperations, InterfaceDef, InterfaceDefOperations, LocalInterfaceDef, LocalInterfaceDefOperations, ModuleDef, ModuleDefOperations, Repository, RepositoryOperations, StructDef, StructDefOperations, UnionDef, UnionDefOperations, ValueDef, ValueDefOperations

public interface ContainerOperations
extends IRObjectOperations

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.

Method Summary

Contained[]	contents(DefinitionKind limit_type, boolean exclude_inherited) This method sets the repository identification that uniquely identifies this object.
AbstractInterfaceDef	create_abstract_interface(java.lang.String id, java.lang.String name, java.lang.String version, AbstractInterfaceDef[] base_interfaces) This method creates an AbstractInterfaceDef object in this Container with the specified attributes.
AliasDef	create_alias(java.lang.String id, java.lang.String name, java.lang.String version, IDLType original_type) This method creates an AliasDef object in this Container with the specified attributes
ConstantDef	create_constant(java.lang.String id, java.lang.String name, java.lang.String version, IDLType type, Any value) This method creates a ConstantDef object in this Container with the specified attributes
EnumDef	create_enum(java.lang.String id, java.lang.String name, java.lang.String version, java.lang.String[] members) This method creates an EnumDef object in this Container with the specified attributes
ExceptionDef	create_exception(java.lang.String id, java.lang.String name, java.lang.String version, StructMember[] members) This method creates an ExceptionDef object in this Container with the specified attributes
InterfaceDef	create_interface(java.lang.String id, java.lang.String name, java.lang.String version, InterfaceDef[] base_interfaces) This method creates a concrete InterfaceDef object in this Container with the specified attributes.Unlike an AbstractInterfaceDef, this interface can contain definitions of both abstract and concrete interfaces.
LocalInterfaceDef	create_local_interface(java.lang.String id, java.lang.String name, java.lang.String version, InterfaceDef[] base_interfaces)
ModuleDef	create_module(java.lang.String id, java.lang.String name, java.lang.String version) This method creates a ModuleDef object in this Container with the specified attributes
NativeDef	create_native(java.lang.String id, java.lang.String name, java.lang.String version) This method creates a NativeDef object in this Container with the specified attributes
StructDef	create_struct(java.lang.String id, java.lang.String name, java.lang.String version, StructMember[] members) This method creates a StructDef object in this Container with the specified attributes
UnionDef	create_union(java.lang.String id, java.lang.String name, java.lang.String version, IDLType discriminator_type, UnionMember[] members) This method creates a UnionDef object in this Container with the specified attributes
ValueBoxDef	create_value_box(java.lang.String id, java.lang.String name, java.lang.String version, IDLType original_type) This method creates a ValueBoxDef object in this Container with the specified attributes
ValueDef	create_value(java.lang.String id, java.lang.String name, java.lang.String version, boolean is_custom, boolean is_abstract, ValueDef base_value, boolean is_truncatable, ValueDef[] abstract_base_values, InterfaceDef[] supported_interfaces, Initializer[] initializers) This method creates a ValueDef object in this Container with the specified attributes
Description[]	describe_contents(DefinitionKind limit_type, boolean exclude_inherited, int max_returned_objs)
Contained[]	lookup_name(java.lang.String search_name, int levels_to_search, DefinitionKind limit_type, boolean exclude_inherited) This method locates an object by name within a particular object.
Contained	lookup(java.lang.String search_name) This method locates a definition relative to this container, given a scoped name.

Methods inherited from interface org.omg.CORBA.IRObjectOperations

def_kind, destroy

Method Detail

create_local_interface

LocalInterfaceDef create_local_interface(java.lang.String id,
                                         java.lang.String name,
                                         java.lang.String version,
                                         InterfaceDef[] base_interfaces)

create_abstract_interface

AbstractInterfaceDef create_abstract_interface(java.lang.String id,
                                               java.lang.String name,
                                               java.lang.String version,
                                               AbstractInterfaceDef[] base_interfaces)

This method creates an AbstractInterfaceDef object in this Container with the specified attributes. The interface that is created can only hold definitions of abstract interfaces.

Parameters:

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.

Returns:

a reference to the newly created object.

create_value_box

ValueBoxDef create_value_box(java.lang.String id,
                             java.lang.String name,
                             java.lang.String version,
                             IDLType original_type)

This method creates a ValueBoxDef object in this Container with the specified attributes

Parameters:

id - The structure's repository id.

name - The structure's name.

version - The structure's version.

original_type - The IDL type of the original object for which this is an alias.

Returns:

a reference to the newly created object

create_value

ValueDef create_value(java.lang.String id,
                      java.lang.String name,
                      java.lang.String version,
                      boolean is_custom,
                      boolean is_abstract,
                      ValueDef base_value,
                      boolean is_truncatable,
                      ValueDef[] abstract_base_values,
                      InterfaceDef[] supported_interfaces,
                      Initializer[] initializers)

This method creates a ValueDef object in this Container with the specified attributes

Parameters:

id - The structure's repository id.

name - The structure's name.

version - The structure's version.

is_custom - If set to true, creates a custom value type.

is_abstract - If set to true, creates and abstract value type.

base_value - The base value definition.

is_truncatable - If set to true, creates a truncatable interface.

abstract_base_values - The array of the abstract base definitions.

supported_interfaces - The array of the supported interface definitions.

initializers - The list of initializers this value type supports

create_interface

InterfaceDef create_interface(java.lang.String id,
                              java.lang.String name,
                              java.lang.String version,
                              InterfaceDef[] base_interfaces)

This method creates a concrete InterfaceDef object in this Container with the specified attributes.Unlike an AbstractInterfaceDef, this interface can contain definitions of both abstract and concrete interfaces.

Parameters:

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.

Returns:

a reference to the newly created object.

create_exception

ExceptionDef create_exception(java.lang.String id,
                              java.lang.String name,
                              java.lang.String version,
                              StructMember[] members)

This method creates an ExceptionDef object in this Container with the specified attributes

Parameters:

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.

create_alias

AliasDef create_alias(java.lang.String id,
                      java.lang.String name,
                      java.lang.String version,
                      IDLType original_type)

This method creates an AliasDef object in this Container with the specified attributes

Parameters:

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.

Returns:

a reference to the newly created object

create_enum

EnumDef create_enum(java.lang.String id,
                    java.lang.String name,
                    java.lang.String version,
                    java.lang.String[] members)

This method creates an EnumDef object in this Container with the specified attributes

Parameters:

id - The enumeration's repository id.

name - The enumeration's name.

version - The enumeration's version.

members - A list of the enumeration's values.

Returns:

a reference to the newly created object.

create_union

UnionDef create_union(java.lang.String id,
                      java.lang.String name,
                      java.lang.String version,
                      IDLType discriminator_type,
                      UnionMember[] members)

This method creates a UnionDef object in this Container with the specified attributes

Parameters:

id - The union's repository id.

name - The union's name.

version - The union's version.

discriminator_type - The IDL type of the union's discriminant value.

members - A list of the types of each of the union's fields.

create_native

NativeDef create_native(java.lang.String id,
                        java.lang.String name,
                        java.lang.String version)

This method creates a NativeDef object in this Container with the specified attributes

Parameters:

id - The structure's repository id.

name - The structure's name.

version - The structure's version.

Returns:

a reference to the newly created object.

create_struct

StructDef create_struct(java.lang.String id,
                        java.lang.String name,
                        java.lang.String version,
                        StructMember[] members)

This method creates a StructDef object in this Container with the specified attributes

Parameters:

id - The structure's repository id.

name - The structure's name.

version - The structure's version.

members - The values for the structure's fields.

create_constant

ConstantDef create_constant(java.lang.String id,
                            java.lang.String name,
                            java.lang.String version,
                            IDLType type,
                            Any value)

This method creates a ConstantDef object in this Container with the specified attributes

Parameters:

id - The constant's repository id.

name - The constant's name.

version - The constant's version.

type - The constant's IDL type.

value - The constant's value, represented by an Any object.

Returns:

a reference to the newly created object.

create_module

ModuleDef create_module(java.lang.String id,
                        java.lang.String name,
                        java.lang.String version)

This method creates a ModuleDef object in this Container with the specified attributes

Parameters:

id - The structure's repository id.

name - The structure's name.

version - The structure's version.

describe_contents

Description[] describe_contents(DefinitionKind limit_type,
                                boolean exclude_inherited,
                                int max_returned_objs)

Parameters:

limit_type - The interface object types to be returned.

exclude_inherited - If set to true, inherited objects will not be returned.

max_returned_objs - The maximum number of object to be returned. Setting this parameter to -1 will return all objects.

Returns:

a description for all definitions directly contained by, or inherited into this container.

lookup_name

Contained[] lookup_name(java.lang.String search_name,
                        int levels_to_search,
                        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.

Parameters:

search_name - The name of the object or objects to be located.

levels_to_search - The number of levels in the hierarchy to search. Setting this parameter to a value of -1 will cause all levels to be searched. Setting this parameter to 1 will search only this object.

limit_type - The interface object types to be returned.

exclude_inherited - If set to true, inherited objects will not be returned.

contents

Contained[] contents(DefinitionKind limit_type,
                     boolean exclude_inherited)

This method sets the repository identification that uniquely identifies this object.

Parameters:

limit_type - The interface object types to be returned.

exclude_inherited - If set to true, inherited objects will not be returned.

lookup

Contained lookup(java.lang.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.

Parameters:

search_name - The name of the object to be located.