OSB_CORBA::ContractWriter_i Class Reference

Inheritance diagram for OSB_CORBA::ContractWriter_i:

[legend]Collaboration diagram for OSB_CORBA::ContractWriter_i:

[legend]List of all members.

---

Detailed Description

Servant for CORBA interface ContractWriter.

Definition at line 86 of file contract_i.h.

Public Member Functions

• ContractWriter_i (AnCList_i &anclist, const OSB_LIB::Contract &contr)

  Contructor.
  

• ~ContractWriter_i ()

  Destructor.
  

• const Locators::Key key () const

  Get the servant key.
  

• virtual ContractId id () throw (CORBA::SystemException)

  Return unique id of contract.
  

• virtual AssociateId owner () throw (CORBA::SystemException)

  Return contract owner.
  

• Utf8String * getStatement (const Utf8String &fileInfo) throw (CORBA::SystemException, OsbCorbaException)

  Retrieve a statement based on the month of input date.
  

• InvoiceInfoSeq * getStatements (StatementType type, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Retrieve list of statments of a contract based on type of statement.
  

• virtual BalanceSheetWriter_ptr getBalanceSheet (CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Retrieve open balance sheet of a contract.
  

• virtual PersProductWriter_ptr getPersProduct (const PersProdId &id, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Retrieve a personalised product.
  

• virtual PersProdSeq * getPersProducts (CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Retrieve list of personalised products.
  

• virtual TaxKeyId tkId () throw (CORBA::SystemException)

  Return unique id of taxkey used in contract.
  

• virtual BillCycleId bcId () throw (CORBA::SystemException)

  Return unique if of billcycle of contract.
  

• virtual AccountingType acctType () throw (CORBA::SystemException)

  Return accounting type of contract.
  

• virtual Money * creditLimit () throw (CORBA::SystemException)

  Return credit limit of contract.
  

• virtual DateTime * createdDate () throw (CORBA::SystemException)

  Return date and time of creation.
  

• virtual Status effStatus () throw (CORBA::SystemException)

  Return effective status of contract.
  

• virtual Status prefStatus () throw (CORBA::SystemException)

  Return preferred status of contract.
  

• virtual DateTime * effStatusDate () throw (CORBA::SystemException)

  Return date and time at which effective status will be used.
  

• virtual DateTime * prefStatusDate () throw (CORBA::SystemException)
• virtual StatusValue requestedStatus (const DateTime &ts) throw (CORBA::SystemException, OsbCorbaException)

  Get the requested status for a given time.
  

• StatusHistory * statusHistory (const DateTime &from, const DateTime &to, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Get status history for a period of time.
  

• virtual CORBA::Boolean setTaxKey (const TaxKeyId &tkId) throw (CORBA::SystemException)

  Set tax key used in contract.
  

• virtual CORBA::Boolean setBillCycle (const BillCycleId &bcId) throw (CORBA::SystemException)

  Set billcycle used in contract.
  

• virtual CORBA::Boolean setCreditLimit (const Money &credit) throw (CORBA::SystemException)

  Set credit limit used in contract.
  

• virtual PersProductWriter_ptr addPersProduct (const ProductId &id, const AssociateId &userId, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Add a personalised product.
  

• virtual CORBA::Boolean removePersProduct (const PersProdId &id, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Remove a personalised product.
  

• virtual ContractId create (const AssociateId &owner, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Add a new contract to list.
  

• virtual CORBA::Boolean commitChanges (CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Update changes to the contract permanently into database.
  

• void checkRefUsage () throw (OsbCorbaException)

  Check if corba reference is used illegally.
  

Status changes:

• CORBA::Boolean changeStatus (StatusRequest &status, CORBA::Boolean noWait, CfgErrorSeq_out errors) throw (CORBA::SystemException, OsbCorbaException)

  Set the preferred status of the contract.
  

Static Public Attributes

• static const std::string IFC

Private Types

• typedef std::list< Locators::Key > Servants

  Short-hand for a list of servants.
  

Private Member Functions

• void ppChanged (const OSB_DB::Session &session)

  One the contract's pers. product has changed.
  

Private Attributes

• AnCList_i & ancList_

  Reference to AnCList reference.
  

• OSB_LIB::Contract * contr_

  Pointer to contract object in the library.
  

• Locators::Key key_

  Contract servant key.
  

• Servants ppServants_

  Pers. product servant list.
  

• Servants bsServants_

  Balance sheet servant list.
  

Friends

• class PersProductWriter_i

  Prodive access to ppChanged().
  

---

Member Typedef Documentation

typedef std::list<Locators::Key> OSB_CORBA::ContractWriter_i::Servants [private]

Short-hand for a list of servants.

Definition at line 379 of file contract_i.h.

---

Constructor & Destructor Documentation

OSB_CORBA::ContractWriter_i::ContractWriter_i	(	AnCList_i &	anclist,
		const OSB_LIB::Contract &	contr
	)

Contructor.

OSB_CORBA::ContractWriter_i::~ContractWriter_i

(

)

Destructor.

Deletes contr_, unregisters the pers. product and balance sheets servants (which will ultimately delete them).

---

Member Function Documentation

virtual AccountingType OSB_CORBA::ContractWriter_i::acctType

(

)

throw (CORBA::SystemException) [virtual]

Return accounting type of contract.

virtual PersProductWriter_ptr OSB_CORBA::ContractWriter_i::addPersProduct	(	const ProductId &	id,
		const AssociateId &	userId,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) [virtual]

Add a personalised product.

This function adds a new personalised product to the database.

Parameters:

	id	Unique product id.
	userId	Associate user of the personalised product.
	noWait	Don't wait for database locks?

Returns:

Personalised product writer if operation is successful.

Exceptions:

OsbCorbaException

if status of contract is deactivated.

virtual BillCycleId OSB_CORBA::ContractWriter_i::bcId

(

)

throw (CORBA::SystemException) [virtual]

Return unique if of billcycle of contract.

CORBA::Boolean OSB_CORBA::ContractWriter_i::changeStatus	(	StatusRequest &	status,
		CORBA::Boolean	noWait,
		CfgErrorSeq_out	errors
	)			throw (CORBA::SystemException, OsbCorbaException)

Set the preferred status of the contract.

Parameters:

	status	Preferred status to set, see below.
	noWait	Don't wait for database locks?
	errors	Gets encountered errors.

When calling the function, status must have the requested status and reason set; if the status date is not set the system date is used.
If successful the request id, the requested date/time and the entry timestamp will be set.

void OSB_CORBA::ContractWriter_i::checkRefUsage

(

)

throw (OsbCorbaException)

Check if corba reference is used illegally.

This function checks that when a temporary contract reference is created via the getNewContract function, the corba reference is not used to invoke any operations that manipulate the data in the database.

Exceptions:

OsbCorbaException

if corba reference is used illegally.

virtual CORBA::Boolean OSB_CORBA::ContractWriter_i::commitChanges

(

CORBA::Boolean

noWait

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Update changes to the contract permanently into database.

virtual ContractId OSB_CORBA::ContractWriter_i::create	(	const AssociateId &	owner,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) [virtual]

Add a new contract to list.

This function adds a new contract to the list of objects and the database. commitChanges() is not required after this function is called.

Parameters:

	owner	The owner of the contract.
	noWait	Don't wait for database locks?

Returns:

Unique contract id if successful, else id is ID_NOT_SET.

Exceptions:

OsbCorbaException

if operation fails at the gateway.

virtual DateTime* OSB_CORBA::ContractWriter_i::createdDate

(

)

throw (CORBA::SystemException) [virtual]

Return date and time of creation.

virtual Money* OSB_CORBA::ContractWriter_i::creditLimit

(

)

throw (CORBA::SystemException) [virtual]

Return credit limit of contract.

virtual Status OSB_CORBA::ContractWriter_i::effStatus

(

)

throw (CORBA::SystemException) [virtual]

Return effective status of contract.

virtual DateTime* OSB_CORBA::ContractWriter_i::effStatusDate

(

)

throw (CORBA::SystemException) [virtual]

Return date and time at which effective status will be used.

virtual BalanceSheetWriter_ptr OSB_CORBA::ContractWriter_i::getBalanceSheet

(

CORBA::Boolean

noWait

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve open balance sheet of a contract.

Parameters:

noWait

Don't wait for database locks?

Returns:

list of status changes.

Exceptions:

OsbCorbaException

if operation to retrieve status changes fails at the database.

virtual PersProductWriter_ptr OSB_CORBA::ContractWriter_i::getPersProduct	(	const PersProdId &	id,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve a personalised product.

Parameters:

	id	Unique personalised product id.
	noWait	Don't wait for database locks?

Returns:

Personalised product reference.

Exceptions:

OsbCorbaException

if personalised product cannot be found in contract.

virtual PersProdSeq* OSB_CORBA::ContractWriter_i::getPersProducts

(

CORBA::Boolean

noWait

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Retrieve list of personalised products.

Utf8String* OSB_CORBA::ContractWriter_i::getStatement

(

const Utf8String &

fileInfo

)

throw (CORBA::SystemException, OsbCorbaException)

Retrieve a statement based on the month of input date.

Parameters:

fileInfo

Full file path of statement.

Returns:

Invoice as an Utf8String

Exceptions:

OsbCorbaException

if file I/O operation fails.

InvoiceInfoSeq* OSB_CORBA::ContractWriter_i::getStatements	(	StatementType	type,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Retrieve list of statments of a contract based on type of statement.

Parameters:

	type	Statement type criteria.
	noWait	Don't wait for database locks?

Returns:

List of information on the statements.

Exceptions:

OsbCorbaException

if I/O operation or database operation fails.

virtual ContractId OSB_CORBA::ContractWriter_i::id

(

)

throw (CORBA::SystemException) [virtual]

Return unique id of contract.

const Locators::Key OSB_CORBA::ContractWriter_i::key

(

)

const [inline]

Get the servant key.

Definition at line 107 of file contract_i.h.

References key_.

virtual AssociateId OSB_CORBA::ContractWriter_i::owner

(

)

throw (CORBA::SystemException) [virtual]

Return contract owner.

This function will search for an existing associate servant that has been incarnated by the current contract. If such a servant exists, the servant is retrieved from the servant locator. If it does not exist, a new servant is incarnated.

Returns:

The id of the associate that owns the servant.

void OSB_CORBA::ContractWriter_i::ppChanged

(

const OSB_DB::Session &

session

)

[private]

One the contract's pers. product has changed.

Replaces the contract in the A&C list with contr_.

virtual Status OSB_CORBA::ContractWriter_i::prefStatus

(

)

throw (CORBA::SystemException) [virtual]

Return preferred status of contract.

virtual DateTime* OSB_CORBA::ContractWriter_i::prefStatusDate

(

)

throw (CORBA::SystemException) [virtual]

Return date and time at which preferred status will be effective.

virtual CORBA::Boolean OSB_CORBA::ContractWriter_i::removePersProduct	(	const PersProdId &	id,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) [virtual]

Remove a personalised product.

This function removes a personalised product from the database permanently.

Parameters:

	id	Unique personalised product id.
	noWait	Don't wait for database locks?

Returns:

True if operation is successful.

Exceptions:

OsbCorbaException

if operation fails at the gateway.

virtual StatusValue OSB_CORBA::ContractWriter_i::requestedStatus

(

const DateTime &

ts

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get the requested status for a given time.

Parameters:

ts

Date and time to query, if not set system time is used.

Returns:

The anticipated preferred status at time ts,
the related status request may or may not have been applied.

Exceptions:

OsbCorbaException

in case of a database error.

virtual CORBA::Boolean OSB_CORBA::ContractWriter_i::setBillCycle

(

const BillCycleId &

bcId

)

throw (CORBA::SystemException) [virtual]

Set billcycle used in contract.

virtual CORBA::Boolean OSB_CORBA::ContractWriter_i::setCreditLimit

(

const Money &

credit

)

throw (CORBA::SystemException) [virtual]

Set credit limit used in contract.

virtual CORBA::Boolean OSB_CORBA::ContractWriter_i::setTaxKey

(

const TaxKeyId &

tkId

)

throw (CORBA::SystemException) [virtual]

Set tax key used in contract.

StatusHistory* OSB_CORBA::ContractWriter_i::statusHistory	(	const DateTime &	from,
		const DateTime &	to,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Get status history for a period of time.

Parameters:

	from	Start period of list to retrieve (inclusive).
	to	End period of list to retrieve (exclusive).
	noWait	Don't wait for database locks?

Returns:

list of status changes.

Exceptions:

OsbCorbaException

if operation to retrieve status changes fails at the database.

virtual TaxKeyId OSB_CORBA::ContractWriter_i::tkId

(

)

throw (CORBA::SystemException) [virtual]

Return unique id of taxkey used in contract.

---

Friends And Related Function Documentation

friend class PersProductWriter_i [friend]

Prodive access to ppChanged().

Definition at line 366 of file contract_i.h.

---

Member Data Documentation

AnCList_i& OSB_CORBA::ContractWriter_i::ancList_ [private]

Reference to AnCList reference.

Definition at line 382 of file contract_i.h.

Servants OSB_CORBA::ContractWriter_i::bsServants_ [private]

Balance sheet servant list.

Definition at line 392 of file contract_i.h.

OSB_LIB::Contract* OSB_CORBA::ContractWriter_i::contr_ [private]

Pointer to contract object in the library.

Definition at line 385 of file contract_i.h.

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

Definition at line 90 of file contract_i.h.

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

Contract servant key.

Definition at line 387 of file contract_i.h.

Referenced by key().

Servants OSB_CORBA::ContractWriter_i::ppServants_ [private]

Pers. product servant list.

Definition at line 390 of file contract_i.h.

---

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

• contract_i.h

---