#include <Fnd0BranchExt.hxx>

Inheritance diagram for bhv0::bhv0branchfoundation::Fnd0Branch:

Public Member Functions
int	bhv0AddContents (const std::vector< tag_t > &contents, const std::vector< ::Teamcenter::CreateInput * > &relationProperties)

int	bhv0AddParentContents (const std::map< tag_t, std::vector< tag_t > > &contents, const std::vector< ::Teamcenter::CreateInput * > &relationProperties, const bool checkoutFlag, std::vector< tag_t > &branchContents)

int	bhv0CancelCheckoutContents (const std::vector< tag_t > &contentsForCCO, std::vector< tag_t > &branchContentsAfterCCO, std::vector< int > &statusCodes)

int	bhv0CheckinContents (const std::vector< tag_t > &contents, const ::Teamcenter::CreateInput *comment, bool publishFlag)

int	bhv0CheckOutContents (const std::vector< tag_t > &contents, const std::vector< ::Teamcenter::CreateInput * > &relationProperties, std::vector< tag_t > &newBranchContents)

int	bhv0CreateLabel (const std::string &name, const std::string &description, tag_t &createdLabel)

int	bhv0GetContents (const std::string &label, std::vector< tag_t > &branchContents)

int	bhv0MergeContents (const tag_t &sourceBranch, const std::vector< tag_t > &sourceContentsForMerge, const std::vector< tag_t > &targetContentsForMerge, std::vector< ::Teamcenter::CreateInput * > &targetRelationProperties, std::vector< tag_t > &mergedBranchContents, std::vector< int > &statusCodes)

int	bhv0ObsoleteContents (const std::vector< tag_t > &contentsForObsolete, std::vector< ::Teamcenter::CreateInput * > &relationProperties,::Teamcenter::CreateInput *comment, std::vector< tag_t > &newBranchContents, std::vector< int > &statusCode)

int	bhv0PromoteContents (const std::vector< tag_t > &contents, tag_t sourceBranch, const std::vector< ::Teamcenter::CreateInput * > &relationProperties,::Teamcenter::CreateInput *comment)

static::Teamcenter::BusinessObjectExtenderRegistry < bhv0::bhv0branchfoundation::Fnd0Branch > &	extenderRegistry ()

	Fnd0Branch (tag_t objTag)

tag_t	getTag () const

tag_t	getTypeTag () const

virtual void	initialize (RootObjectImpl *impl=0)

void	setTypeTag (tag_t tag)

Static Public Member Functions
static const std::string &	getExtenderInterfaceName ()

Protected Member Functions
virtual void	initialize (::Teamcenter::RootObjectImpl *impl)

virtual	~Fnd0Branch ()

Private Member Functions
	Fnd0Branch (const Fnd0Branch &)

Fnd0BranchImpl *	getFnd0BranchImpl () const

Fnd0Branch &	operator= (const Fnd0Branch &)

void	setDeleteImpl (bool del)

::Teamcenter::RootObjectImpl *	setFnd0BranchImpl (::Teamcenter::RootObjectImpl *impl)

Private Attributes
bool	m_deleteImpl

Fnd0BranchImpl *	m_fnd0branchImpl

Static Private Attributes
static std::string	name

Friends
class	Fnd0BranchDelegate

class	Fnd0BranchGenImpl

Detailed Description

Definition at line 72 of file Fnd0BranchExt.hxx.

Constructor & Destructor Documentation

bhv0::bhv0branchfoundation::Fnd0Branch::Fnd0Branch ( tag_t objTag )

Constructor

virtual bhv0::bhv0branchfoundation::Fnd0Branch::~Fnd0Branch ( )

protectedvirtual

Destructor

bhv0::bhv0branchfoundation::Fnd0Branch::Fnd0Branch ( const Fnd0Branch & )

private

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

Parameters

Fnd0Branch - desc for Fnd0Branch parameter

Member Function Documentation

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0AddContents	(	const std::vector< tag_t > &	contents,
		const std::vector< ::Teamcenter::CreateInput * > &	relationProperties
	)

This operation adds a Teamcenter revisable or non-revisable workspace object to an existing branch. Upon adding the objects to the branch, users can use the branching and versioning capabilities to support concurrent editing of these objects and maintain their version history.

Version: Teamcenter 11.3

Parameters

contents	- List of objects to be added in the branch
relationProperties	- List of properties to be set on the relation for every object added to the branch

Returns: - Returns the operation status code as success or failure.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0AddParentContents	(	const std::map< tag_t, std::vector< tag_t > > &	contents,
		const std::vector< ::Teamcenter::CreateInput * > &	relationProperties,
		const bool	checkoutFlag,
		std::vector< tag_t > &	branchContents
	)

Add object(s) to child branch from parent branch.

Version: Teamcenter 11.5

Parameters

contents	- Map of parent branch to its content objects to be added to a child branch.
relationProperties	- List of properties to be set on the relation for every object added to the branch.
checkoutFlag	- Flag to indicate whether to checkout the added objects.
branchContents	- List of Fnd0BranchContent relation objects returned as per the input criteria. The version objects can be fetched as a secondary of these relation objects.

Returns: - List of content objects that were added to child branch.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0CancelCheckoutContents	(	const std::vector< tag_t > &	contentsForCCO,
		std::vector< tag_t > &	branchContentsAfterCCO,
		std::vector< int > &	statusCodes
	)

Version: Teamcenter 11.5

Parameters

contentsForCCO	- Branch contents for cancel check-out.
branchContentsAfterCCO	- The Fnd0BranchContent relation objects, which represent the latest head branch content after cancel check-out operation. The version objects can be retrieved as a secondary of these relation objects.
statusCodes	- Array of returned status codes.

Returns: -

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0CheckinContents	(	const std::vector< tag_t > &	contents,
		const ::Teamcenter::CreateInput *	comment,
		bool	publishFlag
	)

This operation performs check in and release of already checked out Teamcenter workspace object under a branch. Publish is optional.

Version: Teamcenter 11.4

Parameters

contents	- Contents to be checked-in.
comment	- Checkin comment.
publishFlag	- If True content will be released.

Returns: - Returns the operation status code as success or failure.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0CheckOutContents	(	const std::vector< tag_t > &	contents,
		const std::vector< ::Teamcenter::CreateInput * > &	relationProperties,
		std::vector< tag_t > &	newBranchContents
	)

This operation performs check-out of Teamcenter workspace object under a branch.

Version: Teamcenter 11.4

Parameters

contents	- Branch contents to be checked-out.
relationProperties	- List of properties to be set on the relation for every object added to the branch.
newBranchContents	- List of Fnd0BranchContent relation objects returned as per the input criteria. The version objects can be fetched as a secondary of these relation objects.

Returns: - Returns the operation status code as success or failure.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0CreateLabel	(	const std::string &	name,
		const std::string &	description,
		tag_t &	createdLabel
	)

This method is invoked to create a label for the given branch. The method shall get the label name and description as input. For a given branch the method shall extract the latest versions and use these latest version objects to create a label.

Version: Teamcenter 11.5

Parameters

name	- name
description	- description
createdLabel	- createdLabel

Returns: -

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0GetContents	(	const std::string &	label,
		std::vector< tag_t > &	branchContents
	)

This operation returns a list of objects part of a given input branch. The list of objects returned shall be for a specific baseline label, the latest versions of each associated object or all the versions of all the objects part of that branch. It takes the baseline label, the string “latest” or an empty string as input. If the label input is empty all versions of all the objects those are part of that branch are returned to the caller.

Version: Teamcenter 11.3

Parameters

label - This parameter is used to get the baselined, latest or all the versions of the objects associated to the given branch. The valid values of this parameter are as follows: 1) String indicating the baseline label to get the baselined versions of all the objects associated to the branch. 2) String "latest" to get latest versions of all the objects associated to the branch. 3) Empty string to get all the versions of all the objects associated to the branch.

branchContents - List of Fnd0BranchContent relation objects returned as per the input criteria. The version objects can be fetched as a secondary of these relation objects.

Returns: - Returns the operation status code as success or failure

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0MergeContents	(	const tag_t &	sourceBranch,
		const std::vector< tag_t > &	sourceContentsForMerge,
		const std::vector< tag_t > &	targetContentsForMerge,
		std::vector< ::Teamcenter::CreateInput * > &	targetRelationProperties,
		std::vector< tag_t > &	mergedBranchContents,
		std::vector< int > &	statusCodes
	)

This operation performs merge of Teamcenter workspace object under a source branch to Teamcenter workspace object under target branch.

Version: Teamcenter 11.5

Parameters

sourceBranch	- Source branch tag for merge operation.
sourceContentsForMerge	- List of source objects for merge.
targetContentsForMerge	- List of target objects for merge.
targetRelationProperties	- List of properties to be set on the relation for every object added to the branch.
mergedBranchContents	- The Fnd0BranchMerge relation objects, which represent the latest merged branch content. The version objects can be retrieved as a secondary of these relation objects.
statusCodes	- Array of returned status codes.

Returns: - Returns the operation status code as success or failure for each merge contents.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0ObsoleteContents	(	const std::vector< tag_t > &	contentsForObsolete,
		std::vector< ::Teamcenter::CreateInput * > &	relationProperties,
		::Teamcenter::CreateInput *	comment,
		std::vector< tag_t > &	newBranchContents,
		std::vector< int > &	statusCode
	)

This operation performs obsolete of Teamcenter workspace object under a branch.

Version: Teamcenter 12.2

Parameters

contentsForObsolete	- Branch contents for obsolete.
relationProperties	- List of properties to be set on the relation for every object added to the branch.
comment	- Obsolete comment.
newBranchContents	- List of Fnd0BranchContent relation objects returned as per the input criteria. The version objects can be fetched as a secondary of these relation objects.
statusCode	- Array of returned status codes.

Returns: - Returns the operation status code as success or failure.

int bhv0::bhv0branchfoundation::Fnd0Branch::bhv0PromoteContents	(	const std::vector< tag_t > &	contents,
		tag_t	sourceBranch,
		const std::vector< ::Teamcenter::CreateInput * > &	relationProperties,
		::Teamcenter::CreateInput *	comment
	)

Version: Teamcenter 11.4

Parameters

contents	- List of objects to be promoted in the branch.
sourceBranch	- Source branch tag for promote operation.
relationProperties	- List of properties to be set on the relation for every object added to the branch
comment	- Comment record for promote operation.

Returns: - Returns the operation status code as success or failure.

static ::Teamcenter::BusinessObjectExtenderRegistry< bhv0::bhv0branchfoundation::Fnd0Branch >& bhv0::bhv0branchfoundation::Fnd0Branch::extenderRegistry ( )

Get the Extender Registry

Returns: - return Extender Registry

static const std::string& bhv0::bhv0branchfoundation::Fnd0Branch::getExtenderInterfaceName ( )

static

Get the Extender Interface Name

Returns: - return desc for getExtenderInterfaceName

Fnd0BranchImpl* bhv0::bhv0branchfoundation::Fnd0Branch::getFnd0BranchImpl ( ) const

private

tag_t Teamcenter::BusinessObjectExtender::getTag ( ) const

inherited

Retrieves the Owning Object tag.

Returns: A tag for the Owning Object.

tag_t Teamcenter::BusinessObjectExtender::getTypeTag ( ) const

inherited

Retrieves the Owning Object Type tag.

Returns: A tag for the Owning Object Type.

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

virtualinherited

Initialization for object instantiation.

Parameters

impl	(I) The input Implementation Object

virtual void bhv0::bhv0branchfoundation::Fnd0Branch::initialize ( ::Teamcenter::RootObjectImpl * impl )

protectedvirtual

Fnd0Branch& bhv0::bhv0branchfoundation::Fnd0Branch::operator= ( const Fnd0Branch & )

private

void bhv0::bhv0branchfoundation::Fnd0Branch::setDeleteImpl ( bool del )

private

::Teamcenter::RootObjectImpl* bhv0::bhv0branchfoundation::Fnd0Branch::setFnd0BranchImpl ( ::Teamcenter::RootObjectImpl * impl )

private

void Teamcenter::BusinessObjectExtender::setTypeTag ( tag_t tag )

inherited

Sets the Type Tag from the owning Object.

Parameters

tag	(I) The input Type tag

Friends And Related Function Documentation

friend class Fnd0BranchDelegate

friend

Definition at line 238 of file Fnd0BranchExt.hxx.

friend class Fnd0BranchGenImpl

friend

Definition at line 239 of file Fnd0BranchExt.hxx.

Member Data Documentation

bool bhv0::bhv0branchfoundation::Fnd0Branch::m_deleteImpl

private

Definition at line 224 of file Fnd0BranchExt.hxx.

Fnd0BranchImpl* bhv0::bhv0branchfoundation::Fnd0Branch::m_fnd0branchImpl

private

Definition at line 221 of file Fnd0BranchExt.hxx.

std::string bhv0::bhv0branchfoundation::Fnd0Branch::name

staticprivate

Name of the Business Object

Definition at line 229 of file Fnd0BranchExt.hxx.

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

Fnd0BranchExt.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