#include <BusinessObject.hxx>

Inheritance diagram for Teamcenter::BusinessObject:

Public Member Functions
int	create (::Teamcenter::CreateInput *creInput)

int	createPost (::Teamcenter::CreateInput *creInput)

int	finalizeCreateInput (::Teamcenter::CreateInput *creInput)

int	finalizeSaveAsInput (::Teamcenter::SaveAsInput pSavAsInput, std::vector< ::Teamcenter::DeepCopyData > *vecDeepCopyData)

int	fnd0AskSRUid (std::string uid, bool isFirstTime) const

int	fnd0GenerateRecipe (std::string *recipe)

int	fnd0GetChildren (const std::vector< std::string > propertyNames, std::vector< tag_t > childTags, std::vector< std::string > *childContextPropertyNames)

int	fnd0GetSerializationState (bool *currentState) const

int	fnd0IsRecoverable (bool isPersistedRecipe, bool isRecoverableIDSupported) const

int	fnd0SetSerializationState (bool newState, bool *stateChanged)

int	fnd0SetSRUid (const std::string *uid)

int	getChar (const std::string &charName, char &charRetValue, bool &isNull, bool &hasReadAccess)

int	getChar (const std::string &charName, char &charRetValue, bool &isNull)

int	getCharArray (const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getCharArray (const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals)

int	getDate (const std::string &dateName, date_t &dateRetValue, bool &isNull, bool &hasReadAccess)

int	getDate (const std::string &dateName, date_t &dateRetValue, bool &isNull)

int	getDateArray (const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull, bool &hasReadAccess)

int	getDateArray (const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull)

int	getDeepCopyData (const std::string operation, std::vector< ::Teamcenter::DeepCopyData > *deepCopyDatas)

int	getDouble (const std::string &doubleName, double &doubleRetValue, bool &isNull, bool &hasReadAccess)

int	getDouble (const std::string &doubleName, double &doubleRetValue, bool &isNull)

int	getDoubleArray (const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getDoubleArray (const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals)

int	getInt (const std::string &intName, int &intRetValue, bool &isNull, bool &hasReadAccess)

int	getInt (const std::string &intName, int &intRetValue, bool &isNull)

int	getIntArray (const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getIntArray (const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals)

int	getLogical (const std::string &logicalName, bool &boolRetValue, bool &isNull, bool &hasReadAccess)

int	getLogical (const std::string &logicalName, bool &boolRetValue, bool &isNull)

int	getLogicalArray (const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getLogicalArray (const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals)

int	getObject_string (std::string &value, bool &isNull) const

virtual RuntimeBusinessObjectImpl *	getRuntimeBusinessObjectImpl () const

int	getString (const std::string &stringName, std::string &stringRetValue, bool &isNull, bool &hasReadAccess)

int	getString (const std::string &stringName, std::string &stringRetValue, bool &isNull)

int	getStringArray (const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getStringArray (const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals)

tag_t	getTag () const

int	getTag (const std::string &tagName, tag_t &tagRetValue, bool &isNull, bool &hasReadAccess)

int	getTag (const std::string &tagName, tag_t &tagRetValue, bool &isNull)

int	getTagArray (const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals, bool &hasReadAccess)

int	getTagArray (const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals)

const std::string &	getTypeName () const

tag_t	getTypeTag () const

int	invokeOperation (const std::string *operationId,...)

int	invokeOperation (const std::string &operationId, va_list args)

int	invokeOperation (int operationIdInt, va_list args)

int	invokeOperation (const std::string &operationId, std::vector< void * > &args)

int	invokeOperation (int operationIdInt, std::vector< void * > &args)

int	performDeepCopy (::Teamcenter::OperationInput pOperationInput, std::vector< ::Teamcenter::DeepCopyData > *vecDeepCopyData)

int	saveAs (::Teamcenter::SaveAsInput pSavAsInput, std::vector< ::Teamcenter::DeepCopyData > vecDeepCopyData, tag_t newObjTag)

int	saveAsPost (::Teamcenter::SaveAsInput pSavAsInput, std::vector< ::Teamcenter::DeepCopyData > *vecDeepCopyData)

int	setChar (const std::string &charName, const char &charValue, bool isNull)

int	setCharArray (const std::string &charArrayName, const std::vector< char > &vectorCharVals, const std::vector< int > *vectorIsNullVals)

int	setDate (const std::string &dateName, const date_t &dateValue, bool isNull)

int	setDateArray (const std::string &dateArrayName, const std::vector< date_t > &vectorDateVals, const std::vector< int > *vectorIsNullVals)

int	setDouble (const std::string &doubleName, const double &doubleValue, bool isNull)

int	setDoubleArray (const std::string &doubleArrayName, const std::vector< double > &vectorDoubleVals, const std::vector< int > *vectorIsNullVals)

int	setInt (const std::string &intName, const int &intValue, bool isNull)

int	setIntArray (const std::string &intArrayName, const std::vector< int > &vectorIntVals, const std::vector< int > *vectorIsNullVals)

int	setLogical (const std::string &logicalName, const bool logicalValue, bool isNull)

int	setLogicalArray (const std::string &boolArrayName, const std::vector< int > &vectorboolVals, const std::vector< int > *vectorIsNullVals)

int	setPropertiesFromCreateInput (::Teamcenter::CreateInput *creInput)

int	setPropertiesFromSaveAsInput (::Teamcenter::SaveAsInput *pSavAsInput)

int	setString (const std::string &stringName, const std::string &stringValue, bool isNull)

int	setStringArray (const std::string &stringArrayName, const std::vector< std::string > &vectorStringVals, const std::vector< int > *vectorIsNullVals)

int	setTag (const std::string &tagName, const tag_t &tagValue, bool isNull)

int	setTagArray (const std::string &tagArrayName, const std::vector< tag_t > &vectorTagVals, const std::vector< int > *vectorIsNullVals)

int	validateCreateInput (::Teamcenter::CreateInput *creInput)

int	validateSaveAsInput (::Teamcenter::SaveAsInput pSavAsInput, std::vector< ::Teamcenter::DeepCopyData > *vecDeepCopyData)

Static Public Member Functions
static int	fnd0Create (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0CreatePost (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0FinalizeCreateInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0FinalizeSaveAsInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0GetDeepCopyData (std::vector< ::Teamcenter::BulkInput * > getDeepCopydata,::Teamcenter::BulkData bd)

static int	fnd0PerformDeepCopy (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0SaveAs (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0SaveAsPost (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0SetPropertiesFromCreateInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0SetPropertiesFromSaveAsInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0ValidateCreateInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static int	fnd0ValidateSaveAsInput (std::vector< ::Teamcenter::BulkInput * > inputs,::Teamcenter::BulkData bd)

static const std::string &	getInterfaceName ()

Protected Member Functions
	BusinessObject ()

virtual void	initialize (RootObjectImpl *impl=0)

virtual void	initialize (::Teamcenter::RootObjectImpl *impl)

void	setTag (tag_t tag)

virtual	~BusinessObject ()

Private Member Functions
	BusinessObject (const BusinessObject &)

BusinessObjectImpl *	getBusinessObjectImpl () const

BusinessObject &	operator= (const BusinessObject &)

::Teamcenter::RootObjectImpl *	setBusinessObjectImpl (::Teamcenter::RootObjectImpl *impl)

void	setDeleteImpl (bool del)

Private Attributes
BusinessObjectImpl *	m_businessobjectImpl

bool	m_deleteImpl

Static Private Attributes
static std::string	name

Friends
class	BusinessObjectDelegate

class	BusinessObjectGenImpl

Detailed Description

Definition at line 59 of file BusinessObject.hxx.

Constructor & Destructor Documentation

Teamcenter::BusinessObject::BusinessObject ( )

protected

Constructor

virtual Teamcenter::BusinessObject::~BusinessObject ( )

protectedvirtual

Destructor

Teamcenter::BusinessObject::BusinessObject ( const BusinessObject & )

private

Private default constructor. We do not want this class instantiated without the business object passed in.

Parameters

BusinessObject - desc for BusinessObject parameter

Member Function Documentation

int Teamcenter::BusinessObject::create ( ::Teamcenter::CreateInput * creInput )

desc for validate for create

Version: Tc 8

Parameters

creInput - desc for creInput parameter

Returns: - ret desc for validate for create

int Teamcenter::BusinessObject::createPost ( ::Teamcenter::CreateInput * creInput )

desc for createPost

Version: Tc 8

Parameters

creInput - Description for the Create Input

Returns: - return desc for createPost

int Teamcenter::BusinessObject::finalizeCreateInput ( ::Teamcenter::CreateInput * creInput )

Description for the Finalize Create Input

Version: Tc 8

Parameters

creInput - desc for creInput parameter

Returns: - Return desc for Initialize for Create

int Teamcenter::BusinessObject::finalizeSaveAsInput	(	::Teamcenter::SaveAsInput *	pSavAsInput,
		std::vector< ::Teamcenter::DeepCopyData * > *	vecDeepCopyData
	)

finalize operation input

Version: Teamcenter 9

Parameters

pSavAsInput	- desc
vecDeepCopyData	- desc

Returns: - returns an int

int Teamcenter::BusinessObject::fnd0AskSRUid	(	std::string *	uid,
		bool *	isFirstTime
	)		const

This is the getter for retrieving the recipe/permanent ID if its been created (and cached on the instance). Every Business Object should implement this operation.

Version: Teamcenter 11.1

Parameters

uid	- Recipe/permanent ID
isFirstTime	- If Session Recovery Uid is yet to be set or does the object need to be serialized again?

Returns: - Failure code

static int Teamcenter::BusinessObject::fnd0Create	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.4

Parameters

inputs	- A vector of data that contains reference information to the object to be created
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0CreatePost	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.4

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0FinalizeCreateInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.4

Parameters

inputs	- A vector of data that contains reference information to the object to be created
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0FinalizeSaveAsInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

int Teamcenter::BusinessObject::fnd0GenerateRecipe ( std::string * recipe )

Generates permanent ID/recipe. Every Business Object should implement this operation.

Version: Teamcenter 11.1

Parameters

recipe - Permanent ID/recipe

Returns: - Failure code.

int Teamcenter::BusinessObject::fnd0GetChildren	(	const std::vector< std::string > *	propertyNames,
		std::vector< tag_t > *	childTags,
		std::vector< std::string > *	childContextPropertyNames
	)

This operation returns the children to be displayed when expanding this object.

Version: Teamcenter 10

Parameters

propertyNames	- The list of propertyNames to expand. If empty, then the properties defined in <TYPE>_DefaultChildProperties and <TYPE>_DefaultPseudoFolder are returned.
childTags	- Tags of children.
childContextPropertyNames	- The propertyName in which this child exists in the parent.

Returns: - status

static int Teamcenter::BusinessObject::fnd0GetDeepCopyData	(	std::vector< ::Teamcenter::BulkInput * > *	getDeepCopydata,
		::Teamcenter::BulkData *	bd
	)

static

Version: Teamcenter 11.4

Parameters

getDeepCopydata	- This is the object to hold input information.
bd	- This is the bulkData

Returns: -

int Teamcenter::BusinessObject::fnd0GetSerializationState ( bool * currentState ) const

Gets the current POM serialization state. Runtime Business Object does not need to implement this operation.

Version: Teamcenter 11.1

Parameters

currentState - Gets the current POM serialization state.

Returns: - Failure code

int Teamcenter::BusinessObject::fnd0IsRecoverable	(	bool *	isPersistedRecipe,
		bool *	isRecoverableIDSupported
	)		const

If Business Object supports recoverable ID. Every Business Object should implement this operation.

Version: Teamcenter 11.1

Parameters

isPersistedRecipe	- isPersistedRecipe param should be set to true if the recipe is limited to the user session and should be serialized to the database
isRecoverableIDSupported	- Returning true indicates support for recoverability/permanent IDs

Returns: - Failure code.

static int Teamcenter::BusinessObject::fnd0PerformDeepCopy	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0SaveAs	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0SaveAsPost	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0SetPropertiesFromCreateInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.4

Parameters

inputs	- A vector of data that contains reference information to the object to be created
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0SetPropertiesFromSaveAsInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

int Teamcenter::BusinessObject::fnd0SetSerializationState	(	bool	newState,
		bool *	stateChanged
	)

Sets the current POM serialization state. Runtime Business Object does not need to implement this operation.

Version: Teamcenter 11.1

Parameters

newState	- true marks the POM serialization recipe as out-of-date, false marks it as up-to-date.
stateChanged	- true if the state has changed.

Returns: - Failure code

int Teamcenter::BusinessObject::fnd0SetSRUid ( const std::string * uid )

This is the setter for the recipe/permanent ID when it is created (to be cached on the instance). Every Business Object should implement this operation.

Version: Teamcenter 11.1

Parameters

uid	- Rrecipe/permanent ID

Returns: - Failure code.

static int Teamcenter::BusinessObject::fnd0ValidateCreateInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.4

Parameters

inputs	- A vector of data that contains reference information to the object to be created
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

static int Teamcenter::BusinessObject::fnd0ValidateSaveAsInput	(	std::vector< ::Teamcenter::BulkInput * > *	inputs,
		::Teamcenter::BulkData *	bd
	)

static

This operation is not supported now, there will be no support for issues stemming from uses of this operation.

Version: Teamcenter 11.2.3

Parameters

inputs	- A vector of data that contains reference information to the object to be saved
bd	- A data structure to store objects and other information relevant for set-based operation

Returns: -

BusinessObjectImpl* Teamcenter::BusinessObject::getBusinessObjectImpl ( ) const

private

int Teamcenter::BusinessObject::getChar	(	const std::string &	charName,
		char &	charRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To Return the Character

Version: Teamcenter 2312

Parameters

charName	- To return the character Name
charRetValue	- The value of the Character
isNull	- Is the Value Null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getChar	(	const std::string &	charName,
		char &	charRetValue,
		bool &	isNull
	)

To Return the Character

Version: Tc 8

Parameters

charName	- To return the character Name
charRetValue	- The value of the Character
isNull	- Is the Value Null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getCharArray	(	const std::string &	charArrayName,
		std::vector< char > &	vectorCharVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the Character array property

Version: Teamcenter 2312

Parameters

charArrayName	- The Char array Name
vectorCharVals	- Vector of char values
vectorIsNullVals	- Is the Values Null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getCharArray	(	const std::string &	charArrayName,
		std::vector< char > &	vectorCharVals,
		std::vector< int > &	vectorIsNullVals
	)

The array of Character

Version: Tc 8

Parameters

charArrayName	- The Char array Name
vectorCharVals	- vector of char values
vectorIsNullVals	- Is the Values Null

Returns: - Returns the Status as Integer

int Teamcenter::BusinessObject::getDate	(	const std::string &	dateName,
		date_t &	dateRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the Date property

Version: Teamcenter 2312

Parameters

dateName	- Name of the date property
dateRetValue	- Value of the date property
isNull	- is value null
hasReadAccess	- Indicates whether the user has read access to the property.

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getDate	(	const std::string &	dateName,
		date_t &	dateRetValue,
		bool &	isNull
	)

get date value

Version: Tc 8

Parameters

dateName	- Name of the date property
dateRetValue	- Value of the date property
isNull	- is value Null

Returns: - status

int Teamcenter::BusinessObject::getDateArray	(	const std::string &	dateArrayName,
		std::vector< date_t > &	dateArrayRetValue,
		std::vector< int > &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the date array property

Version: Teamcenter 2312

Parameters

dateArrayName	- Name of the date array property
dateArrayRetValue	- Value of the date array property
isNull	- is null values
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getDateArray	(	const std::string &	dateArrayName,
		std::vector< date_t > &	dateArrayRetValue,
		std::vector< int > &	isNull
	)

get array of Date Values for a property

Version: Tc 8

Parameters

dateArrayName	- Name of the date array property
dateArrayRetValue	- Value of the date array
isNull	- is null values

Returns: - status

int Teamcenter::BusinessObject::getDeepCopyData	(	const std::string *	operation,
		std::vector< ::Teamcenter::DeepCopyData * > *	deepCopyDatas
	)

gets deep copy data

Version: Teamcenter 9

Parameters

operation	- operation desc
deepCopyDatas	- desc

Returns: - returns an int

int Teamcenter::BusinessObject::getDouble	(	const std::string &	doubleName,
		double &	doubleRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the Double array property

Version: Teamcenter 2312

Parameters

doubleName	- The name of the double property
doubleRetValue	- The value of the double property
isNull	- Is the value null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getDouble	(	const std::string &	doubleName,
		double &	doubleRetValue,
		bool &	isNull
	)

To get the double value

Version: Tc 8

Parameters

doubleName	- The name of the double variable
doubleRetValue	- The value of the double variable
isNull	- Is the value Null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getDoubleArray	(	const std::string &	doubleArrayName,
		std::vector< double > &	vectorDoubleVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the Double array property

Version: Teamcenter 2312

Parameters

doubleArrayName	- The name of the double array property
vectorDoubleVals	- The values of the double array property
vectorIsNullVals	- Is Value Null array
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getDoubleArray	(	const std::string &	doubleArrayName,
		std::vector< double > &	vectorDoubleVals,
		std::vector< int > &	vectorIsNullVals
	)

Array of Doubles

Version: Tc 8

Parameters

doubleArrayName	- The Array Name
vectorDoubleVals	- Array of Doubles
vectorIsNullVals	- Is the Value Null

Returns: - Return the status as Integer

int Teamcenter::BusinessObject::getInt	(	const std::string &	intName,
		int &	intRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the Integer property

Version: Teamcenter 2312

Parameters

intName	- The name of the Integer property
intRetValue	- The value of the Integer property
isNull	- Is the value null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getInt	(	const std::string &	intName,
		int &	intRetValue,
		bool &	isNull
	)

To get the Integer

Version: Tc 8

Parameters

intName	- The name of the Integer
intRetValue	- The value of the Integer
isNull	- Is the value null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getIntArray	(	const std::string &	intArrayName,
		std::vector< int > &	vectorIntVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the Integer array property

Version: Teamcenter 2312

Parameters

intArrayName	- The name of the integer array property
vectorIntVals	- The vector of integer values
vectorIsNullVals	- Are the values null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getIntArray	(	const std::string &	intArrayName,
		std::vector< int > &	vectorIntVals,
		std::vector< int > &	vectorIsNullVals
	)

Array of Integers

Version: Tc 8

Parameters

intArrayName	- The array name of integers
vectorIntVals	- The Vector of Integer values
vectorIsNullVals	- are the Values Null

Returns: - Returns the status as Integers

static const std::string& Teamcenter::BusinessObject::getInterfaceName ( )

static

Get the Interface Name

Returns: - return desc for getInterfaceName

int Teamcenter::BusinessObject::getLogical	(	const std::string &	logicalName,
		bool &	boolRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the Boolean property

Version: Teamcenter 2312

Parameters

logicalName	- The name of the Boolean property
boolRetValue	- The value of the boolean property
isNull	- Is the value null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getLogical	(	const std::string &	logicalName,
		bool &	boolRetValue,
		bool &	isNull
	)

To get the Logical Value

Version: Tc 8

Parameters

logicalName	- The name of the Logical Variable
boolRetValue	- The logical value
isNull	- Is the value null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getLogicalArray	(	const std::string &	logicalArrayName,
		std::vector< int > &	vectorLogicalVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the Boolean array property

Version: Teamcenter 2312

Parameters

logicalArrayName	- The name of the boolean array property
vectorLogicalVals	- The vector of Logical values
vectorIsNullVals	- Are the values null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getLogicalArray	(	const std::string &	logicalArrayName,
		std::vector< int > &	vectorLogicalVals,
		std::vector< int > &	vectorIsNullVals
	)

Array of Logical Values

Version: Tc 8

Parameters

logicalArrayName	- Array of Logical Names
vectorLogicalVals	- Vector of Logical Values
vectorIsNullVals	- are the Value Null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getObject_string	(	std::string &	value,
		bool &	isNull
	)		const

Getter for a string Property

Version: Teamcenter 10

Parameters

value	- Parameter value
isNull	- Returns true if the Parameter value is null

Returns: - Status. 0 if successful

virtual RuntimeBusinessObjectImpl* Teamcenter::RootObject::getRuntimeBusinessObjectImpl ( ) const

virtualinherited

Reimplemented in Teamcenter::RuntimeBusinessObject.

int Teamcenter::BusinessObject::getString	(	const std::string &	stringName,
		std::string &	stringRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the String property

Version: Teamcenter 2312

Parameters

stringName	- The name of the string property
stringRetValue	- The value of the string property
isNull	- Is the value null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getString	(	const std::string &	stringName,
		std::string &	stringRetValue,
		bool &	isNull
	)

Returns the String

Version: Tc 8

Parameters

stringName	- The name of the String
stringRetValue	- The value of the string
isNull	- Is the String Null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getStringArray	(	const std::string &	stringArrayName,
		std::vector< std::string > &	vectorStringVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the String array property

Version: Teamcenter 2312

Parameters

stringArrayName	- The name of the string array property
vectorStringVals	- The values of string array property
vectorIsNullVals	- Are the values null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getStringArray	(	const std::string &	stringArrayName,
		std::vector< std::string > &	vectorStringVals,
		std::vector< int > &	vectorIsNullVals
	)

To get the StringArray

Version: Tc 8

Parameters

stringArrayName	- The String name
vectorStringVals	- Vector of Strings
vectorIsNullVals	- vector of booleans

Returns: - Returns the status as Integer

tag_t Teamcenter::RootObject::getTag ( ) const

inherited

int Teamcenter::BusinessObject::getTag	(	const std::string &	tagName,
		tag_t &	tagRetValue,
		bool &	isNull,
		bool &	hasReadAccess
	)

To retrieve the values of the reference property

Version: Teamcenter 2312

Parameters

tagName	- The name of the reference property
tagRetValue	- The value of the reference property
isNull	- Is the value null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getTag	(	const std::string &	tagName,
		tag_t &	tagRetValue,
		bool &	isNull
	)

Returns the Tag

Version: Tc 8

Parameters

tagName	- The name of the Tag
tagRetValue	- The value of the Tag
isNull	- Is the Value Null

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getTagArray	(	const std::string &	tagArrayName,
		std::vector< tag_t > &	vectorTagVals,
		std::vector< int > &	vectorIsNullVals,
		bool &	hasReadAccess
	)

To retrieve the values of the reference array property

Version: Teamcenter 2312

Parameters

tagArrayName	- The name of the reference array property
vectorTagVals	- The vector of values of reference array property
vectorIsNullVals	- Are the values null
hasReadAccess	- Indicates whether the user has read access to the property

Returns: - Returns the status as Integer

int Teamcenter::BusinessObject::getTagArray	(	const std::string &	tagArrayName,
		std::vector< tag_t > &	vectorTagVals,
		std::vector< int > &	vectorIsNullVals
	)

Array of Tags

Version: Tc 8

Parameters

tagArrayName	- Nameof the Tag Array
vectorTagVals	- Vector of Tags
vectorIsNullVals	- are the Value Null

Returns: - Returns the status as Integer

const std::string& Teamcenter::RootObject::getTypeName ( ) const

inherited

tag_t Teamcenter::RootObject::getTypeTag ( ) const

inherited

virtual void Teamcenter::RootObject::initialize ( RootObjectImpl * impl = 0 )

protectedvirtualinherited

virtual void Teamcenter::BusinessObject::initialize ( ::Teamcenter::RootObjectImpl * impl )

protectedvirtual

int Teamcenter::RootObject::invokeOperation	(	const std::string *	operationId,
			...
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	const std::string &	operationId,
		va_list	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	int	operationIdInt,
		va_list	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	const std::string &	operationId,
		std::vector< void * > &	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	int	operationIdInt,
		std::vector< void * > &	args
	)

inherited

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

private

int Teamcenter::BusinessObject::performDeepCopy	(	::Teamcenter::OperationInput *	pOperationInput,
		std::vector< ::Teamcenter::DeepCopyData * > *	vecDeepCopyData
	)

perform deep copy

Version: Teamcenter 9

Parameters

pOperationInput	- desc
vecDeepCopyData	- deep copy data

Returns: - returns an int

int Teamcenter::BusinessObject::saveAs	(	::Teamcenter::SaveAsInput *	pSavAsInput,
		std::vector< ::Teamcenter::DeepCopyData * > *	vecDeepCopyData,
		tag_t *	newObjTag
	)

save as operation

Version: Teamcenter 9

Parameters

pSavAsInput	- save as input
vecDeepCopyData	- vector deepcopy data
newObjTag	- new object tag

Returns: - returns an int

int Teamcenter::BusinessObject::saveAsPost	(	::Teamcenter::SaveAsInput *	pSavAsInput,
		std::vector< ::Teamcenter::DeepCopyData * > *	vecDeepCopyData
	)

Generic saveAsPost operation.

Version: Teamcenter 8.1

Parameters

pSavAsInput	- Input argument as SaveAsInput object.
vecDeepCopyData	- vector deepcopy data

Returns: - Return integer value.

::Teamcenter::RootObjectImpl* Teamcenter::BusinessObject::setBusinessObjectImpl ( ::Teamcenter::RootObjectImpl * impl )

private

int Teamcenter::BusinessObject::setChar	(	const std::string &	charName,
		const char &	charValue,
		bool	isNull
	)

To set the character

Version: Tc 8

Parameters

charName	- The Name
charValue	- The Character Value
isNull	- Is the Value Null

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setCharArray	(	const std::string &	charArrayName,
		const std::vector< char > &	vectorCharVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set the character array

Version: Tc 8

Parameters

charArrayName	- charArrayName
vectorCharVals	- vectorCharVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setDate	(	const std::string &	dateName,
		const date_t &	dateValue,
		bool	isNull
	)

To set the Date

Version: Tc 8

Parameters

dateName	- dateName
dateValue	- dateValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setDateArray	(	const std::string &	dateArrayName,
		const std::vector< date_t > &	vectorDateVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set the Date Array

Version: Tc 8

Parameters

dateArrayName	- dateArrayName
vectorDateVals	- vectorDateVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

void Teamcenter::BusinessObject::setDeleteImpl ( bool del )

private

int Teamcenter::BusinessObject::setDouble	(	const std::string &	doubleName,
		const double &	doubleValue,
		bool	isNull
	)

To set the Double Value

Version: Tc 8

Parameters

doubleName	- doubleName
doubleValue	- doubleValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setDoubleArray	(	const std::string &	doubleArrayName,
		const std::vector< double > &	vectorDoubleVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set the double array

Version: Tc 8

Parameters

doubleArrayName	- doubleArrayName
vectorDoubleVals	- vectorDoubleVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setInt	(	const std::string &	intName,
		const int &	intValue,
		bool	isNull
	)

To set an Integer

Version: Tc 8

Parameters

intName	- The name of the integer
intValue	- The Integer Value
isNull	- Is the value Null

Returns: - Returns status as Integer

int Teamcenter::BusinessObject::setIntArray	(	const std::string &	intArrayName,
		const std::vector< int > &	vectorIntVals,
		const std::vector< int > *	vectorIsNullVals
	)

To the the Array of Integer type data on BusinessObject

Version: Tc 8

Parameters

intArrayName	- name of the integer array
vectorIntVals	- vector or array of integer values
vectorIsNullVals	- vector of isNulls

Returns: - success or failure

int Teamcenter::BusinessObject::setLogical	(	const std::string &	logicalName,
		const bool	logicalValue,
		bool	isNull
	)

To set the Logical Value

Version: Tc 8

Parameters

logicalName	- logicalName
logicalValue	- logicalValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setLogicalArray	(	const std::string &	boolArrayName,
		const std::vector< int > &	vectorboolVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set Logical Array

Version: Tc 8

Parameters

boolArrayName	- boolArrayName
vectorboolVals	- vectorboolVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setPropertiesFromCreateInput ( ::Teamcenter::CreateInput * creInput )

desc for setPropertiesFromCreateInpu

Version: Tc 8

Parameters

creInput - Description for CreateInput

Returns: - return desc for setPropertiesFromCreateInput

int Teamcenter::BusinessObject::setPropertiesFromSaveAsInput ( ::Teamcenter::SaveAsInput * pSavAsInput )

setproperties from saveas input

Version: Teamcenter 9

Parameters

pSavAsInput - desc

Returns: - returns an int

int Teamcenter::BusinessObject::setString	(	const std::string &	stringName,
		const std::string &	stringValue,
		bool	isNull
	)

To set the String

Version: Tc 8

Parameters

stringName	- stringName
stringValue	- stringValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setStringArray	(	const std::string &	stringArrayName,
		const std::vector< std::string > &	vectorStringVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set the string array

Version: Tc 8

Parameters

stringArrayName	- stringArrayName
vectorStringVals	- vectorStringVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an integer

void Teamcenter::RootObject::setTag ( tag_t tag )

protectedinherited

int Teamcenter::BusinessObject::setTag	(	const std::string &	tagName,
		const tag_t &	tagValue,
		bool	isNull
	)

To set the tag

Version: Tc 8

Parameters

tagName	- tagName
tagValue	- tagValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::BusinessObject::setTagArray	(	const std::string &	tagArrayName,
		const std::vector< tag_t > &	vectorTagVals,
		const std::vector< int > *	vectorIsNullVals
	)

To set the Tag Array

Version: Tc 8

Parameters

tagArrayName	- tagArrayName
vectorTagVals	- vectorTagVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::BusinessObject::validateCreateInput ( ::Teamcenter::CreateInput * creInput )

desc for validate for create

Version: Tc 8

Parameters

creInput - desc for creInput parameter

Returns: - ret desc for validate for create

int Teamcenter::BusinessObject::validateSaveAsInput	(	::Teamcenter::SaveAsInput *	pSavAsInput,
		std::vector< ::Teamcenter::DeepCopyData * > *	vecDeepCopyData
	)

validate saveas input

Version: Teamcenter 9

Parameters

pSavAsInput	- desc
vecDeepCopyData	- desc

Returns: - returns an int

Friends And Related Function Documentation

friend class BusinessObjectDelegate

friend

Definition at line 829 of file BusinessObject.hxx.

friend class BusinessObjectGenImpl

friend

Definition at line 830 of file BusinessObject.hxx.

Member Data Documentation

BusinessObjectImpl* Teamcenter::BusinessObject::m_businessobjectImpl

private

Definition at line 812 of file BusinessObject.hxx.

bool Teamcenter::BusinessObject::m_deleteImpl

private

Definition at line 815 of file BusinessObject.hxx.

std::string Teamcenter::BusinessObject::name

staticprivate

Name of the Business Object

Definition at line 820 of file BusinessObject.hxx.

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

BusinessObject.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation