All Categories  Class Hierarchy  This Category  Next  Indexes

ActionFlow Interface CATINEOVpmAFAction

CATINEOVpmAFAction

interface CATINEOVpmAFAction

Interface for manipulating an Action in VPM.

Method Index

o AddContext(char,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Creates a "context item" attached to the action.
o AddLink(): Creates a blank "affected object link" attached to the action.
o AddObject(): Creates a blank "affected object" attached to the action.
o AddObject(CATUnicodeString&): Creates a named "affected object" attached to the action.
o CanChangeOwner(): Checks if security allows to tranfer the action
o CanDemote(CATUnicodeString&,char): Returns action "demotability" (=1 if action can be demoted, =0 otherwise).
o CanPromote(CATUnicodeString&,char): Returns action "promotability" (=1 if action can be promoted, =0 otherwise).
o CanReject(CATUnicodeString&,char): Returns action "rejectability" (=1 if action can be rejected, =0 otherwise).
o CanSave(): Checks if security allows to save the action
o ChangeOwner(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,char&,CATUnicodeString&): Manages the transfer of the action.
o Demote(): Demotes the action to new status (use CanDemote before).
o GetActionCreator(): Returns action creator as person id (P&O).
o GetActionDescription(): Returns action description.
o GetActionName(): Same as GetPrimId.
o GetActionOwner(): Returns action owner as person id (P&O).
o GetActionPriority(): Returns action secondary priority.
o GetAllStatus(): Returns all possible statuses for an action.
o GetContextDatas(char,int&,int&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Retrieves effectivities from the action associated context.
o GetEndDate(): Returns action end date as "yyyy-mm-dd-hh.
o GetFolder(): Returns the action associated folder : =NULL_var if action has never been saved.
o GetHistoryCount(): Returns the number of entries in the action recorded history.
o GetHistoryItem(long,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Retrieves an entry (i.
o GetIndexedContext(char,long,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Retrieves a context item associated to the action.
o GetIndexedObject(long): Returns the handler of an "affected object" attached to the action.
o GetLinks(): Returns the list of "affected object link" attached to the action.
o GetNbr(): Returns the number of the action
o GetNoOfContexts(char): Returns the number of context items associated to the action.
o GetNoOfObjects(): Returns the number of "affected object" attached to the action.
o GetOrganization(): Returns the organization of the owner (P&O).
o GetParentName(): Get the Name of the parent action if the action is a generated action.
o GetPrimId(): Returns action primary identifier.
o GetSecondId(): Returns action secondary identifier.
o GetSite(): Returns the site of the Action
o GetStartDate(): Returns action start date as "yyyy-mm-dd-hh.
o GetStatus(): Returns action status.
o GetType(): Returns action type.
o GetVarious(int): Returns action indicators map.
o HasContext(char): Checks if there is a context associated to the action.
o Initialize(): To be called once after action object created to be able to use following accessors.
o OpenLog(char): Opens action log/memo/free-text associated file within the appropriate editor.
o Promote(): Promotes the action to new status (use CanPromote before).
o Reject(): Rejects the action to new status (use CanReject before).
o RemoveContext(char,int): Deletes a "context item" attached to the action.
o RemoveLink(CATINEOVpmAFAffectedObjectLink_var&): Deletes an "affected object link" attached to the action.
o RemoveObject(CATINEOVpmAFAffectedObject_var&): Deletes an "affected object" attached to the action.
o Save(): Saves the action to persistent repository.
o SetCreator(CATUnicodeString&): Sets action creator : to be called once before action first time save.
o SetDesc(CATUnicodeString&): Sets action description.
o SetEndDate(CATUnicodeString&): Sets action end date.
o SetFolder(CATINEOVpmFolder_var&): Associates a folder to the action (automatically called by Save).
o SetHistoryItem(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Appends a new entry (i.
o SetName(CATUnicodeString&): Same as SetPrimId.
o SetOwner(CATUnicodeString&,CATUnicodeString&): Sets action owner : WARNING this method should be called only once when
creating the action.
o SetParentName(CATUnicodeString&): Sets the name of the parent action for a child action Works only during the creation of the action to generate the primary id of the action from the primary id of the parent action.
o SetPrimId(CATUnicodeString&): Sets action primary identifier.
o SetPriority(CATUnicodeString&): Sets action priority.
o SetSecondId(CATUnicodeString&): Sets action secondary identifier : it differs from the primary identifier
when VPM settings have been changed to "secondary id" mode
(VPMSettings -a -n VPM_AFL_ACTION_ID -v 2).
o SetSite(CATUnicodeString&): Sets action site This method is not already effective
o SetStartDate(CATUnicodeString&): Sets action start date.
o SetStatus(CATUnicodeString&): Sets action status : WARNING this method should never be called as
the "status" attribute should be managed by the promote-demote.
o SetType(CATUnicodeString&): Sets action type.
o SetVarious(int,short unsigned): Sets action indicators map as :
position 1 : value=1 if action is open (on ":Activation" transition in status graph)
position 2 : NOT TO BE USED !
position 3 : NOT TO BE USED !
position 4 : value=1 if action has been generated
position 5 : value=1 if action is closed (on ":Completion" transition in status graph)
position 6 : NOT TO BE USED !
position 7 : NOT TO BE USED !
position 8 : value=1 if primary id has a site prefix (3 characters)

Methods

o AddContext

public virtual CATInterfaceObject_var AddContext(	const char	`iType`,
	const CATUnicodeString&	`iName`,
	const CATUnicodeString&	`iValue`,
	const CATUnicodeString&	`iDescr`)=0

Creates a "context item" attached to the action.

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)
iName: context item name (see #define statements at the top)
iValue: context item associated value
iDescr: context item description (see #define statements at the top)

Returns:

Handler on created object

o AddLink

public virtual CATINEOVpmAFAffectedObjectLink_var AddLink(

)=0

Creates a blank "affected object link" attached to the action.

Returns:: Handler on created object

o AddObject

public virtual CATINEOVpmAFAffectedObject_var AddObject(

)=0

Creates a blank "affected object" attached to the action.

Returns:: Handler on created object

o AddObject

public virtual CATINEOVpmAFAffectedObject_var AddObject( const CATUnicodeString& iName)=0

Creates a named "affected object" attached to the action.

Parameters:

iName: affected object name

Returns:

Handler on created object

o CanChangeOwner

public virtual unsigned short CanChangeOwner(

)=0

Checks if security allows to tranfer the action

Returns:: TRUE if action can be transfered

o CanDemote

public virtual short unsigned CanDemote(	CATUnicodeString&	`oNextOperation`,
	const char	`iCheck`	`= 'Y'`)=0

Returns action "demotability" (=1 if action can be demoted, =0 otherwise).

Parameters:

oNextOperation: name of operation in the status graph, that will be executed next if action is demoted
iCheck: If iCheck = 'Y', user exit CheckUsrCondition is called

Returns:

TRUE if action can be demoted

o CanPromote

public virtual short unsigned CanPromote(	CATUnicodeString&	`oNextOperation`,
	const char	`iCheck`	`= 'Y'`)=0

Returns action "promotability" (=1 if action can be promoted, =0 otherwise).

Parameters:

oNextOperation: name of operation in the status graph, that will be executed next if action is promoted
iCheck: if iCheck = 'Y', the user exit CheckUsrCondition is called

Returns:

TRUE if action can be promoted

o CanReject

public virtual short unsigned CanReject(	CATUnicodeString&	`oNextOperation`,
	const char	`iCheck`	`= 'Y'`)=0

Returns action "rejectability" (=1 if action can be rejected, =0 otherwise).

Parameters:

oNextOperation: name of operation in the status graph, that will be executed next if action is rejected
iCheck: If iCheck = 'Y', user exit CheckUsrCondition is called

Returns:

TRUE if action can be rejected

o CanSave

public virtual unsigned short CanSave(

)=0

Checks if security allows to save the action

Returns:: TRUE if the action can be saved

o ChangeOwner

public virtual long ChangeOwner(	const CATUnicodeString&	`iChangeMode`,
	const CATUnicodeString&	`iNewOwner`,
	const CATUnicodeString&	`iChangeDescription`,
	const char&	`iMailRequest`,
	const CATUnicodeString&	`iOrganization`	`= ""`)=0

Manages the transfer of the action.

Parameters:

iChangeMode: =":Transfer" for transfer, ":Delegate" for delegation (only ":Transfer" is implemented)
iNewOwner: person id (P&O) of recipient
iChangeDescription: description as single text line
iMailRequest: =1 if notification e-mail is to be sent to the recipient, =0 otherwise
iOrganization: organization id (P&O) of recipient;

Returns:

0 if transfer was successfull

o Demote

public virtual void Demote(

)=0

Demotes the action to new status (use CanDemote before). The user exit CheckUsrCondition is called

o GetActionCreator

public virtual CATUnicodeString GetActionCreator(

)=0

Returns action creator as person id (P&O).

o GetActionDescription

public virtual CATUnicodeString GetActionDescription(

)=0

Returns action description.

o GetActionName

public virtual CATUnicodeString GetActionName(

)=0

Same as GetPrimId.

o GetActionOwner

public virtual CATUnicodeString GetActionOwner(

)=0

Returns action owner as person id (P&O).

o GetActionPriority

public virtual CATUnicodeString GetActionPriority(

)=0

Returns action secondary priority.

o GetAllStatus

public virtual CATLISTV(CATUnicodeString)* GetAllStatus(

)=0

Returns all possible statuses for an action.

o GetContextDatas

public virtual void GetContextDatas(	char	`iType`,
	int&	`oTopRange`,
	int&	`oBotRange`,
	CATUnicodeString&	`oStartDate`,
	CATUnicodeString&	`oEndDate`,
	CATListOfCATUnicodeString&	`oOptionEffList`,
	CATListOfCATUnicodeString&	`oActionEffList`,
	CATListOfCATUnicodeString&	`oPersoEffList`,
	CATListOfCATUnicodeString&	`oWorkgEffList`)=0

Retrieves effectivities from the action associated context.

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)
oTopRange: top range for "Range" type effectivity
oBotRange: bottom range for "Range" type effectivity
oStartDate: start date for "Date" type effectivity
oEndDate: end date for "Date" type effectivity
oOptionEffList: list of options for "Option" type effectivity
oActionEffList: list of actions for "Action" type effectivity
oPersoEffList: list of actions for "Personal" type effectivity
oWorkgEffList: list of actions for "Working" type effectivity

o GetEndDate

public virtual CATUnicodeString GetEndDate(

)=0

Returns action end date as "yyyy-mm-dd-hh.mm.ss".

o GetFolder

public virtual CATINEOVpmFolder_var & GetFolder(

)=0

Returns the action associated folder : =NULL_var if action has never been saved.

o GetHistoryCount

public virtual long GetHistoryCount(

)=0

Returns the number of entries in the action recorded history.

o GetHistoryItem

public virtual void GetHistoryItem(	long	`iEventNo`,
	CATUnicodeString&	`oEvent`,
	CATUnicodeString&	`oStatus`,
	CATUnicodeString&	`oDate`,
	CATUnicodeString&	`oOwner`,
	CATUnicodeString&	`oDescription`)=0

Retrieves an entry (i.e. event) from the action recorded history. (see SetHistoryItem )

Parameters:

iEventNo: index of the entry (starting at 1, ending at GetHistoryCount ())
oEvent: event name
oStatus: status
oDate: event date as "yyyy-mm-dd-hh.mm.ss"
oOwner: event owner
oDescription: event description

o GetIndexedContext

public virtual void GetIndexedContext(	const char	`iType`,
	const long	`iContextNo`,
	CATUnicodeString&	`oContextType`,
	CATUnicodeString&	`oContextName`,
	CATUnicodeString&	`oContextDescription`)=0

Retrieves a context item associated to the action. (see AddContext )

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)
iContextNo: context item index (starting at 1, ending at
oContextType: context item name
oContextName: context item associated value
oContextDescription: context item description

o GetIndexedObject

public virtual CATINEOVpmAFAffectedObject_var GetIndexedObject( const long iObjectNo)=0

Returns the handler of an "affected object" attached to the action.

Parameters:

iObjectNo: object index (starting at 1, ending at

o GetLinks

public virtual CATLISTV(CATINEOVpmAFAffectedObjectLink_var) GetLinks(

)=0

Returns the list of "affected object link" attached to the action.

o GetNbr

public virtual int GetNbr(

)= 0

Returns the number of the action

o GetNoOfContexts

public virtual long GetNoOfContexts( const char iType)=0

Returns the number of context items associated to the action.

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)

o GetNoOfObjects

public virtual long GetNoOfObjects(

)=0

Returns the number of "affected object" attached to the action.

o GetOrganization

public virtual CATUnicodeString GetOrganization(

)= 0

Returns the organization of the owner (P&O).

o GetParentName

public virtual CATUnicodeString GetParentName(

)= 0

Get the Name of the parent action if the action is a generated action. Works only during the creation of the action to generate the primary id of the action from the primary id of the parent action.

Returns:: Name of the parent action

o GetPrimId

public virtual CATUnicodeString GetPrimId(

)=0

Returns action primary identifier.

o GetSecondId

public virtual CATUnicodeString GetSecondId(

)=0

Returns action secondary identifier.

o GetSite

public virtual CATUnicodeString GetSite(

)= 0

Returns the site of the Action

o GetStartDate

public virtual CATUnicodeString GetStartDate(

)=0

Returns action start date as "yyyy-mm-dd-hh.mm.ss".

o GetStatus

public virtual CATUnicodeString GetStatus(

)=0

Returns action status.

o GetType

public virtual CATUnicodeString GetType(

)=0

Returns action type.

o GetVarious

public virtual short unsigned GetVarious( int iPos)=0

Returns action indicators map. ( SetVarious )

o HasContext

public virtual short unsigned HasContext( const char iType)=0

Checks if there is a context associated to the action.

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)

Returns:

TRUE if action has a context

o Initialize

public virtual void Initialize(

)=0

To be called once after action object created to be able to use following accessors.

o OpenLog

public virtual int OpenLog( const char mode)=0

Opens action log/memo/free-text associated file within the appropriate editor.
(depending on VPM_AFL_LOG_FORMAT setting parameters and VPMBrowsers customization)

Parameters:

mode: unusued

Returns:

0 if successfull

o Promote

public virtual void Promote(

)=0

Promotes the action to new status (use CanPromote before). The user exit CheckUsrCondition is called

o Reject

public virtual void Reject(

)=0

Rejects the action to new status (use CanReject before). The user exit CheckUsrCondition is called

o RemoveContext

public virtual void RemoveContext(	const char	`iType`,
	int	`iIndex`)=0

Deletes a "context item" attached to the action.

Parameters:

iType: type of context ('M' for modification, 'R' for reference - use 'M' only)
iIndex: context item index (starting at 1, ending at

o RemoveLink

public virtual void RemoveLink( const CATINEOVpmAFAffectedObjectLink_var& iLink)=0

Deletes an "affected object link" attached to the action.

Parameters:

iLink: link handler

o RemoveObject

public virtual void RemoveObject( const CATINEOVpmAFAffectedObject_var& iObject)=0

Deletes an "affected object" attached to the action.

Parameters:

iObject: object handler

o Save

public virtual unsigned short Save(

)=0

Saves the action to persistent repository.

Returns:: TRUE if action has been correctly saved
Throws:: CATVpmAFSevereError

o SetCreator

public virtual void SetCreator( const CATUnicodeString& iCreator)=0

Sets action creator : to be called once before action first time save.

Parameters:

iCreator: action creator : person id (see P&O component) of user who created the action

o SetDesc

public virtual void SetDesc( const CATUnicodeString& iString)=0

Sets action description.

Parameters:

iString: action description : single line of text

o SetEndDate

public virtual void SetEndDate( const CATUnicodeString& iString)=0

Sets action end date.

Parameters:

iString: action end date as "yyyy-mm-dd-hh.mm.ss"

o SetFolder

public virtual void SetFolder( const CATINEOVpmFolder_var& iFolder)=0

Associates a folder to the action (automatically called by Save).

o SetHistoryItem

public virtual void SetHistoryItem(	const CATUnicodeString&	`iEvent`,
	const CATUnicodeString&	`iStatus`,
	const CATUnicodeString&	`iOwner`,
	const CATUnicodeString&	`iComment`)=0

Appends a new entry (i.e. event) to the action recorded history.
Note that this method is automatically called when creating a new action,
changing the owner (ChangeOwner), changing the status (Promote, Demote, Reject),
attaching or detaching an affected object (AddObject, RemoveObject).

Parameters:

iEvent: event name
iStatus: status resulting from the event (returned by GetStatus).
iOwner: user responsible for this event (usually current user at event time).
iComment: event description as single text line comment on the event

o SetName

public virtual void SetName( const CATUnicodeString& iString) = 0

Same as SetPrimId.

o SetOwner

public virtual void SetOwner(	const CATUnicodeString&	`iOwner`,
	const CATUnicodeString&	`iOrganization`	`= ""`)=0

Sets action owner : WARNING this method should be called only once when
creating the action. Method ChangeOwner should then be called to manage transfer/delegate.

Parameters:

iOwner: action owner : person id (see P&O component) of user who owns the action
iOrganization: organization of the role of the owner.

o SetParentName

public virtual void SetParentName( const CATUnicodeString& iParentName)=0

Sets the name of the parent action for a child action Works only during the creation of the action to generate the primary id of the action from the primary id of the parent action.

Parameters:

iParentName: Name of the parent action

o SetPrimId

public virtual void SetPrimId( const CATUnicodeString& iString)=0

Sets action primary identifier.

Parameters:

iString: action primary identifier (or action name) : should be unique

o SetPriority

public virtual void SetPriority( const CATUnicodeString& iString)=0

Sets action priority.

Parameters:

iString: action priority : the string should represent a number to be interpreted by the user interface (ex: "3" corresponds to "High" priority)

o SetSecondId

public virtual void SetSecondId( const CATUnicodeString& iString)=0

Sets action secondary identifier : it differs from the primary identifier
when VPM settings have been changed to "secondary id" mode
(VPMSettings -a -n VPM_AFL_ACTION_ID -v 2).

Parameters:

iString: action secondary identifier : should be set equals to primary id if not in "secondary id" mode

o SetSite

public virtual void SetSite( const CATUnicodeString& iSite) = 0

Sets action site This method is not already effective

Parameters:

iSite: Site of the owner of the action

o SetStartDate

public virtual void SetStartDate( const CATUnicodeString& iString)=0

Sets action start date.

Parameters:

iString: action start date as "yyyy-mm-dd-hh.mm.ss"

o SetStatus

public virtual void SetStatus( const CATUnicodeString& iString)=0

Sets action status : WARNING this method should never be called as
the "status" attribute should be managed by the promote-demote... methods.
This method should be private.

Parameters:

iString: action status

o SetType

public virtual void SetType( const CATUnicodeString& iString)=0

Sets action type. This operation results in the Status Graph that manages
the Action to be possibly changed.

Parameters:

iString: type name (to be extracted from the ActionTypes.txt customization file using the CATVpmAFAuthorizedActionTypes function)

o SetVarious

public virtual void SetVarious(	int	`iPos`,
	short unsigned	`iValue`)=0

Sets action indicators map as :
position 1 : value=1 if action is open (on ":Activation" transition in status graph)
position 2 : NOT TO BE USED !
position 3 : NOT TO BE USED !
position 4 : value=1 if action has been generated
position 5 : value=1 if action is closed (on ":Completion" transition in status graph)
position 6 : NOT TO BE USED !
position 7 : NOT TO BE USED !
position 8 : value=1 if primary id has a site prefix (3 characters)

Parameters:

iPos: indicator position (from 1 to 8)
iValue: indicator value (0 or 1)

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