zeus::ISimpleCommand Class Reference

#include <ISimpleCommand.hpp>

Inheritance diagram for zeus::ISimpleCommand:

List of all members.

Public Member Functions
virtual void MQUALIFIER	getTargetObjectName (IString &rstrName) const =0
virtual void MQUALIFIER	getMainData (IString &rstrData) const =0
virtual void MQUALIFIER	getAddData (IString &rstrData) const =0
virtual void MQUALIFIER	getStream (IString &rstrData) const =0
virtual Uint MQUALIFIER	getMode () const =0
virtual Uint MQUALIFIER	getSecurity () const =0
virtual void MQUALIFIER	setTargetObjectName (const IString &rstrName)=0
virtual void MQUALIFIER	setMainData (const IString &rstrData)=0
virtual void MQUALIFIER	setAddData (const IString &rstrData)=0
virtual void MQUALIFIER	setStream (const IString &rstrData)=0
virtual void MQUALIFIER	setMode (Uint uiMode)=0
virtual void MQUALIFIER	setSecurity (Uint uiValue)=0
virtual void MQUALIFIER	execute (Uint uiMode)=0
virtual void MQUALIFIER	enableExecuteMode (bool bEnable, Uint uiMode)=0
virtual Retval MQUALIFIER	setListener (IXObject *pListener)=0

---

Detailed Description

The simple command interface is used to define and execute commands for the framework. This commands are the base architecture for actions of the framework.

---

Member Function Documentation

virtual void MQUALIFIER zeus::ISimpleCommand::enableExecuteMode	(	bool	bEnable,
		Uint	uiMode
	)		[pure virtual]

This method can enable or disable the execution with a specific mode

Parameters:

bEnable,:	true = enabled, false = block
uiMode,:	execution mode (see execute())

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::execute

(

Uint

uiMode )

[pure virtual]

Executes the command. The command it self can have a command listener interface. The listener will receive the command if this method is called.

Parameters:

uiMode,:

mode of execution

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::getAddData

(

IString &

rstrData )

const [pure virtual]

returns the additional data item of the command

Parameters:

rstrData,:

return parameter for additional data

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::getMainData

(

IString &

rstrData )

const [pure virtual]

Returns the main data item of the command

Parameters:

rstrData,:

return parameter for main data

Implemented in zeus::TSimpleCommand.

virtual Uint MQUALIFIER zeus::ISimpleCommand::getMode

(

)

const [pure virtual]

Returns the mode of the command to execute. This tells the meaning of the data items.

Returns:

mode of the command

Implemented in zeus::TSimpleCommand.

virtual Uint MQUALIFIER zeus::ISimpleCommand::getSecurity

(

)

const [pure virtual]

Returns the security level for this command

Returns:

security level

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::getStream

(

IString &

rstrData )

const [pure virtual]

Returns the special data stream of a command. The stream may represent a unparsed xml document or just a text document such as ini, txt etc.

Parameters:

rstrData,:

return parameter for the document

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::getTargetObjectName

(

IString &

rstrName )

const [pure virtual]

Returns the name of a target object. This name tells for which xobject this command must be used.

Parameters:

rstrName,:

return parameter of the target object name

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setAddData

(

const IString &

rstrData )

[pure virtual]

Sets the additional data item

Parameters:

rstrData,:

additional data

Implemented in zeus::TSimpleCommand.

virtual Retval MQUALIFIER zeus::ISimpleCommand::setListener

(

IXObject *

pListener )

[pure virtual]

Sets the listener interface. Only one listener can be registered.

Parameters:

pListener,:

Listener interface

Return values:

RET_NOERROR,:	Listener registered
RET_INVALID_PARAMETER,:	Invalid parameter received

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setMainData

(

const IString &

rstrData )

[pure virtual]

Sets the main data stream

Parameters:

rstrData,:

main data object

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setMode

(

Uint

uiMode )

[pure virtual]

Sets the mode of the simple command

Parameters:

uiMode,:

new mode

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setSecurity

(

Uint

uiValue )

[pure virtual]

Sets the security level of the command

Parameters:

uiValue,:

security value

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setStream

(

const IString &

rstrData )

[pure virtual]

Sets the special data stream object, (document)

Parameters:

rstrData,:

data stream

Implemented in zeus::TSimpleCommand.

virtual void MQUALIFIER zeus::ISimpleCommand::setTargetObjectName

(

const IString &

rstrName )

[pure virtual]

Sets the name of the target object

Parameters:

rstrName,:

name of the target object

Implemented in zeus::TSimpleCommand.

---

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

• ISimpleCommand.hpp