All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMXBom Interface ENOVILoginSession

System.IUnknown
  |
  +---ENOVILoginSession
 

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


interface ENOVILoginSession

Interface to the login session.
Role: This is the entry point for all user dependant actions, once a pointer to this interface has been obtained, it is assumed that the user has been authenticated and that the implementation of the interface keeps track of the user's permissions.

See also:
ENOVIApplication


Method Index


o Abort()
Reverts to the last saved state.
o Close()
Closes the session.
o GetENOVIObject(CATUnicodeString*,ENOVIObject**)
Dereferences a LinkableName.
o Save()
Saves the session.
o Undo()
Undo the last Command.
o get_Commands(ENOVIObject*,ENOVICommands**)
o get_ListOfModelerNames(CATListOfCATUnicodeString**)
Retrieves the list of installed modelers.
o get_ListOfQueriableModelerNames(CATIStringList**)
Retrieves the list of queriable modeler names.
o get_ManagerInterface(IID&,void**)
Retrieves a manager specified by its manager interface.
o get_MaskedView(char*,ENOVIAttributeDefinitions*,ENOVIAttributeDefinitions**)
Retrieves a masked version of an object description.
o get_Modelers(ENOVIModelers**)
Retrieves the modelers' collection.

Methods


o Abort
public virtual HRESULT __stdcall Abort()=0
Reverts to the last saved state.
Role: Used to abort all modifications since the last Save (<==> Rollback)
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o Close
public virtual HRESULT __stdcall Close()=0
Closes the session.
Role: This is used to close this login session, all unsaved data will be lost (similar to a call to abort) and all internal state is cleaned.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o GetENOVIObject
public virtual HRESULT __stdcall GetENOVIObject(CATUnicodeString* iLinkableName,
ENOVIObject** oGetENOVIObject)=0
Dereferences a LinkableName.
Role: Used to dereference an object whose linkable name ( see CATILinkableObject ) is known. this will be used.
Example: this example will dereference an object which Linkable name was saved during a previous session. It is assumed that the variable ln is of type CATUnicodeString and contains the LinkableName and that the variable ls is of type ENOVILoginSession and is pointing toward a valid implementation.
    	ENOVIObject * myObject = NULL;
    	rc = ls->GetENOVIObject(&ln, &myObject);
		if (FAILED(rc))
		{
			cout << "Failed to dereference the identifier" << ls.ConvertToChar() << endl;
			return rc;
		}
  
Parameters:
iLinkableName
The linkable name of the object to retrieved.
oGetENOVIObject
The retrieved object.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
See also:
ENOVIObject
See also:
ENOVIBOInstance
o Save
public virtual HRESULT __stdcall Save()=0
Saves the session.
Role: Used to save all modifications since the last Save (<==> Commit)
Returns:
An HRESULT value
Legal values:
S_OK
All went well and all was saved
S_FALSE
All went well but nothing needed saving
E_???
Something went wrong
o Undo
public virtual HRESULT __stdcall Undo()=0
Undo the last Command.
Role: This will attempt to undo the last command. Since some commands may not be undoable this can fail.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
S_FALSE
All went well but there wasn't anything to undo
E_???
Something went wrong
o get_Commands
public virtual HRESULT __stdcall get_Commands(ENOVIObject* iInstance,
ENOVICommands** oCommands)=0
Deprecated:
V5R15 This is for DS internal use only.
o get_ListOfModelerNames
public virtual HRESULT __stdcall get_ListOfModelerNames(CATListOfCATUnicodeString** oModelerNames)=0
Retrieves the list of installed modelers.
Role: Used to get the list of names of all the modelers installed on the server accessible by the current user. This list can be used to choose which modeler to instanciate.
Parameters:
oModelerNames
[out, delete] The retrieved list of modeler names
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o get_ListOfQueriableModelerNames
public virtual HRESULT __stdcall get_ListOfQueriableModelerNames(CATIStringList** oModelerNames)=0
Retrieves the list of queriable modeler names.
Role: Some modelers may not be used by the query. This is the case of a certain number of system modelers. This method is used to gain access only to those modelers which will work as expected with the query.
Parameters:
oModelerNames
[out, delete] the retrieved list of names
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o get_ManagerInterface
public virtual HRESULT __stdcall get_ManagerInterface( const IID& iIID,
void** oPPV)=0
Retrieves a manager specified by its manager interface.
Parameters:
iIID
the identifier of the manager interface
oPPV
[out, CATBaseUnknown#Release] the retrieved manager
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o get_MaskedView
public virtual HRESULT __stdcall get_MaskedView( const char* iOperation,
ENOVIAttributeDefinitions* iDefToMask,
ENOVIAttributeDefinitions** oMaskedDef)=0
Retrieves a masked version of an object description.
Role: The descriptions of the attribute for a given object type may depend on the operation which is performed on the object. This method is used to obtain this "masked" view of the object.
Parameters:
iOperation
the operation applied to the object. if this is NULL, the returned MaskedDef contains only the entity alias from the masks.
iDefToMask
the definition of the object to be masked
oMaskedDef
[out, CATBaseUnknown#Release] the retrieved masked definition
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
o get_Modelers
public virtual HRESULT __stdcall get_Modelers(ENOVIModelers** oModelers)=0
Retrieves the modelers' collection.
Role: The modelers' collection has a double role: In short, if a modeler which is accessed by name hasn't been accessed before it will be instantiated (lazy instantiation), but only the previously accessed (and therefore instanciated) can be accessed by index.
Parameters:
oModelers
[out, CATBaseUnknown#Release] The retrieved modelers collection used to iterate other the instanciated modelers or to instanciate new ones
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
Something went wrong
See also:
ENOVIModelers
See also:
ENOVIModeler

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

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