OSB_CORBA::AssociateWriter_i Class Reference

Inheritance diagram for OSB_CORBA::AssociateWriter_i:

[legend]Collaboration diagram for OSB_CORBA::AssociateWriter_i:

[legend]List of all members.

Detailed Description

Servant for CORBA interface AssociateWriter.

Definition at line 77 of file associate_i.h.

Public Member Functions

AssociateWriter_i (AnCList_i &anclist, const OSB_LIB::Associate &assoc)
Constructor.
virtual ~AssociateWriter_i ()
const Locators::Key & key () const
Get the servant key.
virtual AssociateId id () throw (CORBA::SystemException)
Return unique associate id.
virtual Utf8String * name () throw (CORBA::SystemException)
virtual AssociateId parentId () throw (CORBA::SystemException)
Return parent id of associate. Return 0 if no parent.
virtual CORBA::ULong levelId () throw (CORBA::SystemException)
Return level of associate.
virtual AssociateType asType () throw (CORBA::SystemException)
Return type of associate.
virtual AssociateIdSeq * getChildren () throw (CORBA::SystemException)
Get the list of associate children ids.
virtual TaxKeyId tkId () throw (CORBA::SystemException)
Return unique tax key id.
virtual AddressWriter_ptr getAddress (const AddrTypeId &addr) throw (CORBA::SystemException, OsbCorbaException)
Return object reference of an address object.
virtual AddressSeq * getAddresses () throw (CORBA::SystemException, OsbCorbaException)
Return list of addresses.
virtual ContractIdSeq * getContractIds () throw (CORBA::SystemException)
virtual Status effStatus () throw (CORBA::SystemException)
Return effective status of associate.
virtual Status prefStatus () throw (CORBA::SystemException)
Return preferred status of associate.
virtual DateTime * effStatusDate () throw (CORBA::SystemException)
Date and time at which effective status is in effect.
virtual DateTime * prefStatusDate () throw (CORBA::SystemException)
Date and time at which preferred status will take effect.
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 Account * salesLedger () throw (CORBA::SystemException)
Sales ledger of associate.
virtual Account * purchaseLedger () throw (CORBA::SystemException)
Purchase ledger of associate.
virtual Utf8String * accNo () throw (CORBA::SystemException)
Get account number.
virtual CORBA::Boolean addChild (const AssociateId &id, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Add an associate to list of children.
virtual CORBA::Boolean removeChild (const AssociateId &id, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Remove an associate from list of children.
virtual void setTaxKey (const TaxKeyId &id) throw (CORBA::SystemException)
Set tax key.
AddressWriter_ptr getNewAddress (const AddrTypeIdSeq &types) throw (CORBA::SystemException, OsbCorbaException)
Get a new address reference so that new address information can be set.
CORBA::Boolean removeAddress (const AddrTypeId &type, CORBA::Boolean noWait, CfgErrorSeq_out errors) throw (CORBA::SystemException, OsbCorbaException)
Remove an address by type.
CORBA::Boolean linkAddressType (const AddrTypeId &type, const AddrTypeId &newType, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Indicate that the address of an address type is the same as an existing address of another type.
CORBA::Boolean unlinkAddressType (const AddrTypeId &type, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Remove an address type from an address shared by other types of addresses.
virtual void setSalesLedger (const Account &salesLedger) throw (CORBA::SystemException)
Set sales ledger of associate.
virtual void setPurchaseLedger (const Account &purchaseLedger) throw (CORBA::SystemException)
Set purchase ledger of associate.
virtual void setName (const Utf8String &name) throw (CORBA::SystemException)
Set name.
virtual void setAccountNo (const Utf8String &accNo) throw (CORBA::SystemException)
Set account number.
virtual AssociateId create (CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Add associate to list.
virtual CORBA::Boolean commitChanges (CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)
Update changes to the associate 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 associate.

Static Public Attributes

static const std::string IFC

Private Types

typedef std::list< Locators::Key > Servants
Container to store created address servants.

Private Attributes

AnCList_i & ancList_
Reference to AnCList reference.
OSB_LIB::Associate * assoc_
Pointer to associate object.
Locators::Key key_
Associate servant id.
Servants addrList_
List of created address servants.

Member Typedef Documentation

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

Container to store created address servants.

Definition at line 410 of file associate_i.h.

Constructor & Destructor Documentation

OSB_CORBA::AssociateWriter_i::AssociateWriter_i	(	AnCList_i &	anclist,
		const OSB_LIB::Associate &	assoc
	)

Constructor.

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

Member Function Documentation

virtual Utf8String* OSB_CORBA::AssociateWriter_i::accNo ( ) throw (CORBA::SystemException) [virtual]

Get account number.

virtual CORBA::Boolean OSB_CORBA::AssociateWriter_i::addChild	(	const AssociateId &	id,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) `[virtual]`

Add an associate to list of children.

This function adds the child to the list of children in an associate and also updates the database. commitchanges() is not required after this function is called.

Parameters:

	id	Unique id of an associate.
	noWait	Set to false 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 child is not found in list of associates.

virtual AssociateType OSB_CORBA::AssociateWriter_i::asType ( ) throw (CORBA::SystemException) [virtual]

Return type of associate.

CORBA::Boolean OSB_CORBA::AssociateWriter_i::changeStatus	(	StatusRequest &	status,
		CORBA::Boolean	noWait,
		CfgErrorSeq_out	errors
	)			throw (CORBA::SystemException, 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.

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::AssociateWriter_i::checkRefUsage ( ) throw (OsbCorbaException)

Check if corba reference is used illegally.

This function checks that when a temporary associate reference is created via the getNewAssociate 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::AssociateWriter_i::commitChanges ( CORBA::Boolean noWait ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Update changes to the associate permanently into database.

virtual AssociateId OSB_CORBA::AssociateWriter_i::create ( CORBA::Boolean noWait ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Add associate to list.

If associate already exist in database, id of the existing associate will be returned.

Parameters:

noWait

Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.

Returns:: Associate id if addition to list is successful.

Exceptions:

OsbCorbaException

if operation at gateway fails.

virtual Status OSB_CORBA::AssociateWriter_i::effStatus ( ) throw (CORBA::SystemException) [virtual]

Return effective status of associate.

virtual DateTime* OSB_CORBA::AssociateWriter_i::effStatusDate ( ) throw (CORBA::SystemException) [virtual]

Date and time at which effective status is in effect.

virtual AddressWriter_ptr OSB_CORBA::AssociateWriter_i::getAddress ( const AddrTypeId & addr ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return object reference of an address object.

Parameters:

addr

Type of address.

Exceptions:

OsbCorbaException

if address of such type could not be found.

virtual AddressSeq* OSB_CORBA::AssociateWriter_i::getAddresses ( ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return list of addresses.

virtual AssociateIdSeq* OSB_CORBA::AssociateWriter_i::getChildren ( ) throw (CORBA::SystemException) [virtual]

Get the list of associate children ids.

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

Get list of contract ids. This function reads in list of contracts from the database if current contract list is empty.

AddressWriter_ptr OSB_CORBA::AssociateWriter_i::getNewAddress ( const AddrTypeIdSeq & types ) throw (CORBA::SystemException, OsbCorbaException)

Get a new address reference so that new address 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:

types

List of address types that will have the same details.

Returns:: Address reference.

virtual AssociateId OSB_CORBA::AssociateWriter_i::id ( ) throw (CORBA::SystemException) [virtual]

Return unique associate id.

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

Get the servant key.

Definition at line 93 of file associate_i.h.

References key_.

virtual CORBA::ULong OSB_CORBA::AssociateWriter_i::levelId ( ) throw (CORBA::SystemException) [virtual]

Return level of associate.

CORBA::Boolean OSB_CORBA::AssociateWriter_i::linkAddressType	(	const AddrTypeId &	type,
		const AddrTypeId &	newType,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Indicate that the address of an address type is the same as an existing address of another type.

If new address to be linked already exist, it will be removed and added to the intended address.

Parameters:

	type	Type of current address.
	newType	The new type to be added to current address.
	noWait	Set to false 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 at the database fails.

virtual Utf8String* OSB_CORBA::AssociateWriter_i::name ( ) throw (CORBA::SystemException) [virtual]

Return name of associate

virtual AssociateId OSB_CORBA::AssociateWriter_i::parentId ( ) throw (CORBA::SystemException) [virtual]

Return parent id of associate. Return 0 if no parent.

virtual Status OSB_CORBA::AssociateWriter_i::prefStatus ( ) throw (CORBA::SystemException) [virtual]

Return preferred status of associate.

virtual DateTime* OSB_CORBA::AssociateWriter_i::prefStatusDate ( ) throw (CORBA::SystemException) [virtual]

Date and time at which preferred status will take effect.

virtual Account* OSB_CORBA::AssociateWriter_i::purchaseLedger ( ) throw (CORBA::SystemException) [virtual]

Purchase ledger of associate.

CORBA::Boolean OSB_CORBA::AssociateWriter_i::removeAddress	(	const AddrTypeId &	type,
		CORBA::Boolean	noWait,
		CfgErrorSeq_out	errors
	)			throw (CORBA::SystemException, OsbCorbaException)

Remove an address by type.

Parameters:

	type	Type of address to remove.
	noWait	Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.
	errors	Contains list of errors if operation return false.

Returns:: True if operation is successful.

Exceptions:

OsbCorbaException

if operation at the database fails.

virtual CORBA::Boolean OSB_CORBA::AssociateWriter_i::removeChild	(	const AssociateId &	id,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) `[virtual]`

Remove an associate from list of children.

This function removes the child from the list of children in an associate and also updates the database. commitchanges() is not required after this function is called.

Parameters:

	id	Unique id of an associate.
	noWait	Set to false 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 child is not found in list of associates.

virtual StatusValue OSB_CORBA::AssociateWriter_i::requestedStatus ( const DateTime & ts ) throw (CORBA::SystemException, OsbCorbaException) [virtual]

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.

virtual Account* OSB_CORBA::AssociateWriter_i::salesLedger ( ) throw (CORBA::SystemException) [virtual]

Sales ledger of associate.

virtual void OSB_CORBA::AssociateWriter_i::setAccountNo ( const Utf8String & accNo ) throw (CORBA::SystemException) [virtual]

Set account number.

virtual void OSB_CORBA::AssociateWriter_i::setName ( const Utf8String & name ) throw (CORBA::SystemException) [virtual]

Set name.

virtual void OSB_CORBA::AssociateWriter_i::setPurchaseLedger ( const Account & purchaseLedger ) throw (CORBA::SystemException) [virtual]

Set purchase ledger of associate.

virtual void OSB_CORBA::AssociateWriter_i::setSalesLedger ( const Account & salesLedger ) throw (CORBA::SystemException) [virtual]

Set sales ledger of associate.

virtual void OSB_CORBA::AssociateWriter_i::setTaxKey ( const TaxKeyId & id ) throw (CORBA::SystemException) [virtual]

Set tax key.

StatusHistory* OSB_CORBA::AssociateWriter_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 be retrieved(inclusive).
	to	End period of list to be retrieved(exclusive).
	noWait	Wait for database locks: false if yes.

Returns:: list of status changes.

Exceptions:

OsbCorbaException

if operation to retrieve status changes fails at the database.

virtual TaxKeyId OSB_CORBA::AssociateWriter_i::tkId ( ) throw (CORBA::SystemException) [virtual]

Return unique tax key id.

CORBA::Boolean OSB_CORBA::AssociateWriter_i::unlinkAddressType	(	const AddrTypeId &	type,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Remove an address type from an address shared by other types of addresses.

This function will result in a new record with the address type being created after successful removal from the address shared by other address types.

Parameters:

	type	Type of address to remove.
	noWait	Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.