All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVInterfaces Interface ENOVIABOVersionMaster

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


interface ENOVIABOVersionMaster

Interface to control the different versions of a business object.
Role: Some business objects are made of a master object defined by an identifier, and a version object defined by the version. This interface helps creating a new version of an object, retrieving the last version.


Method Index


o CreateMaster(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOVersionMaster*&)
o CreateMaster(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOVersionMaster*&)
Creates a new versionnable business object.
o NewVersion(CATUnicodeString&,ENOVIABOVersionMaster*&,ENOVIABOVersionMaster*)
o NewVersion(CATUnicodeString&,CATUnicodeString&,ENOVIABOVersionMaster*&,ENOVIABOVersionMaster*)
Creates a new version of a versionnable business object.
o RemoveAllVersions()
Removes all the versionnable business object 's versions.
o get_LastVersion(ENOVIABOVersionMaster*&)
Returns the last version of a versionnable business object.
o get_PreferedVersion(ENOVIABOVersionMaster*&)
Returns the prefered version of a versionnable business object.

Methods


o CreateMaster
public virtual CreateMaster( const iId,
const iName,
const iDescription,
oObject)
Deprecated:
V5R15 Creates a new versionnable business object.
Parameters:
iId
The identifier of the new object.
iName
The name of the new object.
iDescription
The description of the new object.
oObject
The new created object.
Returns:
S_OK in case of success, E_FAIL in case of error.
o CreateMaster
public virtual CreateMaster( const iId,
const iName,
const iDescription,
const iEnvironment,
oObject)
Creates a new versionnable business object.
Parameters:
iId
The identifier of the new object.
iName
The name of the new object.
iDescription
The description of the new object.
iEnvironment
The environment in which the new object will be created.
oObject
The new created object.
Returns:
S_OK in case of success, E_FAIL in case of error.
o NewVersion
public virtual NewVersion( const iVersion,
oObject,
iFromVersion= 0 )
Deprecated:
V5R15 Creates a new version of a versionnable business object.
Parameters:
iVersion
The new version of the object to create.
oObject
The new created object.
iFromVersion
The object version the new version inherits from (optional).
Returns:
S_OK in case of success, E_FAIL in case of error.
o NewVersion
public virtual NewVersion( const iVersion,
const iEnvironment,
oObject,
iFromVersion= 0 )
Creates a new version of a versionnable business object.
Parameters:
iVersion
The new version of the object to create.
iEnvironment
The environment in which the new version will be created.
oObject
The new created object.
iFromVersion
The object version the new version inherits from (optional).
Returns:
S_OK in case of success, E_FAIL in case of error.
o RemoveAllVersions
public virtual RemoveAllVersions()
Removes all the versionnable business object 's versions.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_LastVersion
public virtual get_LastVersion( oObject)
Returns the last version of a versionnable business object.
Parameters:
oObject
The last version of the object.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PreferedVersion
public virtual get_PreferedVersion( oObject)
Returns the prefered version of a versionnable business object.
Parameters:
oObject
The preferred version of the object.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.