Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

NotificationTypes::Contains Interface Reference

An interface for Contains objects. More...

import "NotificationTypes.idl";

List of all members.

Public Methods

ContainsLinkSet all_Contains_links ()
 Return all the links in the Contains interface. More...

boolean exists (in EventTypeRepository container, in EventType contained)
 Check whether the event type is in the repository. More...

EventTypeSet with_container (in EventTypeRepository container)
 Return all the event types in a repository. More...

EventTypeRepository with_contained (in EventType contained)
 Return the repository of the event type. More...

void add (in EventTypeRepository container, in EventType contained) raises (Reflective::StructuralError, Reflective::SemanticError)
 Add an event type to the repository. More...

void modify_container (in EventTypeRepository container, in EventType contained, in EventTypeRepository new_container) raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 Modify the container of an event type. More...

void modify_contained (in EventTypeRepository container, in EventType contained, in EventType new_contained) raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 Replace an event type in the repository with another. More...

void remove (in EventTypeRepository container, in EventType contained) raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 Remove an event type from the repository. More...


Detailed Description

An interface for Contains objects.

This is used to manage the events contained in the singleton repository. The events can be manages either using the operations of this interface or by means of the generic operations in the RefAssociation interface.


Member Function Documentation

void NotificationTypes::Contains::add in EventTypeRepository    container,
in EventType    contained
raises (Reflective::StructuralError, Reflective::SemanticError)
 

Add an event type to the repository.

m <code>container</code> - The event type repository.
m <code>contained</code> - The event type to add.
@raises StructuralError If event type is already added to this repository or if this repository does not support the event type domain. @raises SemanticError Not raised by this implementation.

ContainsLinkSet NotificationTypes::Contains::all_Contains_links  
 

Return all the links in the Contains interface.

Returns:
An array of ContainsLink objects.

boolean NotificationTypes::Contains::exists in EventTypeRepository    container,
in EventType    contained
 

Check whether the event type is in the repository.

This operation always returns false if the object in the container parmeter is not the singleton package repository.

m <code>container</code> - The repository to check.
m <code>contained</code> - The event type to check.
Returns:
True if event is in the singleton repository.

void NotificationTypes::Contains::modify_contained in EventTypeRepository    container,
in EventType    contained,
in EventType    new_contained
raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 

Replace an event type in the repository with another.

m <code>container</code> - The event type repository.
m <code>contained</code> - The event type to replace.
m <code>new_contained</code> - The replacing event type.
@raises StructuralError Raised in the following circumstances:
  • If the object in container is not the singleton event type repository.
  • If the domain of new_contained is not supported by the event type repository.
  • If the event type in new_contained is already added to the event type repository.
  • If the event in contained has any subtypes or any event type imports contained.
@raises NotFound If the event type in contained was not found in the repository. @raises SemanticError Not raised by this implementation.

void NotificationTypes::Contains::modify_container in EventTypeRepository    container,
in EventType    contained,
in EventTypeRepository    new_container
raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 

Modify the container of an event type.

Since event repositories are singletons within each package, this operation always raises an exception.

m <code>container</code> - The old repository.
m <code>contained</code> - The event type to move.
m <code>new_container</code> - The new repository.
@raises StructuralError Always raised. @raises NotFound Not raised by this implementation. @raises SemanticError Not raised by this implementation.

void NotificationTypes::Contains::remove in EventTypeRepository    container,
in EventType    contained
raises (Reflective::StructuralError, Reflective::NotFound, Reflective::SemanticError)
 

Remove an event type from the repository.

m <code>container</code> - The event type repository.
m <code>contained</code> - The event type to remove.
@raises StructuralError Not raised by this implementation. @raises NotFound If the event type was not found. @raises SemanticError Not raised by this implementation.

EventTypeRepository NotificationTypes::Contains::with_contained in EventType    contained
 

Return the repository of the event type.

m <code>contained</code> - The event to find repository for.
Returns:
The singleton repository if event is defined in it.

EventTypeSet NotificationTypes::Contains::with_container in EventTypeRepository    container
 

Return all the event types in a repository.

m <code>container</code> - The repository.
Returns:
An array of all the event in the singleton repository. If container is not the package repository, a sequence of length zero is returned.