Smartswitch::Peer::Company Interface Reference

The interface to manipulate with the partner Company. More...

defined in <Company.ice>

interface Company extends Smartswitch::Destroyable { ... }

Inheritance diagram for Smartswitch::Peer::Company:

Collaboration diagram for Smartswitch::Peer::Company:

Operations
Billing::CurrencyAmountSequence	getBalance (CompanyBalance which) throws AccessException
	Obtain the current Company balance. More...
idempotent long	getId ()
	Obtain the unique constant ID of a Company. More...
idempotent string	getName () throws AccessException
	Obtain the name of a Company. More...
bool	isActivated ()
	Check if the Company is currently active. More...
bool	refill (ApplyToBalance apply, Billing::Service *service, Billing::CurrencyAmount amount) throws AccessException
	Refill the Company balance. More...
void	setActivated (bool activated)
	Activate the Company. More...
bool	writeOff (ApplyToBalance apply, Billing::Service *service, Billing::CurrencyAmount amount) throws AccessException
	Write-off from the Company balance. More...
Operations inherited from Smartswitch::Destroyable
void	destroy ()
	Destroy the proxy entity at the Smartswitch side. More...

Detailed Description

The interface to manipulate with the partner Company.

Operation Documentation

getBalance()

Billing::CurrencyAmountSequence getBalance

(

CompanyBalance

which

)

throws AccessException

Obtain the current Company balance.

Parameters

which

Which Company balance to obtain

Returns

Current balance of a Company.

getId()

idempotent long getId

(

)

Obtain the unique constant ID of a Company.

Returns

unique ID of a Company

getName()

idempotent string getName

(

)

throws AccessException

Obtain the name of a Company.

Returns

name of a Company

isActivated()

bool isActivated

(

)

Check if the Company is currently active.

Returns

true if the Company is activated.

See also

setActivated()

refill()

bool refill	(	ApplyToBalance	apply,
		Billing::Service *	service,
		Billing::CurrencyAmount	amount
	)		throws AccessException

Refill the Company balance.

Parameters

apply	Which balance to refill
service	Which Service to bind to this transaction
amount	The amount to refill the Company balance

Returns

true if operation finished successfully.

setActivated()

void setActivated

(

bool

activated

)

Activate the Company.

When the Company is activated, we may perform periodical write-offs of a subscriber fee (if configured).
When the Company is deactivated, we will block the services provision.

See also

isActivated()

writeOff()

bool writeOff	(	ApplyToBalance	apply,
		Billing::Service *	service,
		Billing::CurrencyAmount	amount
	)		throws AccessException

Write-off from the Company balance.

Parameters

apply	Which balance to write-off from
service	Which Service to bind to this transaction (will be reflected in the invoice to the Company)
amount	The amount to write-off the Company balance

Returns

true if operation finished successfully.

---

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

• /usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Peer/Company.ice