PLMFolderInterfaces Interface PLMISubFolder

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

interface PLMISubFolder

Interface managing sub-folders.

Role: This interface is available for sub Folders only.

Method Index

o AttachObject(CATIAdpPLMIdentificator*): Attachs an object to current Folder.
o AttachObject(CATListPtrCATIAdpPLMIdentificator&): Attachs a list of objects to current Folder.
o DetachObject(CATIAdpPLMIdentificator*): Detaches a PLM Object attached to current Folder.
o DetachObject(CATListPtrCATIAdpPLMIdentificator&): Detaches a list of PLM Objects attached to current Folder.
o GetParentFolder(PLMIFolder*&,CATOmbLifeCycleRootsBag&): Gets Parent Folder of current Folder.
o ListObjects(CATListPtrCATIAdpPLMIdentificator&): Retrieves the list of Objects attached to current Folder.

Methods

o AttachObject

public virtual AttachObject( iRefToAttach)

Attachs an object to current Folder.

Parameters:

iRefToAttach: The identifier of a PLM Reference or PLM Representation Reference Object to attach. The interactive documentation lists all the PLM References and PLM Representations which can be attached ot folders

Returns:

S_OK if the PLM Object is successfully attached.
E_INVALIDARG : Type of Object to attach is not authorized in Folder application.
E_FAIL otherwise.

o AttachObject

public virtual AttachObject( iRefListToAttach)

Attachs a list of objects to current Folder.

Parameters:

iRefListToAttach: The list of identifiers of PLM Reference or PLM Representation Reference Object to attach.

Returns:

S_OK if all PLM Objects are successfully attached.
E_INVALIDARG : The type of one PLM Object to attach is not authorized in Folder application.
E_FAIL otherwise. If one fail, the entire list fails.

o DetachObject

public virtual DetachObject( iRefToDetach)

Detaches a PLM Object attached to current Folder.

Parameters:

iRefToDetach: The identifier of PLM Object to detach.

Returns:

S_OK if the PLM Object is successfully detached.
E_INVALIDARG : Object is not attached to current Folder.
E_FAIL otherwise.

o DetachObject

public virtual DetachObject( iRefListToDetach)

Detaches a list of PLM Objects attached to current Folder.

Parameters:

iRefListToDetach: The identifiers of PLM Objects to detach.

Returns:

S_OK if the Object is successfully detached.
E_INVALIDARG : one PLM Object is not attached to current Folder.
E_FAIL otherwise. If one fails, the whole list fails.

o GetParentFolder

public virtual GetParentFolder(		`oParentFolder`,
		`ioBag`)

Gets Parent Folder of current Folder.

Parameters:

oParentFolder: The Parent Folder of current Folder. It can be a folder or a root folder).
ioBag: The Bag. Do not forget to RemoveAll()

Returns:

S_OK if the parent Folder is successfully retrieved.
E_FAIL otherwise.

o ListObjects

public virtual ListObjects( oReferenceIdList)

Retrieves the list of Objects attached to current Folder.

Parameters:

oReferenceIdList: The list of Identifiers of pointed PLM Objects.

Returns:

S_OK if the list of PLM Objects is successfully retrieved.
E_FAIL otherwise.

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