All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

ActionFlow Class CATVpmUsrAction

CATVpmUsrAction

public class CATVpmUsrAction

Constructor and Destructor Index

o CATVpmUsrAction(): Creates an action
o CATVpmUsrAction(CATUnicodeString&): Reads an action from the database
o CATVpmUsrAction(CATVpmAction&)
o CATVpmUsrAction(CATVpmUsrAction&): Copies an action
o ~CATVpmUsrAction()

Method Index

o AddFile(CATVpmUsrActionFile&): Add a file to the action
o AddObject(CATVpmUsrActionObject&): Add an object to the action
o CanDemote(int&): Checks if you can demote the action, according to your privileges and to the action status
o CanPromote(int&): Checks if you can promote the action, according to your privileges and to the action status
o CanReject(int&): Checks if you can reject the action, according to your privileges and to the action status
o CanSave(): Checks if you are allowed to save the action, according to your privileges and to the action status
o CanTransfer(): Checks wether you can transfer the action, according to your privilieges and to the action status
o CreateChild(): Generates a child action
o Demote(): Demotes the action
o GetConfigHandler(): Gets the configuration handler
o GetCreator(): Gets the creator of the action
o GetDescription(): Gets the typedescription the action
o GetEndDate(): Gets the end date of the action
o GetError(): Gets the error
o GetFile(CATUnicodeString&): Get a file
o GetFiles(CATListOfCATVpmUsrActionFile&): Get the list of files of the action
o GetHistoryList(CATListOfCATVpmUsrActionHistory&): Checks if the next promotion of the action is the validation
o GetId(): Gets the type of the action
o GetLogFile(int&): Get the action log file
o GetName(): Gets the name of the action
o GetNbr(): Gets the number of the action
o GetObject(CATUnicodeString&): Get an object of the action from its OIDR
o GetObjects(CATListOfCATVpmUsrActionObject&): Get the list of objects of the action
o GetOrganization(): Gets the organization of the action
o GetOwner(): Gets the owner of the action
o GetPriority(): Gets the priority number of the action
o GetProductCaenv(): Gets the environment of the product
o GetProductCoid(): Gets the $COID of the product
o GetProductName(): Gets the name of the product
o GetSite(): Gets the site of the action
o GetStartDate(): Gets the start date of the action
o GetStatus(): Gets the status of the action
o GetSuffix(): Gets the suffix of the action
o GetType(): Gets the type of the action
o GetWorkingEffectivity(): Gets the working effectivity of the action
o IsClosed(): Checks if the action is closed, and therefore can't be modified
o IsFiled(): Checks if the action is in the database
o IsModified(): Checks if the action is modified and needs to be saved
o IsNextPromotionAValidation(): Checks wether the next promotion is the validation
o IsOpen(): Checks if the action is open, i.
o LocateFile(CATUnicodeString&): Checks wether a file is associated to the action
o Promote(): Promotes the action
o RefreshObjectNames(): Refreshes the names of the associated objects
o Reject(): Rejects the action
o RejectModif(CATVpmUsrActionObject&): Reject a modification (link) from the action
o RemoveFile(CATUnicodeString&): Remove a file from the action
o RemoveFile(CATVpmUsrActionFile&): Remove a file from the action
o RemoveObject(CATUnicodeString&): Remove an object from the action
o RemoveObject(CATVpmUsrActionObject&): Remove an object from the action
o Save(): Saves the action
o SaveFiles(): Save the associated files in the action
o SetConfigHandler(CATUnicodeString&): Sets the configuration handler to apply on the product
o SetDescription(CATUnicodeString&): Sets the description of the action
o SetEndDate(CATUnicodeString&): Sets the end date of the action
o SetId(CATUnicodeString&): Sets the identifier of the action
o SetLock(int&): Locks or unlocks the action
o SetPriority(CATUnicodeString&): Sets the priority number of the action
o SetProductCaenv(CATUnicodeString&): Sets the environment of the product
o SetProductCoid(CATUnicodeString&): Sets the $COID of the product
o SetProductName(CATUnicodeString&): Sets the name of the product
o SetSite(CATUnicodeString&): Sets the site of the action
o SetStartDate(CATUnicodeString&): Sets the start date of the action
o SetType(CATUnicodeString&): Sets the type of the action
o Transfer(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int&): Transfers the action
o UpdateFile(CATVpmUsrActionFile&): Update a file of the action
o UpdateObject(CATVpmUsrActionObject&): Update an associated object of the action

Constructor and Destructor

o CATVpmUsrAction

public CATVpmUsrAction(

)

Creates an action

o CATVpmUsrAction

public CATVpmUsrAction( const CATUnicodeString& iId)

Reads an action from the database

Parameters:

iId: Action identifier

Returns:

The action

o CATVpmUsrAction

public CATVpmUsrAction( const CATVpmAction& iAction)

o CATVpmUsrAction

public CATVpmUsrAction( const CATVpmUsrAction& iAction)

Copies an action

Parameters:

iAction: Action to copy

Returns:

The new action

o ~CATVpmUsrAction

public ~CATVpmUsrAction(

)

Methods

o AddFile

public Error AddFile( CATVpmUsrActionFile& iFile)

Add a file to the action

Parameters:

iFile: the associated file

Returns:

Error

o AddObject

public Error AddObject( CATVpmUsrActionObject& iObject)

Add an object to the action

Parameters:

iObject: the associated object

Returns:

Error

o CanDemote

public int CanDemote( const int& iUserCondition)

Checks if you can demote the action, according to your privileges and to the action status

Parameters:

iUserCondition: if iUserCondition = 1, the user exit CheckUsrCondition is called

Returns:

0: no, 1: yes

o CanPromote

public int CanPromote( const int& iUserCondition)

Checks if you can promote the action, according to your privileges and to the action status

Parameters:

iUserCondition: if iUserCondition = 1, the user exit CheckUsrCondition is called

Returns:

0: no, 1: yes

o CanReject

public int CanReject( const int& iUserCondition)

Checks if you can reject the action, according to your privileges and to the action status

Parameters:

iUserCondition: if iUserCondition = 1, the user exit CheckUsrCondition is called

Returns:

0: no, 1: yes

o CanSave

public int CanSave(

)

Checks if you are allowed to save the action, according to your privileges and to the action status

Returns:: 1 if you can save the action, 0 otherwise

o CanTransfer

public int CanTransfer(

)

Checks wether you can transfer the action, according to your privilieges and to the action status

Returns:: 0: no, 1: yes

o CreateChild

public CATVpmUsrAction* CreateChild(

)

Generates a child action

Returns:: The new action

o Demote

public int Demote(

)

Demotes the action

Returns:: 0: action not demoted, 1: action demoted

o GetConfigHandler

public CATUnicodeString GetConfigHandler(

)const

Gets the configuration handler

Returns:: The name of the configuration handler

o GetCreator

public CATUnicodeString GetCreator(

)const

Gets the creator of the action

Returns:: The id of the creator of the action

o GetDescription

public CATUnicodeString GetDescription(

)const

Gets the typedescription the action

Returns:: The description of the action

o GetEndDate

public CATUnicodeString GetEndDate(

)const

Gets the end date of the action

Returns:: The end date of the action ("yyyy-mm-dd-hh.mm.ss")

o GetError

public Error GetError(

)

Gets the error

Returns:: Error

o GetFile

public CATVpmUsrActionFile* GetFile( const CATUnicodeString& iOIDR)

Get a file

Parameters:

iOIDR: The OIDR of the file

Returns:

The file

o GetFiles

public Error GetFiles( CATListOfCATVpmUsrActionFile& oList)

Get the list of files of the action

Parameters:

oList: the list of files

Returns:

Error

o GetHistoryList

public void GetHistoryList( CATListOfCATVpmUsrActionHistory& oList) const

Checks if the next promotion of the action is the validation

Returns:

0: no, 1: yes * Gets the list of the action histories

Parameters:

oList: the list of action histories

o GetId

public CATUnicodeString GetId(

)const

Gets the type of the action

Returns:: The type of the action (The available types are defined in the resource file ActionTypes.txt)

o GetLogFile

public CATVpmUsrActionFile* GetLogFile( int& oNew)

Get the action log file

Parameters:

oNew: The file is new

Returns:

The action log file

o GetName

public CATUnicodeString GetName(

)const

Gets the name of the action

Returns:: The name of the action

o GetNbr

public int GetNbr(

)const

Gets the number of the action

Returns:: The number used to generate the primary id of the action

o GetObject

public CATVpmUsrActionObject* GetObject( const CATUnicodeString& iObjectOIDR)

Get an object of the action from its OIDR

Parameters:

iOIDR: the OIDR of the object

Returns:

the associated object

o GetObjects

public void GetObjects( CATListOfCATVpmUsrActionObject& oList) const

Get the list of objects of the action

Parameters:

oList: the list of associated objects

o GetOrganization

public CATUnicodeString GetOrganization(

)const

Gets the organization of the action

Returns:: The id of the organization of the action

o GetOwner

public CATUnicodeString GetOwner(

)const

Gets the owner of the action

Returns:: The id of the owner of the action with the complete path USR/ORG1/ORG2...

o GetPriority

public CATUnicodeString GetPriority(

)const

Gets the priority number of the action

Returns:: The priority number is defined in the CATVpmActionEditor resource file

o GetProductCaenv

public CATUnicodeString GetProductCaenv(

)const

Gets the environment of the product

Returns:: The environment of the product

o GetProductCoid

public CATUnicodeString GetProductCoid(

)const

Gets the $COID of the product

Returns:: The $COID of the product

o GetProductName

public CATUnicodeString GetProductName(

)const

Gets the name of the product

Returns:: The name of the product

o GetSite

public CATUnicodeString GetSite(

)const

Gets the site of the action

Returns:: The id of the site of the action with its complete path: /ORG1/ORG2...

o GetStartDate

public CATUnicodeString GetStartDate(

)const

Gets the start date of the action

Returns:: The start date of the action ("yyyy-mm-dd-hh.mm.ss")

o GetStatus

public CATUnicodeString GetStatus(

)const

Gets the status of the action

Returns:: The status of the action

o GetSuffix

public CATUnicodeString GetSuffix(

)const

Gets the suffix of the action

Returns:: The suffix is generated for a child action (--A for the first child)

o GetType

public CATUnicodeString GetType(

)const

Gets the type of the action

Returns:: The type of the action (a

o GetWorkingEffectivity

public CATUnicodeString GetWorkingEffectivity(

)const

Gets the working effectivity of the action

Returns:: The working effectivity that tags the links modified with the action before the validation

o IsClosed

public int IsClosed(

)

Checks if the action is closed, and therefore can't be modified

Returns:: 0: no, 1: yes

o IsFiled

public int IsFiled(

)

Checks if the action is in the database

Returns:: 0: no, 1: yes

o IsModified

public int IsModified(

)

Checks if the action is modified and needs to be saved

Returns:: 0: no, 1: yes

o IsNextPromotionAValidation

public int IsNextPromotionAValidation(

)

Checks wether the next promotion is the validation

Returns:: 0: no, 1: yes

o IsOpen

public int IsOpen(

)const

Checks if the action is open, i.e. if it can save links

Returns:: 0: no, 1: yes

o LocateFile

public int LocateFile( const CATUnicodeString& iFileName) const

Checks wether a file is associated to the action

Parameters:

iFileName: the name of the file

Returns:

0: no, 1: yes

o Promote

public int Promote(

)

Promotes the action

Returns:: 0: action not promoted, 1: action promoted

o RefreshObjectNames

public int RefreshObjectNames(

)

Refreshes the names of the associated objects

Returns:: 0: no refresh needed, 1: some names are refreshed and the action is modified

o Reject

public int Reject(

)

Rejects the action

Returns:: 0: action not rejected, 1: action rejected

o RejectModif

public int RejectModif( CATVpmUsrActionObject& iLink)

Reject a modification (link) from the action

Parameters:

iLink: the link to remove

Returns:

0: the link is not removed, 1: the link is removed

o RemoveFile

public Error RemoveFile( const CATUnicodeString& iOIDR)

Remove a file from the action

Parameters:

iOIDR: the OIDR of the associated file

Returns:

Error

o RemoveFile

public Error RemoveFile( CATVpmUsrActionFile& iFile)

Remove a file from the action

Parameters:

iFile: the associated file

Returns:

Error

o RemoveObject

public Error RemoveObject( const CATUnicodeString& iOIDR)

Remove an object from the action

Parameters:

iOIDR: the OIDR of the associated object

Returns:

Error

o RemoveObject

public Error RemoveObject( CATVpmUsrActionObject& iObject)

Remove an object from the action

Parameters:

iObject: the associated object

Returns:

Error

o Save

public int Save(

)

Saves the action

Returns:: 1 if the action is saved, 0 otherwise

o SaveFiles

public Error SaveFiles(

)

Save the associated files in the action

Returns:: Error

o SetConfigHandler

public Error SetConfigHandler( const CATUnicodeString& iConfigHandler)

Sets the configuration handler to apply on the product

Parameters:

iConfigHandler: The name of the configuration handler

Returns:

Error

o SetDescription

public Error SetDescription( const CATUnicodeString& iDescription)

Sets the description of the action

Parameters:

iDescription: Description of the action

Returns:

Error

o SetEndDate

public Error SetEndDate( const CATUnicodeString& iDate)

Sets the end date of the action

Parameters:

iDate: The end date of the action ("yyyy-mm-dd-hh.mm.ss")

Returns:

Error

o SetId

public Error SetId( const CATUnicodeString& iId)

Sets the identifier of the action

Parameters:

iId: Effective only in secondary id mode

Returns:

Error

o SetLock

public Error SetLock( const int& iLock)

Locks or unlocks the action

Parameters:

iLock: Not yet implemented

Returns:

Error

o SetPriority

public Error SetPriority( const CATUnicodeString& iPriority)

Sets the priority number of the action

Parameters:

iPriority: The priority number is defined in the CATVpmActionEditor resource file

Returns:

Error

o SetProductCaenv

public Error SetProductCaenv( const CATUnicodeString& iCaenv)

Sets the environment of the product

Parameters:

iCaenv: The environment of the product

Returns:

Error

o SetProductCoid

public Error SetProductCoid( const CATUnicodeString& iCOID)

Sets the $COID of the product

Parameters:

iCOID: The $COID of the product

Returns:

Error

o SetProductName

public Error SetProductName( const CATUnicodeString& iName)

Sets the name of the product

Parameters:

iName: The name of the product

Returns:

Error

o SetSite

public Error SetSite( const CATUnicodeString& iSite)

Sets the site of the action

Parameters:

iSite: It can't be modified once the action is saved

Returns:

Error

o SetStartDate

public Error SetStartDate( const CATUnicodeString& iDate)

Sets the start date of the action

Parameters:

iDate: The start date of the action ("yyyy-mm-dd-hh.mm.ss")

Returns:

Error

o SetType

public Error SetType( const CATUnicodeString& iType)

Sets the type of the action

Parameters:

iType: The type of the action must be defined in the Action Types file

Returns:

Error

o Transfer

public Error Transfer(	const CATUnicodeString&	`iNewOwner`,
	const CATUnicodeString&	`iOrganization`,
	const CATUnicodeString&	`iChangeDescription`,
	const int&	`iMailRequest`)

Transfers the action

Parameters:

iNewOwner: The id of the new owner
iOrganization: The id of the new organization
iChangeDescription: The description of the transfer
iMailRequest: 0: no mail is sent, 1: a mail is sent to iNewOwner

Returns:

Error

o UpdateFile

public Error UpdateFile( const CATVpmUsrActionFile& iFile)

Update a file of the action

Parameters:

iFile: the associated file

Returns:

Error

o UpdateObject

public Error UpdateObject( CATVpmUsrActionObject& iObject)

Update an associated object of the action

Parameters:

iObject: the object to update

Returns:

Error

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