All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMXBom Interface ENOVIBODefinition
System.IUnknown
|
+---VPMXBom.ENOVICollectionBase
|
+---VPMXBom.ENOVIAttributeDefinitions
|
+---ENOVIBODefinition
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIBODefinition
- Deprecated:
- V5R15
Interface representing the definition of a BO.
Role:
This is the interface which is needed by the BO engine to instantiate a
BO. A standard implementation is provided based on the ENOVIA federation
dictionary.
Each BO Instance can be completely defined by its Key and its BODefinition.
The Key is passed around as an IUnknown pointer, the actual (CNext Late)
type of the key can be optained by calling the get_KeyTypeUuid on the
BODefinition pointer (all BO Instances of a given type use the same type of
key).
Using the BODefinition, one can gain information on all the attributes of a
type of BO, it can obtain an interface to Query for this BO, it can
instantiate BO instances for given keys.
- See also:
- ENOVIBOInstance, ENOVIModeler, ENOVIQuery
Method Index
- o
Instantiate(ENOVIBOInstance**,IUnknown*)
-
- o
get_BOTypeName(char**)
-
- o
get_Category(char**)
-
- o
get_EventInterfaces(CATICStringList**)
-
- o
get_Interfaces(CATICStringList**)
-
- o
get_KeyTypeUuid(GUID**)
-
- o
get_Uuid(GUID**)
-
Methods
o Instantiate
-
- Deprecated:
- V5R15
Instantiates a BO of this type using the appropriate key.
Role:
A BO instance can be optained through a query of by directly building it
from its key. The type (CNext) of the key object must be in compliance
with the value retrieved using get_KeyTypeUuid.
- Parameters:
-
- oInstance
- the newly instanciated BO
- iKey
- the key for the desired BO
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_INVALIDARG
- The Key type was not correct
- E_???
- Something went wrong
o get_BOTypeName
-
- Deprecated:
- V5R15
Retrieves the type name of the Business Object.
Role:
BOs are late (weakly) typed. The c++ BO implementation uses this type name
as a CNext late type.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_Category
-
- Deprecated:
- V5R14
Retrieves the of Category for this type of BO.
Role:
BOs are sorted according to functional categories e.g.: Folder, Link,
Tool this is used to retrieve the categorie for this type of BO.
This might be used by a client application to sort the types or to behave
differently depending on those category. It is up to the BO developer to
specify the category for his BO.
The list of possible categories is:
- Parameters:
-
- oCategory
- The retrieved category. This has been allocated with a call to new[]
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_EventInterfaces
-
- Deprecated:
- V5R14
Retrieves the names of the event (outgoing) interfaces for this BO.
Role:
a BO can fire events, this is the list of names of all the event
interfaces which can be called by this BO.
- Parameters:
-
- oInterfaceNames
- the retireved list of intefaces names.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_Interfaces
-
- Deprecated:
- V5R14
Retrieves the names of the Interfaces implemented by this BO.
- Parameters:
-
- oInterfaceNames
- The retrieved list of interfaces names.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_KeyTypeUuid
-
- Deprecated:
- V5R14
Retrieves the Uuid of the BO key type.
Role:
The Uuid of the BO key type.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_Uuid
-
- Deprecated:
- V5R15
Retrieves the type Uuid for this BO.
- Parameters:
-
- oUuid
- the retrieved uuid.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
This object is included in the file: ENOVIBODefinition.h
If needed, your Imakefile.mk should include the module: VPMXbmItf