OSB_CORBA::AnCList_i Class Reference

Inheritance diagram for OSB_CORBA::AnCList_i:

Inheritance graph
Collaboration diagram for OSB_CORBA::AnCList_i:

Collaboration graph
List of all members.

Detailed Description

Definition at line 76 of file anclist_i.h.

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes


Constructor & Destructor Documentation

OSB_CORBA::AnCList_i::AnCList_i ( ContractAdmin_i cadmin  )  [explicit]

Constructor with controlling contract admin.

virtual OSB_CORBA::AnCList_i::~AnCList_i (  )  [virtual]

Destructor: delete ancList_.

OSB_CORBA::AnCList_i::AnCList_i ( const AnCList_i  )  [private]

Prevent copying until needed: not implemented.

Member Function Documentation

OSB_LIB::AnCList& OSB_CORBA::AnCList_i::ancList (  )  [inline, private]

Return reference to AnCList.

Definition at line 269 of file anclist_i.h.

References ancList_.

ContractAdmin_i& OSB_CORBA::AnCList_i::cadmin (  )  const [inline, private]

Return reference to contract admin.

Definition at line 263 of file anclist_i.h.

References cadmin_.

virtual CORBA::Boolean OSB_CORBA::AnCList_i::delAssociate ( const AssociateId &  id,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Delete associate.

id Unique associate id.
noWait Don't wait for database locks?
true in case of success, else false.
OsbCorbaException if the operation fails,
in most case if any the the associate's children or contracts is not created.

virtual CORBA::Boolean OSB_CORBA::AnCList_i::delContract ( const ContractId &  cId,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Remove contract from list.

This function removes contract from the list of objects and from the database. commitChanges() is not required after this function is called.

cId Unique id of contract.
noWait Don't wait for database locks?
true in case of success, else false.
OsbCorbaException if operation fails at the gateway.

virtual ContractSeq* OSB_CORBA::AnCList_i::getAllContracts (  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve all contracts.

virtual AssociateWriter_ptr OSB_CORBA::AnCList_i::getAssociate ( const AssociateId &  id,
CORBA::Boolean  noWait 
) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get Associate based on id.

This functions calls the makeAssociate function and downcast the returned associate writer object.

id Unique id of associate.
noWait Don't wait for database locks?
OsbCorbaException if associate could not be found.

virtual AssociateIdSeq* OSB_CORBA::AnCList_i::getAssociateIds (  )  throw (CORBA::SystemException) [virtual]

Retrieve list of associate ids.

virtual AssociateSeq* OSB_CORBA::AnCList_i::getAssociates (  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve list of associates.

virtual ContractWriter_ptr OSB_CORBA::AnCList_i::getContract ( const ContractId &  id  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get contract by its id.

This function calls the makeContract function and downcast the returned contract writer object.

id Unqiue id of contract.
OsbCorbaException if contract could not be found.

virtual ContractIdSeq* OSB_CORBA::AnCList_i::getContractIds (  )  throw (CORBA::SystemException) [virtual]

Retrieve list of contract ids.

virtual ContractSeq* OSB_CORBA::AnCList_i::getContracts ( const ContractIdSeq &  idList  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get contracts for a list of contract ids.

idList List of contract ids to process.
The contract servants.
OsbCorbaException if a contract is not found.

const Locators::Key& OSB_CORBA::AnCList_i::key (  )  const [inline]

Get the servant key.

Definition at line 252 of file anclist_i.h.

References key_.

AssociateWriter_ptr OSB_CORBA::AnCList_i::makeAssociate ( const OSB_LIB::Associate assoc  )  throw (CORBA::SystemException, OsbCorbaException) [private]

Create an associate servant.

assoc Library associate for which to create the servant, it must no be 0.
Overload taking an auto-pointer as argument.

ContractWriter_ptr OSB_CORBA::AnCList_i::makeContract ( const OSB_LIB::Contract co  )  throw (CORBA::SystemException, OsbCorbaException) [private]

Create a contract servant.

co Contract for which the servant is created.

virtual AssociateWriter_ptr OSB_CORBA::AnCList_i::newAssociate ( AssociateType  type  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Create a new empty associate.

Create an empty associate object of the requested type, this object does not have an entry in the datbase yet. User should use create function in Associate_i to create record in the database. Functions that requires database session, such as the status changes functions cannot be invoked via the AssociateWriter created from this function.

type Type of associate.
Associate writer if successful.
OsbCorbaException if creating an associate of the correct type fails.

ContractWriter_ptr OSB_CORBA::AnCList_i::newContract ( AccountingType  acctType  )  throw (CORBA::SystemException, OsbCorbaException)

Get a new contract reference so that new contract information can be set.

Operations with the exception of create(), that involves database manipulation are not allowed to be invoked by this corba reference as the underlying library object is temporary without any record in the database, ie. the Oid of these library objects are ID_NOT_SET.

acctType Accounting type of contract.
Contract reference.
OsbCorbaException if the contract creation fails.

virtual CORBA::Long OSB_CORBA::AnCList_i::numAssoc (  )  throw () [virtual]

The number of associates in the list.

virtual CORBA::Long OSB_CORBA::AnCList_i::numContract (  )  throw () [virtual]

The number of contracts in the list.

AnCList_i& OSB_CORBA::AnCList_i::operator= ( const AnCList_i  )  [private]

Prevent assignment until needed: not implemented.

virtual void OSB_CORBA::AnCList_i::refresh ( CORBA::Boolean  noWait  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Refresh AnCList list from the database.

noWait Don't wait for database locks?
OsbCorbaException if fetch function at the gateway fails.

virtual CORBA::Long OSB_CORBA::AnCList_i::search ( AnCFilter &  filter  )  throw (CORBA::SystemException, OsbCorbaException) [virtual]

Search for associates and contracts.

filter Filter to use.
The number of contracts and associates read.
Read the matching associates and contracts for each attribute that is set in filter.
The search function is case-insensitive.

Friends And Related Function Documentation

friend class AssociateWriter_i [friend]

Definition at line 258 of file anclist_i.h.

friend class ContractWriter_i [friend]

Definition at line 259 of file anclist_i.h.

friend class PersProductWriter_i [friend]

Definition at line 260 of file anclist_i.h.

Member Data Documentation

OSB_LIB::AnCList* OSB_CORBA::AnCList_i::ancList_ [private]

AnCList contains associate and contract list.

Definition at line 301 of file anclist_i.h.

Referenced by ancList().

ContractAdmin_i& OSB_CORBA::AnCList_i::cadmin_ [private]

Reference to contract admin with the POA's.

Definition at line 298 of file anclist_i.h.

Referenced by cadmin().

const std::string OSB_CORBA::AnCList_i::IFC [static]

Definition at line 79 of file anclist_i.h.

Locators::Key OSB_CORBA::AnCList_i::key_ [private]

The servant key.

Definition at line 304 of file anclist_i.h.

Referenced by key().

The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:27:17 2006 for OSB Library by  doxygen 1.4.7