corba::cadmin::assoc::AssociateWriter Interface Reference

Inheritance diagram for corba::cadmin::assoc::AssociateWriter:

[legend]Collaboration diagram for corba::cadmin::assoc::AssociateWriter:

[legend]List of all members.

Detailed Description

Interface to provide read and write access to associates.

Definition at line 46 of file associate.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.
cadmin::addr::AddressWriter getAddress (in cadmin::addr::AddrTypeId type) raises (common::OsbCorbaException)
Retrieve an address reference based on the adderss type.
cadmin::addr::AddressSeq getAddresses () raises (common::OsbCorbaException)
List of addresses for each associate.
cadmin::addr::AddressWriter getNewAddress (in cadmin::addr::AddrTypeIdSeq types) raises (common::OsbCorbaException)
Get a new address reference so that new address information can be set.
boolean removeAddress (in cadmin::addr::AddrTypeId type, in boolean noWait, out common::CfgErrorSeq errors) raises (common::OsbCorbaException)
Remove an address by type.
boolean linkAddressType (in cadmin::addr::AddrTypeId type, in cadmin::addr::AddrTypeId newType, in boolean noWait) raises (common::OsbCorbaException)
Indicate that the address of an address type is the same as an existing address of another type.
boolean unlinkAddressType (in cadmin::addr::AddrTypeId type, in boolean noWait) raises (common::OsbCorbaException)
Remove an address type from an address shared by other types of addresses.
cadmin::contract::ContractIdSeq getContractIds ()
List of contract ids for each associate.
boolean addChild (in AssociateId id, in boolean noWait) raises (common::OsbCorbaException)
Add associate to list of children.
boolean removeChild (in AssociateId id, in boolean noWait) raises (common::OsbCorbaException)
Remove an associate from list of children.
void setTaxKey (in common::TaxKeyId tId)
Set tax key used by associate.
void setSalesLedger (in common::Account salesLedger)
Set sales ledger of associate.
void setPurchaseLedger (in common::Account purchaseLedger)
Set purchase ledger of associate.
void setName (in common::Utf8String name)
Set name of associate.
void setAccountNo (in common::Utf8String accNo)
Set account number of associate.
AssociateId create (in boolean noWait) raises (common::OsbCorbaException)
Add an associate to list and create the associate in the database.
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 AssociateId id
Unique id of associate.
readonly attribute common::Utf8String name
Name name of associate.
readonly attribute AssociateId parentId
Id of parent associate.
readonly attribute unsigned
long levelId
Return level of associate.
readonly attribute AssociateType asType
Return type of associate.
readonly attribute AssociateIdSeq getChildren
Children associates.
readonly attribute common::TaxKeyId tkId
Tax key id.
readonly attribute Status effStatus
Current effective status of associate.
readonly attribute Status prefStatus
Current preferred status of associate.
readonly attribute common::DateTime effStatusDate
Date and time at which associate will be in effect.
readonly attribute common::DateTime prefStatusDate
readonly attribute common::Account salesLedger
Sales ledger of an associate.
readonly attribute common::Account purchaseLedger
Purchase ledger of an associate.
readonly attribute common::Utf8String accNo
Retrieve account number.

Member Function Documentation

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

Add associate to list of children.

Updates database as well. commitChanges() is not required after this function is called.

Parameters:

	id	Unique id of associate.
	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 child is not found in the list of associates.

boolean corba::cadmin::assoc::AssociateWriter::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.

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::assoc::AssociateWriter::commitChanges ( in boolean noWait ) raises (common::OsbCorbaException)

Update changes permanently into database.

AssociateId corba::cadmin::assoc::AssociateWriter::create ( in boolean noWait ) raises (common::OsbCorbaException)

Add an associate to list and create the associate in the database.

If associate already exist in database, unique 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 is successfull.

Exceptions:

OsbCorbaException

if operation at the gateway fails.

cadmin::addr::AddressWriter corba::cadmin::assoc::AssociateWriter::getAddress ( in cadmin::addr::AddrTypeId type ) raises (common::OsbCorbaException)

Retrieve an address reference based on the adderss type.

Parameters:

type

Type of address.

Exceptions:

OsbCorbaException

if no address for the specific type can be found.

cadmin::addr::AddressSeq corba::cadmin::assoc::AssociateWriter::getAddresses ( ) raises (common::OsbCorbaException)

List of addresses for each associate.

cadmin::contract::ContractIdSeq corba::cadmin::assoc::AssociateWriter::getContractIds ( )

List of contract ids for each associate.

Returns:: List of contract ids under this associate.

cadmin::addr::AddressWriter corba::cadmin::assoc::AssociateWriter::getNewAddress ( in cadmin::addr::AddrTypeIdSeq types ) raises (common::OsbCorbaException)

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

This function is used only when a user needs an address writer in order to set the attributes of the address. 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 address details.

Returns:: Address reference.

boolean corba::cadmin::assoc::AssociateWriter::linkAddressType	(	in cadmin::addr::AddrTypeId	type,
		in cadmin::addr::AddrTypeId	newType,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

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

If the type of address to be linked already exist, it will be removed from the old address and added to the new address.

Parameters:

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

boolean corba::cadmin::assoc::AssociateWriter::removeAddress	(	in cadmin::addr::AddrTypeId	type,
		in boolean	noWait,
		out common::CfgErrorSeq	errors
	)			raises (common::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.

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

Remove an associate from list of children.

Updates database as well. commitChanges() is not required after this function is called.

Parameters:

	id	Unique id of associate.
	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 child is not found in the list of associates.

StatusValue corba::cadmin::assoc::AssociateWriter::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.

void corba::cadmin::assoc::AssociateWriter::setAccountNo ( in common::Utf8String accNo )

Set account number of associate.

void corba::cadmin::assoc::AssociateWriter::setName ( in common::Utf8String name )

Set name of associate.

void corba::cadmin::assoc::AssociateWriter::setPurchaseLedger ( in common::Account purchaseLedger )

Set purchase ledger of associate.

void corba::cadmin::assoc::AssociateWriter::setSalesLedger ( in common::Account salesLedger )

Set sales ledger of associate.

void corba::cadmin::assoc::AssociateWriter::setTaxKey ( in common::TaxKeyId tId )

Set tax key used by associate.

StatusHistory corba::cadmin::assoc::AssociateWriter::statusHistory	(	in common::DateTime	from,
		in common::DateTime	to,
		in boolean	noWait
	)			raises (common::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.

boolean corba::cadmin::assoc::AssociateWriter::unlinkAddressType	(	in cadmin::addr::AddrTypeId	type,
		in boolean	noWait
	)			raises (common::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.