All Frameworks Class Hierarchy This Framework Indexes Previous Next

BatchInfrastructure Interface CATIBatchCAA

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIBatchCAA

Interface giving access to the xml files of your batch.
Role: to be used within your batch to retrieve the data contained in the descriptor and parameters XML files. It allows your batch to know its inputs ans its ouputs and other informations about your batch.

See also:: ,

Method Index

o get_Description(CATUnicodeString&): Retrieves the description of the batch.
o get_InputParametersCAA(CATIBatchElementCAA*&): Retrieves an interface describing your inputs.
o get_Name(CATUnicodeString&): Retrieves the name of the batch.
o get_OutputParametersCAA(CATIBatchElementCAA*&): Retrieves an interface describing your outputs.
o get_UUID(CATUnicodeString&): Retrieves the uuid of the running batch.

Methods

o get_Description

public virtual get_Description( oDescription)

Retrieves the description of the batch.
Role: This method retrieves the attribute "description" of the "batch" node in your XML descriptor file.

Parameters:

oDescription: description to be retrieved

o get_InputParametersCAA

public virtual get_InputParametersCAA( oInputParameters)

Retrieves an interface describing your inputs.
Role: This method retrieves an interface CATIBatchElementCAA representing the InputParameters node in your XML parameter file.

Parameters:

oInputParameters: Interface to be retrieved

o get_Name

public virtual get_Name( oName)

Retrieves the name of the batch.
Role: This method retrieves the attribute "name" of the "batch" node in your XML descriptor file.

Parameters:

oName: name to be retrieved

o get_OutputParametersCAA

public virtual get_OutputParametersCAA( oOutputParameters)

Retrieves an interface describing your outputs.
Role: This method retrieves an interface CATIBatchElementCAA representing the OutputParameters node in your XML parameter file.

Parameters:

oOutputParameters: Interface to be retrieved

o get_UUID

public virtual get_UUID( oUUID)

Retrieves the uuid of the running batch.
Role: This method retrieves the uuid generated for a each batch execution.

Parameters:

oUUID: uuid to be retrieved

This object is included in the file: CATIBatchCAA.h
If needed, your Imakefile.mk should include the module: CATIABatImpl