All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogConnections

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATILogConnections

Interface dedicated to Logical Connections management.

Role: This interface manages the collection of Logical Connections aggregated by a Logical Reference.
To establish a connection or navigate between logical systems, see , and .

Method Index

o Count(int&): Retrieves the number of Logical Connections aggregated by this Logical Reference.
o List(CATListValCATILogConnection_var&): Retrieves the collection of connections aggregated by this Logical Reference.
o Remove(CATILogConnection*): Removes the given Logical Connection.

Methods

o Count

public virtual Count( oSize)

Retrieves the number of Logical Connections aggregated by this Logical Reference.

Parameters:

oSize: The number of Logical Connections.

Returns:

S_OK The method succeeds and the number of Logical Connections is retrieved.
E_FAIL otherwise.

o List

public virtual List( oLConnections)

Retrieves the collection of connections aggregated by this Logical Reference.

Parameters:

oLConnections: A list of logical connections.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipLogicalConnectionToRemove)

Removes the given Logical Connection.
Role: This method removes and deletes the given Logical Connection from the logical connections aggregated by this Logical Reference.
The given logical connection must be aggregated by this Logical Reference.

Parameters:

ipLogicalConnectionToRemove: The logical connection to remove.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds and the Logical Connection has been successfully removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

This object is included in the file: CATILogConnections.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerUseItf