#include <XMLBatchProcessor.h>

Inheritance diagram for zeus::TXMLBatchProcessor:

Public Member Functions
	TXMLBatchProcessor ()
	TXMLBatchProcessor (IBatchContext &rContext)
IBatchContext &	getContext ()
const IBatchContext &	getContext () const
Retval	getProject (IXProcProject *&rpProject) const
Retval	loadProject (const IString &rXMLFile)
Retval	loadProjectFromStream (const IString &rXMLStream)
Retval	processTarget (const IString &rTargetName)
Retval	processTarget (const IString &rTargetName, IXProcessMonitor &rMonitor)
Retval	processTargetWithoutAbort (const IString &rTargetName)
Retval	processTargetWithoutAbort (const IString &rTargetName, IXProcessMonitor &rMonitor)
Retval	processDryRun (const IString &rTargetName, IXProcessMonitor &rMonitor)
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Protected Member Functions
virtual	~TXMLBatchProcessor ()
void	releaseInstances ()
virtual void MQUALIFIER	onProcessingTargetStarted (IXProcTarget &, IXProcess::EProcessingMode)
virtual void MQUALIFIER	onProcessingTargetEnded (IXProcTarget &, Retval)
virtual void MQUALIFIER	onProcessingGroupStarted (IXProcess &, IXProcess::EProcessingMode)
virtual void MQUALIFIER	onProcessingGroupEnded (IXProcess &, Retval)
virtual void MQUALIFIER	onProcessing (IXProcess &, const IString &, const IString &, bool, EMonitorErrorLevel)

Detailed Description

The batch processor is used to process a xml batch

Constructor & Destructor Documentation

TXMLBatchProcessor::TXMLBatchProcessor ( )

creates a new batch processor

TXMLBatchProcessor::TXMLBatchProcessor ( IBatchContext & rContext )

creates a new batch processor

TXMLBatchProcessor::~TXMLBatchProcessor ( ) [protected, virtual]

destroys the batch processor

Member Function Documentation

virtual void MQUALIFIER zeus::TXMLBatchProcessor::addRef ( ) const [virtual]

See also:: IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual Retval MQUALIFIER zeus::TXMLBatchProcessor::askForInterface	(	const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		`[virtual]`

See also:: IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

IBatchContext & zeus::TXMLBatchProcessor::getContext ( ) [inline]

Returns the batch context object

const IBatchContext & zeus::TXMLBatchProcessor::getContext ( ) const [inline]

Returns the batch context object

Retval TXMLBatchProcessor::getProject ( IXProcProject *& rpProject ) const

Returns the loaded project

Parameters:

rpProject : Loaded project

Return values:

RET_NOERROR	: project returned
RET_REQUEST_FAILED	: No project loaded

Retval TXMLBatchProcessor::loadProject ( const IString & rXMLFile )

loads a processing project from XML file

Parameters:

rXMLFile : path and name of the XML file

Return values:

RET_NOERROR	: Project loaded
RET_REQUEST_FAILED	: Could not load xml file

Retval TXMLBatchProcessor::loadProjectFromStream ( const IString & rXMLStream )

loads a processing project from XML Stream

Parameters:

rXMLStream : stream containing an XML

Return values:

RET_NOERROR	: Project loaded
RET_REQUEST_FAILED	: Could not load xml stream

virtual void MQUALIFIER zeus::TXMLBatchProcessor::onProcessing	(	IXProcess &	rProcess,
		const IString &	rActionKey,
		const IString &	rActionValue,
		bool	bFailOnError,
		EMonitorErrorLevel	eErrorState
	)		`[inline, protected, virtual]`

callback if a process step has been executed.

Parameters:

rProcess	: process instance
rActionKey	: Type of action
rActionValue	: value or parameters of action
bFailOnError	: Flag if the error will stop the processing
eErrorState	: error state

Implements zeus::IXProcessMonitor.

virtual void MQUALIFIER zeus::TXMLBatchProcessor::onProcessingGroupEnded	(	IXProcess &	rGroup,
		Retval	retValue
	)		`[inline, protected, virtual]`

callback if a group processing has been ended

Parameters:

rGroup	: group instance
retValue	: processing return value

Implements zeus::IXProcessMonitor.

virtual void MQUALIFIER zeus::TXMLBatchProcessor::onProcessingGroupStarted	(	IXProcess &	rGroup,
		IXProcess::EProcessingMode	eMode
	)		`[inline, protected, virtual]`

callback if a group processing has been started

Parameters:

rGroup	: group instance
eMode	: processing mode

Implements zeus::IXProcessMonitor.

virtual void MQUALIFIER zeus::TXMLBatchProcessor::onProcessingTargetEnded	(	IXProcTarget &	rTarget,
		Retval	retValue
	)		`[inline, protected, virtual]`

callback if a target processing has been ended

Parameters:

rTarget	: target instance
retValue	: processing return value

Implements zeus::IXProcessMonitor.

virtual void MQUALIFIER zeus::TXMLBatchProcessor::onProcessingTargetStarted	(	IXProcTarget &	rTarget,
		IXProcess::EProcessingMode	eMode
	)		`[inline, protected, virtual]`

callback if a target processing has been started

Parameters:

rTarget	: target instance
eMode	: processing mode

Implements zeus::IXProcessMonitor.

Retval TXMLBatchProcessor::processDryRun	(	const IString &	rTargetName,
		IXProcessMonitor &	rMonitor
	)

processes a target in the dry-run-mode. No effective work will be done. This can be used to initialize the monitoring object (like progress bars or status information pre processing).

Parameters:

rTargetName	: Name of the target to process
rMonitor	: processing monitor

Return values:

RET_NOERROR	: target processed
RET_REQUEST_FAILED	: Could not process target
RET_NOT_READY,:	Project not loaded

Retval TXMLBatchProcessor::processTarget	(	const IString &	rTargetName,
		IXProcessMonitor &	rMonitor
	)

processes a target

Parameters:

rTargetName	: Name of the target to process
rMonitor	: processing monitor

Return values:

RET_NOERROR	: target processed
RET_REQUEST_FAILED	: Could not process target
RET_NOT_READY,:	Project not loaded

Retval zeus::TXMLBatchProcessor::processTarget ( const IString & rTargetName ) [inline]

processes a target

Parameters:

rTargetName : Name of the target to process

Return values:

RET_NOERROR	: target processed
RET_REQUEST_FAILED	: Could not process target
RET_NOT_READY,:	Project not loaded

Retval zeus::TXMLBatchProcessor::processTargetWithoutAbort ( const IString & rTargetName ) [inline]

processes a target without abort

Parameters:

rTargetName : Name of the target to process

Return values:

RET_NOERROR	: target processed
RET_REQUEST_FAILED	: Could not process target
RET_NOT_READY,:	Project not loaded

Retval TXMLBatchProcessor::processTargetWithoutAbort	(	const IString &	rTargetName,
		IXProcessMonitor &	rMonitor
	)

processes a target without abort

Parameters:

rTargetName	: Name of the target to process
rMonitor	: processing monitor

Return values:

RET_NOERROR	: target processed
RET_REQUEST_FAILED	: Could not process target
RET_NOT_READY,:	Project not loaded

virtual void MQUALIFIER zeus::TXMLBatchProcessor::release ( ) const [virtual]

See also:: IZUnknown::release

Reimplemented from zeus::TZObject.

void TXMLBatchProcessor::releaseInstances ( ) [protected]

releases all instances

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

zeus::TXMLBatchProcessor Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation