#include <OperationObjectBatch.hxx>

Public Types
typedef std::vector < Teamcenter::BulkInput * >	BulkInputList

typedef std::map < OperationDispatcher , OperationObjectBatch >	OpDispatchPtr2OpObjectBatchPtrMap

typedef std::vector < OperationObjectBatch * >	OperationObjectBatchList

typedef std::map< tag_t, OperationDispatcher * >	TypeTag2OpDispatcherPtrMap

Public Member Functions
void	getBulkInputObjects (BulkInputList &bulkInputObjects) const

OperationDispatcher *	getDispatcherObject () const

Static Public Member Functions
static void	deleteOperationObjectBatches (OperationObjectBatchList &objectBatches)

static int	populateOperationBatches (const std::string &operationId, int operationInt, const BulkInputList inputs, OperationObjectBatchList &batches)

static int	populateOperationBatchesForCreate (const std::string &operationID, int operationInt, const BulkInputList inputs, OperationObjectBatchList &batches)

static int	populateOperationBatchesForIslandOfData (const std::string &operationID, int operationInt, const BulkInputList inputs, OperationObjectBatchList &batches)

static int	populateOperationBatchesInternal (const std::string &operationID, int operationInt, const BulkInputList bulkInputs, OperationObjectBatchList &objBatches)

Private Member Functions
void	addBulkInputObjects (const BulkInput *inputObjects)

std::vector < ::Teamcenter::BulkInput * > *	getBulkInputListPrivate ()

	OperationObjectBatch ()

	OperationObjectBatch (const OperationObjectBatch &)

OperationObjectBatch &	operator= (const OperationObjectBatch &)

void	setDispatcherObject (OperationDispatcher *dispatcherObject)

Private Attributes
BulkInputList	m_bulkInputs

OperationDispatcher *	m_operationDispatcher

Friends
class	Teamcenter::BulkDataImpl

class	Teamcenter::TrackBulkOperationContext

Detailed Description

Definition at line 42 of file OperationObjectBatch.hxx.

Member Typedef Documentation

typedef std::vector<Teamcenter::BulkInput*> Teamcenter::OperationObjectBatch::BulkInputList

Definition at line 45 of file OperationObjectBatch.hxx.

typedef std::map<OperationDispatcher*, OperationObjectBatch*> Teamcenter::OperationObjectBatch::OpDispatchPtr2OpObjectBatchPtrMap

Definition at line 47 of file OperationObjectBatch.hxx.

typedef std::vector<OperationObjectBatch*> Teamcenter::OperationObjectBatch::OperationObjectBatchList

Definition at line 46 of file OperationObjectBatch.hxx.

typedef std::map<tag_t, OperationDispatcher*> Teamcenter::OperationObjectBatch::TypeTag2OpDispatcherPtrMap

Definition at line 48 of file OperationObjectBatch.hxx.

Constructor & Destructor Documentation

Teamcenter::OperationObjectBatch::OperationObjectBatch ( )

private

Teamcenter::OperationObjectBatch::OperationObjectBatch ( const OperationObjectBatch & )

private

Copy constructor

Member Function Documentation

void Teamcenter::OperationObjectBatch::addBulkInputObjects ( const BulkInput * inputObjects )

private

Adds the bulk input objects to the created/existing object batches

Parameters

inputObjects (I) The list of BulkInput objects to be added to the object batch

static void Teamcenter::OperationObjectBatch::deleteOperationObjectBatches ( OperationObjectBatchList & objectBatches )

static

Deletes the operation object batches

Parameters

objectBatches (I) The list of OperationObjectBatch objects to be deleted

std::vector< ::Teamcenter::BulkInput*>* Teamcenter::OperationObjectBatch::getBulkInputListPrivate ( )

private

Returns the pointer to enable GenImpl bulk operation dispatcher code to update the BulkInput data while processing nested operations

void Teamcenter::OperationObjectBatch::getBulkInputObjects ( BulkInputList & bulkInputObjects ) const

Retrieves the BulkInput object list from this instance

Parameters

bulkInputObjects (O) The list of BulkInput objects in a OperationObjectBatch

OperationDispatcher* Teamcenter::OperationObjectBatch::getDispatcherObject ( ) const

Retrieves the operation dispatcher object from this instance

OperationObjectBatch& Teamcenter::OperationObjectBatch::operator= ( const OperationObjectBatch & )

private

Assignment operator

static int Teamcenter::OperationObjectBatch::populateOperationBatches	(	const std::string &	operationId,
		int *	operationInt,
		const BulkInputList *	inputs,
		OperationObjectBatchList &	batches
	)

static

Populates the object batches For Delete.
This method is invoked during fnd0BulkDelete / fnd0Refresh / fnd0Lock / fnd0Unlock / fnd0Save

Returns

ITK_ok on success
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if any object type in the bulkInputs does not support the operation specified by operationID or operationInt.
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if operationID is empty and operationInt is "-1".

Parameters

operationId	(I) The operation ID. If it is empty, a valid value must be provided for `operationInt`.
operationInt	(I/O) The operation integer related to the operation ID. br/>If its value is "-1", a valid `operationID` must be provided, and the `operationID` is used to compute the value of `operationInt`.
inputs	(I) The list of BulkInput objects provided for computing the OperationObjectBatch objects
batches	(O) The list of created OperationObjectBatch objects

static int Teamcenter::OperationObjectBatch::populateOperationBatchesForCreate	(	const std::string &	operationID,
		int *	operationInt,
		const BulkInputList *	inputs,
		OperationObjectBatchList &	batches
	)

static

Populates the object batches for Create.
This method is applicable only for Create scenario.

Returns

ITK_ok on success
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if any object type in the bulkInputs does not support the operation specified by operationID or operationInt.
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if operationID is empty and operationInt is "-1".

Parameters

operationID	(I) The operation ID. If it is empty, a valid value must be provided for `operationInt`.
operationInt	(I/O) The operation integer related to the operation ID. If its value is "-1", a valid `operationID` must be provided, and the `operationID` is used to compute the value of `operationInt`.
inputs	(I) The list of BulkInput objects provided for computing the OperationObjectBatch objects
batches	(O) The list of created OperationObjectBatch objects

static int Teamcenter::OperationObjectBatch::populateOperationBatchesForIslandOfData	(	const std::string &	operationID,
		int *	operationInt,
		const BulkInputList *	inputs,
		OperationObjectBatchList &	batches
	)

static

Populates the object batches for Island of Data. The Island of Data includes all the attached Business Objects that will be copied over when the top Business Object is SaveAsed.
This method is applicable only for Save-As scenario.

Returns

ITK_ok on success
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if any object type in the bulkInputs does not support the operation specified by operationID or operationInt.
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if operationID is empty and operationInt is "-1".

Parameters

operationID	(I) The operation ID. If it is empty, a valid value must be provided for `operationInt`.
operationInt	(I/O) The operation integer related to the operation ID. If its value is "-1", a valid `operationID` must be provided, and the `operationID` is used to compute the value of `operationInt`.
inputs	(I) The list of BulkInput objects provided for computing the OperationObjectBatch objects
batches	(O) The list of created OperationObjectBatch objects

static int Teamcenter::OperationObjectBatch::populateOperationBatchesInternal	(	const std::string &	operationID,
		int *	operationInt,
		const BulkInputList *	bulkInputs,
		OperationObjectBatchList &	objBatches
	)

static

Creates the operation batches based on the operation ID and the BulkInput objects.

Returns

ITK_ok on success
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if any object type in the bulkInputs does not support the operation specified by operationID or operationInt.
EXTENSIONFRAMEWORK_Operation_Dispatcher_not_found if operationID is empty and operationInt is "-1".

Parameters

operationID	(I) The operation ID. If it is empty, a valid value must be provided for `operationInt`.
operationInt	(I/O) The operation integer related to the operation ID. If its value is "-1", a valid `operationID` must be provided, and the `operationID` is used to compute the value of `operationInt`.
bulkInputs	(I) The list of BulkInput objects provided for computing the OperationObjectBatch objects
objBatches	(O) The list of created OperationObjectBatch objects

void Teamcenter::OperationObjectBatch::setDispatcherObject ( OperationDispatcher * dispatcherObject )

private

Sets the operation dispatcher associated with the object batch

Parameters

dispatcherObject (I) The operation dispatcher object to be set to the object batch

Friends And Related Function Documentation

friend class Teamcenter::BulkDataImpl

friend

Definition at line 172 of file OperationObjectBatch.hxx.

friend class Teamcenter::TrackBulkOperationContext

friend

Definition at line 173 of file OperationObjectBatch.hxx.

Member Data Documentation

BulkInputList Teamcenter::OperationObjectBatch::m_bulkInputs

private

Definition at line 182 of file OperationObjectBatch.hxx.

OperationDispatcher* Teamcenter::OperationObjectBatch::m_operationDispatcher

private

Definition at line 181 of file OperationObjectBatch.hxx.

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

OperationObjectBatch.hxx

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation