All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMXBom Interface ENOVIBOInstance
System.IUnknown
|
+---VPMXBom.ENOVIBase
|
+---VPMXBom.ENOVIObject
|
+---ENOVIBOInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIBOInstance
- Deprecated:
- V5R15
Interface representing a BO Instance.
Role:
For the standard BOs and those generated using the RAD tools this interface
is implemented by the XBom BO engine.
If a more specialized BO type is needed this interface can be reimplemented
for a given BO type, however in this case the ENOVIBODefinition should
in all the following code example lMyBOInstance is a valid pointer to
an ENOVIBOInstance interface
Method Index
- o
get_BODefinition(ENOVIBODefinition**)
-
- o
get_BOInstanceName(char**)
-
- o
get_LinkableName(char**)
-
- o
get_MaskedView(ENOVIAttributeDefinitions**)
-
- o
get_TypeUuid(GUID**)
-
- o
get_XMLStream(char**)
-
Methods
o get_BODefinition
-
- Deprecated:
- V5R15
Retrieves the BO definition associated with this instance.
Role:
This is a shortcut for the following series of code:
ENOVIAttributeDefinitions * lAttrDefs = NULL;
ENOVIBODefinition * lBODef = NULL;
HRESULT rc = lMyBOInstance->get_AttributeDefinitions(&lAttrDefs);
if (SUCCEEDED(rc))
{
rc = lAttrDefs->QueryInterface(IID_ENOVIBODefinition, &lBODef);
lAttrDefs->Release();
}
- Parameters:
-
- oBODefinition
- The retrieved BO definition.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- All went well but this BO doesn't have any display name. the
- E_???
- Something went wrong
o get_BOInstanceName
-
- Deprecated:
- V5R15
Retrieves the name of the Business Object instance.
Role:
This is what should be used whenever a name for a BO instance will be
presented to a user.
This cannot be used to retrieve the BO so whenever a programatic Id is
needed for a BO instance (like for all Enovia Foundation Classes objects)
the ENOVIIdentifiedObject interface should be used.
- Parameters:
-
- oBOInstanceName
- The retrieved name. This is allocated using new[] it is the
responsability of the caller to use the delete[] operator to free it.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- All went well but this BO doesn't have any display name. the
- E_???
- Something went wrong
o get_LinkableName
-
- Deprecated:
- V5R15
Retrieves the instance symbolic link.
Role:
The returned symbolic link can be used to dereference the BO Instance.
- Parameters:
-
- oLinkableName
- the retrieved link. This is allocated using new[] it is the
responsability of the caller to free it with delete[].
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- This BO doesn't have a linkable name
- E_???
- Something went wrong
o get_MaskedView
-
- Deprecated:
- V5R15
Retrieves the masked view of the BO.
Role:
Masks can be defined in ENOVIA, this will returned the BO attribute
definitions view filtered through the appropriate Mask.
- Parameters:
-
- oMaskedView
- The retrieved attribute definitions.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_TypeUuid
-
- Deprecated:
- V5R15
Retrieves the Uuid of the BO type.
Role:
this is a shortcut to the following code
ENOVIBODefinition * lBODef = NULL;
UUID * lTypeUuid = NULL;
HRESULT rc = lMyBOInstance->get_BODefinition(&lBODef);
if (SUCCEEDED(rc))
{
rc = lBODef->get_Uuid(&lTypeUuid);
lBODef->Release();
}
- Parameters:
-
- oTypeUuid
- The retrieved type uuid.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_XMLStream
-
- Deprecated:
- V5R14
Retrieves the XML stream of the serialized BO.
Role:
The data in a BO instance (the value of its attributes). Can be
serialized in XML.
- Parameters:
-
- oXML
- The retrieved XML.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
This object is included in the file: ENOVIBOInstance.h
If needed, your Imakefile.mk should include the module: VPMXbmItf