[Previous] [Contents] [Next] [IONA Technologies]


Container


Contents

Container::contents()
Container::describe_contents()
Container::lookup_name()



Synopsis:

Interface Container describes objects that can contain other objects. It is a base interface for the following interfaces:

Each of the Interface Repository types inherits from Contained or Container, or both.

CORBA:

Notes:

CORBA defined.

See Also:



Container::contents()


Synopsis:

Description:

Returns the list of Interface Repository objects contained by the object. This operation can be used to navigate through the hierarchy of definitions–starting, for example, at a Repository.

Parameters:



     restrict_type
    
If this is set to all, then all of the contained Interface Repository objects are returned. If set to a specific interface type it returns only that type. For example, if set to, OperationDef, then it returns contained operations only.

     exclude_inherited
    
Applies only to interfaces. If set to TRUE, inherited objects are not returned. If set to FALSE, objects are returned even if they are inherited.

Notes:

CORBA defined.

See Also:



Container::describe_contents()


Synopsis:

Description:

The operation describe_contents() is a combination of the operation Contained::describe() and the operation Container::contents(). It returns a sequence of Description structures:

each of which gives the object reference of a contained object, together with its name and value.

Parameters:



     max_returned_objs
    
Specifies the maximum number of objects to return. The value -1 indicates that all contained objects should be returned.

     exclude_inherited
    
Applies only to interfaces. If set to TRUE, inherited objects are not returned. If set to FALSE, objects are returned even if they are inherited.

     restrict_type
    
If this is set to all then all of the contained Interface Repository objects are returned. If set to a specific interface type it returns only objects of that type. For example, if set to OperationDef, then it returns contained operations only.

Notes:

CORBA defined.

See Also:



Container::lookup_name()


Synopsis:

Description:

Returns all of the objects within a given Interface Repository object which have the name specified by search_name.

Parameters:



     search_name
    
Specifies the name of the object to return.

     levels_to_search
    
Specifies the number of nested Interface Repository objects to search; a value of -1 searches the current object and all contained objects; a value of 1 searches the current object only; any other positive value searches down through that number of levels of containment.

     restrict_type
    
If set to all, then all the contained Interface Repository objects are returned. If set to a specific interface type it returns only that type. For example, if set to OperationDef, then it returns contained operations only.

     exclude_inherited
    
Applies only to interfaces. If set to TRUE, inherited objects are not returned. If set to FALSE, objects are returned even if they are inherited.

Notes:

CORBA defined.



[Roadmap] [Utilities] [Compiling] [Configuration]
[Class Reference] [IR Reference] [Daemon Reference] [IDL Grammar] [System Exceptions]
[Index]