All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMXBom Interface ENOVIModeler
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIModeler
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIModeler
Interface representing a Modeler.
Role:
The role of a modeler is to manage a set of persistent object types.
Method Index
- o
ConvertToEntity(char*,int)
- Retrieves the name of the entity corresponding to a specified late type.
- o
ConvertToLate(char*,int)
- Computes the late type of the specified entity name.
- o
CreateObject(CATUnicodeString*,ENOVIObject**)
- Create a new object of a type managed by this modeler.
- o
get_DependentModelers(ENOVIModelers**)
- Retrieves the list of modelers that use the present one.
- o
get_ListOfObjectTypeNames(CATIStringList**)
-
- o
get_ListOfObjectTypeNames(CATListOfCATUnicodeString**)
- Retrieves the list of names of object types managed by this modeler.
- o
get_ModelerName(CATUnicodeString*)
- Retrieves the name of the modeler.
- o
get_TypeDefinition(CATUnicodeString*,ENOVIAttributeDefinitions**)
- Retrieves a type definition from a type name.
Methods
o ConvertToEntity
public virtual char * ConvertToEntity( | const char* | iLateType, |
| int | iIsModeler | = 0) const =0 |
-
Retrieves the name of the entity corresponding to a specified late type.
- Parameters:
-
- iLateType
- The late type.
- iIsModeler
- Flag to precise if the entity is a modeler or not. Not a modeler by default.
- Returns:
- The name of the entity
o ConvertToLate
public virtual char * ConvertToLate( | const char* | iEntity, |
| int | iIsModeler | = 0) const =0 |
-
Computes the late type of the specified entity name.
- Parameters:
-
- iEntity
- The entity name.
- iIsModeler
- Flag to precise if the entity is a modeler or not. Not a modeler by default.
- Returns:
- The name of the entity
o CreateObject
-
Create a new object of a type managed by this modeler.
Role:
Create a new instance of one of the object type managed by this modeler. This will usually
implies the creation of a new row in the database if the object instantiated is persistent
or has a persistent key.
The list of types which can be passed in the first parameter can be retrieved using the
get_ListOfObjectTypeNames method.
- Parameters:
-
- iType
- The type of the object to instanciate.
- oCreateObject
- The created object.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_DependentModelers
-
Retrieves the list of modelers that use the present one.
- Parameters:
-
- oModelers
- The found list.
o get_ListOfObjectTypeNames
-
- Deprecated:
- V5R14
Retrieves the list of names of object types managed by this modeler.
Role:
The preferred method to achieve this end, is to use the
get_ListOfObjectTypeNames method with a CATListOfCATUnicodeString parameter.
- Parameters:
-
- oObjectTypeNames
- The retrieved list of Object type names.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_ListOfObjectTypeNames
-
Retrieves the list of names of object types managed by this modeler.
Role:
This is the prefered method to achieve this end.
- Parameters:
-
- oObjectTypeNames
- The retrieved list of Object type names.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_ModelerName
-
Retrieves the name of the modeler.
- Parameters:
-
- oModelerName
- The retrieved modeler name.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_TypeDefinition
-
Retrieves a type definition from a type name.
- Parameters:
-
- iType
- The name of the type to retrieve.
- oObjectTypeDescription
- The retrieved type definition.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- This type is not managed by this modeler
- E_???
- Something went wrong
This object is included in the file: ENOVIModeler.h
If needed, your Imakefile.mk should include the module: VPMXbmItf