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

tweek::SubjectManager Interface Reference

The interface to Tweek SubjectManager instances. More...

import "SubjectManager.idl";

List of all members.

Public Types

typedef sequence< RegisteredSubjectSubjectList
 A list of registered subjects. More...

typedef sequence< SubjectMgrInfoItemSubjectManagerInfoList
 A list of informational items relating to the Subject Manager instance. More...


Public Methods

Subject getSubject (in string name)
 Returns the named Tweek Subject reference to the caller if the Subject is registered. More...

SubjectList getAllSubjects ()
 Returns a sequence of all the registered Tweek Subjects packaged in the structure RegisteredSubject. More...

SubjectManagerInfoList getInfo ()
 Returns a sequence of key/value pairs that provide site-specific information about a given Subject Manager servant. More...

string getName ()
 Returns the name of this Subject Manager reference as it is registered with the CORBA Naming Service. More...


Detailed Description

The interface to Tweek SubjectManager instances.

Subject Managers are accessed by remote code to acquire CORBA references to remote objects. The intent of the Subject Manager is to reduce the amount of CORBA programming done by users of the language-specific Tweek APIs.

Definition at line 52 of file SubjectManager.idl.


Member Typedef Documentation

typedef sequence<RegisteredSubject> tweek::SubjectManager::SubjectList
 

A list of registered subjects.

Definition at line 75 of file SubjectManager.idl.

Referenced by tweek::SubjectManagerImpl::getAllSubjects.

typedef sequence<SubjectMgrInfoItem> tweek::SubjectManager::SubjectManagerInfoList
 

A list of informational items relating to the Subject Manager instance.

Definition at line 80 of file SubjectManager.idl.

Referenced by tweek::SubjectManagerImpl::getInfo.


Member Function Documentation

Subject tweek::SubjectManager::getSubject in string    name
 

Returns the named Tweek Subject reference to the caller if the Subject is registered.

If not, a reference equal to CORBA::nil() is returned.

Parameters:
name  The name of the subject to look up.
Returns:
A reference to the requested subject or a reference equal to CORBA::nil() if the requested subject does not exist.

SubjectList tweek::SubjectManager::getAllSubjects  
 

Returns a sequence of all the registered Tweek Subjects packaged in the structure RegisteredSubject.

Returns:
A complete list of all subjects registered with this Subject Manager instance is returned.

SubjectManagerInfoList tweek::SubjectManager::getInfo  
 

Returns a sequence of key/value pairs that provide site-specific information about a given Subject Manager servant.

Returns:
A complete list of all informational items about this Subject Manager instance.

string tweek::SubjectManager::getName  
 

Returns the name of this Subject Manager reference as it is registered with the CORBA Naming Service.

Note:
It might be possible for client code to look this up some other way, so this method may not really be needed except as a convenience.


The documentation for this interface was generated from the following file:
Generated on Sun May 2 14:41:10 2004 for Tweek by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002