corba::cadmin::AnCList Interface Reference

Collaboration diagram for corba::cadmin::AnCList:

[legend]List of all members.

---

Detailed Description

Interface contains list of associates and contracts from a successful search.

Definition at line 63 of file anclist.idl.

Public Member Functions

• long search (inout AnCFilter filter) raises (common::OsbCorbaException)

  Search for associates and contracts.
  

• void refresh (in boolean noWait) raises (common::OsbCorbaException)

  Refresh associate and contract lists from the database.
  

Access to associates:

• cadmin::assoc::AssociateWriter getAssociate (in cadmin::AssociateId id, in boolean noWait) raises (common::OsbCorbaException)

  Retrieve an associate.
  

• cadmin::assoc::AssociateIdSeq getAssociateIds ()

  Retrieve list of associate ids from current list.
  

• cadmin::assoc::AssociateSeq getAssociates () raises (common::OsbCorbaException)

  Retrieve list of associates from current list.
  

Create or remove associates:

• cadmin::assoc::AssociateWriter newAssociate (in cadmin::assoc::AssociateType type) raises (common::OsbCorbaException)

  Create a new associate for modifying.
  

• boolean delAssociate (in cadmin::AssociateId id, in boolean noWait) raises (common::OsbCorbaException)

  Delete an associate from list and removed from database.
  

Access to contracts:

• cadmin::contract::ContractWriter getContract (in cadmin::ContractId id) raises (common::OsbCorbaException)

  Retrieve a contract.
  

• cadmin::contract::ContractSeq getContracts (in cadmin::contract::ContractIdSeq idList) raises (common::OsbCorbaException)

  Get contracts for a list of contract ids.
  

• cadmin::contract::ContractIdSeq getContractIds ()

  Retrieve list of contract ids from current list.
  

• cadmin::contract::ContractSeq getAllContracts () raises (common::OsbCorbaException)

  Retrieve list of contracts from current list.
  

Create or remove associates:

• cadmin::contract::ContractWriter newContract (in contract::AccountingType acctType) raises (common::OsbCorbaException)

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

• boolean delContract (in cadmin::ContractId cId, in boolean noWait) raises (common::OsbCorbaException)

  Remove contract from list.
  

Public Attributes

• readonly attribute long numAssoc

  The number of associates in the list.
  

• readonly attribute long numContract

  The number of contracts in the list.
  

---

Member Function Documentation

boolean corba::cadmin::AnCList::delAssociate	(	in cadmin::AssociateId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Delete an associate from list and removed from database.

Parameters:

	id	Unique id of associate.
	noWait	Don't wait for database locks?

Exceptions:

OsbCorbaException

if operation at the gateway fails.

Returns:

True if operation successful.

boolean corba::cadmin::AnCList::delContract	(	in cadmin::ContractId	cId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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.

Parameters:

	cId	Unique id of contract.
	noWait	Set to true if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.

Returns:

True if operation is successful.

Exceptions:

OsbCorbaException

if operation fails at the gateway.

cadmin::contract::ContractSeq corba::cadmin::AnCList::getAllContracts

(

)

raises (common::OsbCorbaException)

Retrieve list of contracts from current list.

cadmin::assoc::AssociateWriter corba::cadmin::AnCList::getAssociate	(	in cadmin::AssociateId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Retrieve an associate.

Parameters:

	id	The object id of associate.
	noWait	Don't wait for database locks?

Exceptions:

OsbCorbaException

if the associate is not found.

Returns:

An associate writer if successful.

Retrieves the associate from the internal list or reads it from the database.

cadmin::assoc::AssociateIdSeq corba::cadmin::AnCList::getAssociateIds

(

)

Retrieve list of associate ids from current list.

cadmin::assoc::AssociateSeq corba::cadmin::AnCList::getAssociates

(

)

raises (common::OsbCorbaException)

Retrieve list of associates from current list.

cadmin::contract::ContractWriter corba::cadmin::AnCList::getContract

(

in cadmin::ContractId

id

)

raises (common::OsbCorbaException)

Retrieve a contract.

cadmin::contract::ContractIdSeq corba::cadmin::AnCList::getContractIds

(

)

Retrieve list of contract ids from current list.

cadmin::contract::ContractSeq corba::cadmin::AnCList::getContracts

(

in cadmin::contract::ContractIdSeq

idList

)

raises (common::OsbCorbaException)

Get contracts for a list of contract ids.

Parameters:

idList

List of contract ids to process.

Returns:

The contract servants.

Exceptions:

OsbCorbaException

if a contract is not found.

The function is typically called with assoc::AssociateWriter::getContractIds() as argument.

cadmin::assoc::AssociateWriter corba::cadmin::AnCList::newAssociate

(

in cadmin::assoc::AssociateType

type

)

raises (common::OsbCorbaException)

Create a new associate for modifying.

This function creates a temporary associate that does not have any entry in the database. As such, functions that requires database session, such as the status changes functions cannot be invoked via the AssociateWriter created from this function.

Parameters:

type

Type of associate.

Exceptions:

OsbCorbaException

if creating an associate of the correct type fails.

Returns:

An associate writer if successful.

cadmin::contract::ContractWriter corba::cadmin::AnCList::newContract

(

in contract::AccountingType

acctType

)

raises (common::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.

Parameters:

acctType

Accounting type of contract.

Returns:

Contract reference.

Exceptions:

OsbCorbaException

if the contract creation fails.

void corba::cadmin::AnCList::refresh

(

in boolean

noWait

)

raises (common::OsbCorbaException)

Refresh associate and contract lists from the database.

Parameters:

noWait

Don't wait for database locks?

Exceptions:

OsbCorbaException

if fetching at gateway fails.

long corba::cadmin::AnCList::search

(

inout AnCFilter

filter

)

raises (common::OsbCorbaException)

Search for associates and contracts.

Parameters:

filter

Filter to use.

Returns:

The number of contracts and associates read.

Read the matching associates and contracts for each attribute that is set in filter. This search function is case-insensitive.

---

Member Data Documentation

readonly attribute long corba::cadmin::AnCList::numAssoc

The number of associates in the list.

Definition at line 79 of file anclist.idl.

readonly attribute long corba::cadmin::AnCList::numContract

The number of contracts in the list.

Definition at line 81 of file anclist.idl.

---

The documentation for this interface was generated from the following file:

• anclist.idl

---