corba::cadmin::contract::ContractWriter Interface Reference

Collaboration diagram for corba::cadmin::contract::ContractWriter:

[legend]List of all members.

Detailed Description

Interface provide read and write access to a contract.

Definition at line 134 of file contract.idl.

Public Member Functions

StatusValue requestedStatus (in common::DateTime ts) raises (common::OsbCorbaException)
Get the requested status for a given time.
StatusHistory statusHistory (in common::DateTime from, in common::DateTime to, in boolean noWait) raises (common::OsbCorbaException)
Get status history for a period of time.
common::Utf8String getStatement (in common::Utf8String fileInfo) raises (common::OsbCorbaException)
Retrieve a statement.
InvoiceInfoSeq getStatements (in StatementType type, in boolean noWait) raises (common::OsbCorbaException)
Retrieve all statements of a contract based on type of statement.
BalanceSheetWriter getBalanceSheet (in boolean noWait) raises (common::OsbCorbaException)
Retrieve an open balance-sheet of a contract.
cadmin::persprod::PersProductWriter getPersProduct (in cadmin::PersProdId id, in boolean noWait) raises (common::OsbCorbaException)
Retrieve a personalised product.
cadmin::persprod::PersProdSeq getPersProducts (in boolean noWait) raises (common::OsbCorbaException)
Retrieve list of personalised products.
boolean setTaxKey (in common::TaxKeyId tkId)
Set tax key of contract.
boolean setBillCycle (in BillCycleId bcId)
Set bill cycle of contract.
boolean setCreditLimit (in common::Money credit)
Set amount of credit limit.
cadmin::persprod::PersProductWriter addPersProduct (in pcat::pd::ProductId id, in cadmin::AssociateId userId, in boolean noWait) raises (common::OsbCorbaException)
Add a personalised product.
boolean removePersProduct (in cadmin::PersProdId id, in boolean noWait) raises (common::OsbCorbaException)
Remove a personalised product.
cadmin::ContractId create (in cadmin::AssociateId owner, in boolean noWait) raises (common::OsbCorbaException)
Add a new contract to list.
boolean commitChanges (in boolean noWait) raises (common::OsbCorbaException)
Update changes permanently into database.

Status changes:

boolean changeStatus (inout StatusRequest status, in boolean noWait, out common::CfgErrorSeq errors) raises (common::OsbCorbaException)
Set the preferred status of the associate.

Public Attributes

readonly attribute ContractId id
Unique id of contract.
readonly attribute cadmin::AssociateId owner
Get the contract owner.
readonly attribute common::TaxKeyId tkId
Tax key id.
readonly attribute AccountingType acctType
Accounting type of contract.
readonly attribute BillCycleId bcId
Bill cycle unique id.
readonly attribute common::DateTime createdDate
Date and time of creation.
readonly attribute Status effStatus
Effective status of contract.
readonly attribute Status prefStatus
Preferred status of contract.
readonly attribute common::DateTime effStatusDate
Date and time of contract which will be effective.
readonly attribute common::DateTime prefStatusDate
readonly attribute common::Money creditLimit
Credit limit of contract.

Member Function Documentation

cadmin::persprod::PersProductWriter corba::cadmin::contract::ContractWriter::addPersProduct	(	in pcat::pd::ProductId	id,
		in cadmin::AssociateId	userId,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Add a personalised product.

This function creates a personalised product from a product in the database.

Parameters:

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

Returns:: Personalised product corba reference if operation is successful.

Exceptions:

OsbCorbaException

if status of contract is deactivated.

boolean corba::cadmin::contract::ContractWriter::changeStatus	(	inout StatusRequest	status,
		in boolean	noWait,
		out common::CfgErrorSeq	errors
	)			raises (common::OsbCorbaException)

Set the preferred status of the associate.

Parameters:

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

Returns:: true if successful, else false.

When calling the function, status must have the requested status, reason and cascade flag 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.

boolean corba::cadmin::contract::ContractWriter::commitChanges ( in boolean noWait ) raises (common::OsbCorbaException)

Update changes permanently into database.

cadmin::ContractId corba::cadmin::contract::ContractWriter::create	(	in cadmin::AssociateId	owner,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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. If contract already exist in the database, return existing contract id.

Parameters:

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

Returns:: Unique Contract id if successful, else contract id is ID_NOT_SET.

Exceptions:

OsbCorbaException

if operation fails at the gateway.

BalanceSheetWriter corba::cadmin::contract::ContractWriter::getBalanceSheet ( in boolean noWait ) raises (common::OsbCorbaException)

Retrieve an open balance-sheet of a contract.

Parameters:

noWait

Don't wait for database locks?

Exceptions:

OsbCorbaException

if operation to retrieve balance sheet fails at the database.

cadmin::persprod::PersProductWriter corba::cadmin::contract::ContractWriter::getPersProduct	(	in cadmin::PersProdId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Retrieve a personalised product.

Parameters:

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

Returns:: Personalised product writer.

Exceptions:

OsbCorbaException

if personalised product cannot be found.

cadmin::persprod::PersProdSeq corba::cadmin::contract::ContractWriter::getPersProducts ( in boolean noWait ) raises (common::OsbCorbaException)

Retrieve list of personalised products.

common::Utf8String corba::cadmin::contract::ContractWriter::getStatement ( in common::Utf8String fileInfo ) raises (common::OsbCorbaException)

Retrieve a statement.

Parameters:

fileInfo

File information of invoice.

Returns:: Invoice as an Utf8String

Exceptions:

OsbCorbaException

if file I/O operation fails.

InvoiceInfoSeq corba::cadmin::contract::ContractWriter::getStatements	(	in StatementType	type,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Retrieve all statements of a contract based on type of statement.

Parameters:

	type	Type of statement to retrieve.a
	noWait	Don't wait for database locks?

Returns:: List of information about the statements retrieved.

Exceptions:

OsbCorbaException

if I/O operation or database operation fails.

boolean corba::cadmin::contract::ContractWriter::removePersProduct	(	in cadmin::PersProdId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Remove a personalised product.

This function removes a personalised product from the database.

Parameters:

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

Returns:: True if operation is successful.

Exceptions:

OsbCorbaException

is operation fails at the gateway.

StatusValue corba::cadmin::contract::ContractWriter::requestedStatus ( in common::DateTime ts ) raises (common::OsbCorbaException)

Get the requested status for a given time.

Parameters:

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.

boolean corba::cadmin::contract::ContractWriter::setBillCycle ( in BillCycleId bcId )

Set bill cycle of contract.

boolean corba::cadmin::contract::ContractWriter::setCreditLimit ( in common::Money credit )

Set amount of credit limit.

boolean corba::cadmin::contract::ContractWriter::setTaxKey ( in common::TaxKeyId tkId )

Set tax key of contract.

StatusHistory corba::cadmin::contract::ContractWriter::statusHistory	(	in common::DateTime	from,
		in common::DateTime	to,
		in boolean	noWait
	)			raises (common::OsbCorbaException)