tmozIDomainComponent Interface Reference

Domain component. More...

List of all members.

Public Member Functions
void	onRegister (in tmozIException tmozException)
	Called on component registration.
void	onConfigure (in tmozIException tmozException)
	Called on component configuration.
void	onUnregister ()
	Called on component unregistration.
long	onReceivedObject (in tmozIActionObject tmozActionObject, in tmozIException tmozException)
	On received action object Function is called by framework to route action object to the component.
boolean	onCommand (in AString commandId)
	Called on command.
boolean	onUpdateCommand (in AString commandId, in tmozIUpdateCommand update)
	Called to update command.
Public Attributes
readonly attribute AString	name
	Component name.
readonly attribute boolean	canUnregister
	Unregister state.

---

Detailed Description

Domain component.

This is domain specific component. Component is activated during domain activation. Method onRegister is called immidietly after component registration. Method onConfigure is called after login.

---

Member Function Documentation

boolean onCommand

(

in AString

commandId

)

Called on command.

Called when user clicked on specific command in menu or on toolbar.

Parameters:

commandId

Command ID

Returns:

Return true if command was processed. Return false if command was not processed.

void onConfigure

(

in tmozIException

tmozException

)

Called on component configuration.

This method is called immidietly after succesfull login. Method is called after all component registration. It is also called in offline mode.

Note:

Do not call method directly.

Parameters:

tmozException

Exception object to return any error state

Exceptions:

tmozException

If initialization fail component should throw exception and set error description in the tmozException object.

long onReceivedObject	(	in tmozIActionObject	tmozActionObject,
		in tmozIException	tmozException
	)

On received action object Function is called by framework to route action object to the component.

Parameters:

	tmozActionObject	action object
	tmozException	Exception object to return any error state

Exceptions:

tmozException

If processing failure component should throw exception and set error description in the tmozException object.

Returns:

Function returns processing status.

• 0 object was not processed
• 1 object was processed
• 2 object was processed with error

void onRegister

(

in tmozIException

tmozException

)

Called on component registration.

This method is called from the registrator and allows to initialize component. Do not call it directly.

Parameters:

tmozException

Exception object to return any error state

Exceptions:

tmozException

If initialization fail component should throw exception and set error description in the tmozException object.

void onUnregister

(

)

Called on component unregistration.

This method is called by component registrator when component should unregister. Do not call this method directly.

This method should not failed or throw exception.

boolean onUpdateCommand	(	in AString	commandId,
		in tmozIUpdateCommand	update
	)

Called to update command.

Called to update state of specific command in menu or on toolbar.

Parameters:

	commandId	Command ID
	update	Object with command state.

Returns:

Return true if command update was processed. Return false if command update was not processed.

---

Member Data Documentation

readonly attribute boolean canUnregister

Unregister state.

Check if component can be unregistered

readonly attribute AString name

Component name.

Unique name of the component