All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABusinessObject
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVIABusinessObject
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABusinessObject
Base interface to a Business Object (BO in short).
Role: Every Business Object interface derives from this one, which provides a set of
services and methods shared by a business object. You should not derive directly from this
interface.
Method Index
- o
Demote(CATUnicodeString&)
- Demotes a BO to change its status, along the status graph.
- o
IsEqual(ENOVIABusinessObject*,long&)
- Compares two BO.
- o
IsLocked(CATUnicodeString&)
- Retrieves the lock's owner of a BO.
- o
Lock()
- Locks a BO.
- o
Promote(CATUnicodeString&)
- Promotes a BO to change its status, along the status graph.
- o
Remove()
- Removes the BO from memory.
- o
RemoveDocumentValue(ENOVIABODocument*)
- Removes the document attached the BO.
- o
RemoveFolder(long)
- Removes a folder from the BO.
- o
RemoveFolderValue(ENOVIABOFolder*)
- Removes the folder under the BO.
- o
UnLock()
- Unlock a BO.
- o
add_PointedRelation(ENOVIABORelation*&,CATUnicodeString*,CATUnicodeString*)
- Adds a relation which it is pointing to the BO.
- o
add_PointingRelation(ENOVIABORelation*&,CATUnicodeString*,CATUnicodeString*)
- Adds a relation which it is pointing from the BO.
- o
get_CATIADocCount(CATICfgFilter*,long&)
- Returns the number of CATIA documents (CATPart, CATProduct, or model) associated with this BO.
- o
get_CATIADocument(long,ENOVIABODocument_var&)
- Retrieves a CATIA document (CATPart, CATProduct, or model) specified by its index on the BO.
- o
get_Document(long,ENOVIABODocument*&)
- Retrieves a document specified by its index on the BO.
- o
get_Folder(long,ENOVIABOFolder*&)
- Retrieves the folder specified by its index on the BO.
- o
get_FolderCount(CATICfgFilter*,long&)
- Returns the number of folders under the BO with a specific config filter.
- o
get_HexaUuid(CATUnicodeString&)
-
- o
get_PointedRelation(long,ENOVIABORelation*&)
- Retreives a relation pointed to the BO.
- o
get_PointedRelationCount(CATUnicodeString*,long&)
- Returns the number of relations pointed to the BO.
- o
get_PointingRelation(long,ENOVIABORelation*&)
- Retreives a relation pointing from the BO.
- o
get_PointingRelationCount(CATUnicodeString*,long&)
- Returns the number of relations pointing from the BO.
- o
get_Type(CATUnicodeString&)
- Returns the type of the object.
- o
get_Uuid(SEQUENCE_octet&)
- Returns the Uuid (unique identifier) of a BO.
- o
put_Document(ENOVIABODocument*)
- Puts a document under the BO.
- o
put_Folder(ENOVIABOFolder*)
- Puts a folder under the BO.
- o
updateCurrentDocRole(long,ENOVIABODocument*)
- Updates a document Role under the BO.
Methods
o Demote
-
Demotes a BO to change its status, along the status graph. The graph gives the available transitions from the current state. This method is exactly the same as the previous one,
Promote( CATUnicodeString & )
.
- Parameters:
-
- statetoDemote
- the state to reach.
o IsEqual
-
Compares two BO.
- Parameters:
-
- iObject
- The BO to compare.
- oisequal
- The result of the operation. 0 if they are equals.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsLocked
-
Retrieves the lock's owner of a BO.
- Parameters:
-
- oOwner
- The BO lock's owner. If the BO is unlocked, this param is null.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o Lock
-
Locks a BO.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o Promote
-
Promotes a BO to change its status, along the status graph. The graph gives the available transitions from the current state.
- Parameters:
-
- statetoPromote
- the transition name to apply to go to the next state.
o Remove
-
Removes the BO from memory.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o RemoveDocumentValue
-
Removes the document attached the BO.
- Parameters:
-
- iDocument
- The document from which the value is removed.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o RemoveFolder
-
Removes a folder from the BO.
- Parameters:
-
- iIndex
- The index of the folder to cut.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o RemoveFolderValue
-
Removes the folder under the BO.
- Parameters:
-
- iFolder
- The folder from which the value is removed.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o UnLock
-
Unlock a BO.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o add_PointedRelation
-
Adds a relation which it is pointing to the BO.
- Parameters:
-
- oPointedRel
- The pointed relation.
- iRelationshipEntityName
- The type name of the relation.
- iDomainName
- The domain name of the relation.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o add_PointingRelation
-
Adds a relation which it is pointing from the BO.
- Parameters:
-
- oPointingRel
- The pointing relation.
- iRelationshipEntityName
- The type name of the relation.
- iDomainName
- The domain name of the relation.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_CATIADocCount
-
Returns the number of CATIA documents (CATPart, CATProduct, or model) associated with this BO. The caller should use setCurrentUsage() prior
to calling this method in order to explicitly define the attachment
criteria, i.e. Documentation vs Representation, etc. Note: This does
not count ALL CATIA-related documents, only these three types.
- Parameters:
-
- iCfgFilter
- Not used currently -- pass NULL.
- oNbItems
- The number of CATIA documents under the BO.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_CATIADocument
public virtual HRESULT __stdcall get_CATIADocument( | long | iIndex, |
| ENOVIABODocument_var& | oCATIADoc)= 0 |
-
Retrieves a CATIA document (CATPart, CATProduct, or model) specified by its index on the BO. Caller must first use get_CATIADocCount() to get the
number of documents to know the correct index range. Also, caller should
use setCurrentUsage() to explicitly define the attachment criteria, i.e.
Documentation vs Representation, etc.
- Parameters:
-
- iIndex
- The index of the CATIA document to retrieve.
- oCATIADoc
- The document retrieved by its index.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Document
-
Retrieves a document specified by its index on the BO.
- Parameters:
-
- iIndex
- The index of the document to retrieve.
- oDocument
- The document retrieved by its index.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Folder
-
Retrieves the folder specified by its index on the BO.
- Parameters:
-
- iIndex
- The index of the folder we wish to retreive.
- oFolder
- The folder retrieved by its index.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_FolderCount
-
Returns the number of folders under the BO with a specific config filter.
- Parameters:
-
- iCfgFilter
- The config filter to apply on the BO.
- oNbItems
- The number of folders under the BO corresponding to the config filter.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_HexaUuid
-
- Deprecated:
- V5R15
Returns the Uuid (unique identifier) of a BO in hexadecimal.
- Parameters:
-
- oUuid
- The identifier.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_PointedRelation
-
Retreives a relation pointed to the BO. The relation is specified by its index.
- Parameters:
-
- iIndex
- The index of the wished relation.
- oPointedRel
- The relation.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_PointedRelationCount
-
Returns the number of relations pointed to the BO. Relations are specified by their types.
- Parameters:
-
- iRelationshipEntityName
- The type of the relation.
- oNbItems
- The number of relations.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_PointingRelation
-
Retreives a relation pointing from the BO. The relation is specified by its index.
- Parameters:
-
- iIndex
- The index of the wished relation.
- oPointedRel
- The relation.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_PointingRelationCount
-
Returns the number of relations pointing from the BO. Relations are specified by their types.
- Parameters:
-
- iRelationshipEntityName
- The type of the relation.
- oNbItems
- The number of relations.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Type
-
Returns the type of the object.
- Parameters:
-
- oType
- The type of the BO.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Uuid
-
Returns the Uuid (unique identifier) of a BO.
- Parameters:
-
- oUuid
- The identifier.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_Document
-
Puts a document under the BO.
- Parameters:
-
- iDocument
- The document to put under.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_Folder
-
Puts a folder under the BO.
- Parameters:
-
- iFolder
- The folder to put under.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o updateCurrentDocRole
-
Updates a document Role under the BO.
- Parameters:
-
- DocRole
- the new Role of the Document.
- iDocument
- The document under the BO.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIABusinessObject.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces