All Categories Class Hierarchy This Category Previous Next Indexes
ActionFlow Interface CATINEOVpmAFStatus
CATINEOVpmAFStatus
interface CATINEOVpmAFStatus
Interface for managing the status of a VPM object (at the moment Action only).
The status manager follows the customizable Status Graph (file AP203.VAction in the directory
specified by the VPM_AFL_STATUS_GRAPH settings parameter)
Method Index
- o
CanDemote(CATUnicodeString&,char)
- Checks if managed object can be demoted according to the Status Graph.
- o
CanPromote(CATUnicodeString&,char)
- Checks if managed object can be promoted according to the Status Graph.
- o
CanReject(CATUnicodeString&,char)
- Checks if managed object can be rejected according to the Status Graph.
- o
CanResume(CATUnicodeString&)
- Checks if managed object can be resumed according to the Status Graph.
- o
CanSuspend(CATUnicodeString&)
- Checks if managed object can be suspended according to the Status Graph.
- o
ChangeGraph(CATUnicodeString&)
- Changes the Status Graph that manages the object.
- o
Demote()
- Demotes the managed object.
- o
GetLastCommands(CATLISTV(CATUnicodeString)*,CATVpmAFListOfListOfString*,CATVpmAFListOfListOfString*)
- Retrieves operation commands associated to last transition.
- o
GetLastOperation()
- Returns operation associated to last transition.
- o
GetLastStatus()
- Returns empty string (not implemented).
- o
GetStatusList()
- Returns list of all statuses defined.
- o
GetStatusName()
- Returns current status name.
- o
IsOpen()
- Checks if managed object is open (on ":Activation" transition in status graph).
- o
Promote()
- Promotes the managed object.
- o
Reject()
- Rejects the managed object.
- o
Resume()
- Resumes the managed object.
- o
Suspend()
- Suspends the managed object.
Methods
o CanDemote
| public virtual short unsigned CanDemote( | CATUnicodeString& | oNextOperation, |
| const char | iCheck | = 'Y')=0 |
-
Checks if managed object can be demoted according to the Status Graph.
- Returns:
- TRUE if managed object can be demoted
o CanPromote
| public virtual short unsigned CanPromote( | CATUnicodeString& | oNextOperation, |
| const char | iCheck | = 'Y')=0 |
-
Checks if managed object can be promoted according to the Status Graph.
- Parameters:
-
- oNextOperation
- name of operation in the status graph, that will be executed next if action is promoted
- iCheck
- user exit CheckUsrCondition is called
- Returns:
- TRUE if managed object can be promoted
o CanReject
| public virtual short unsigned CanReject( | CATUnicodeString& | oNextOperation, |
| const char | iCheck | = 'Y')=0 |
-
Checks if managed object can be rejected according to the Status Graph.
- Returns:
- TRUE if managed object can be rejected
o CanResume
| public virtual short unsigned CanResume( | CATUnicodeString& | oNextOperation)=0 |
-
Checks if managed object can be resumed according to the Status Graph.
- Returns:
- TRUE if managed object can be resumed
o CanSuspend
| public virtual short unsigned CanSuspend( | CATUnicodeString& | oNextOperation)=0 |
-
Checks if managed object can be suspended according to the Status Graph.
- Returns:
- TRUE if managed object can be suspended
o ChangeGraph
| public virtual void ChangeGraph( | const CATUnicodeString& | iActionType)=0 |
-
Changes the Status Graph that manages the object.
- Parameters:
-
- iActionType
- New Graph name (usually given by new Action type)
- See also:
- CATINEOVpmAFAction.SetType
o Demote
| public virtual short unsigned Demote( | )=0 |
-
Demotes the managed object.
- Returns:
- TRUE if managed object has been be demoted
o GetLastCommands
-
Retrieves operation commands associated to last transition.
A single command is made of a statement, a list of conditions, and a list of
parameters. All lists returned by this method have the same size.
- Parameters:
-
- oStatementList
- List of command statements
- oListOfConditionList
- List of empty lists (not implemented)
- oListOfParameterList
- List of lists of parameters (oListOfParameterList[i] is the parameters list for command oStatementList[i])
o GetLastOperation
| public virtual CATUnicodeString GetLastOperation( | )=0 |
-
Returns operation associated to last transition.
o GetLastStatus
| public virtual CATUnicodeString GetLastStatus( | )=0 |
-
Returns empty string (not implemented).
o GetStatusList
| public virtual CATLISTV(CATUnicodeString)* GetStatusList( | )=0 |
-
Returns list of all statuses defined.
- See also:
- CATINEOVpmAFActiont
o GetStatusName
| public virtual CATUnicodeString GetStatusName( | )=0 |
-
Returns current status name.
o IsOpen
| public virtual short unsigned IsOpen( | )=0 |
-
Checks if managed object is open (on ":Activation" transition in status graph).
- Returns:
- TRUE if managed object is open
- See also:
- CATINEOVpmAFAction.GetVarious
o Promote
| public virtual short unsigned Promote( | )=0 |
-
Promotes the managed object.
- Returns:
- TRUE if managed object has been be promoted
o Reject
| public virtual short unsigned Reject( | )=0 |
-
Rejects the managed object.
- Returns:
- TRUE if managed object has been be rejected
o Resume
| public virtual short unsigned Resume( | )=0 |
-
Resumes the managed object.
- Returns:
- TRUE if managed object has been be resumed
o Suspend
| public virtual short unsigned Suspend( | )=0 |
-
Suspends the managed object.
- Returns:
- TRUE if managed object has been be suspended
This object is included in the file: CATINEOVpmAFStatus.h
If needed, your Imakefile.mk should include the module: GUIDVirtualAction