All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmAFLAction

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIVpmAFLAction
 

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


interface CATIVpmAFLAction

Basic interface for Action objects.
Role: The interface provides functions for manipulating actions.


Method Index


o AddAttachement(CATUnicodeString&,SEQUENCE(octet)&,CATUnicodeString&,CATUnicodeString&,CATIVpmAFLAttachement_var&)
Create an attachement and add it to the action.
o AddData(CATIVpmAFLData_var&)
Create a data and add it to the action.
o AddHistory(CATIVpmAFLHistory_var&)
Create and add a history to the action.
o AddModifHistory(CATUnicodeString&,CATIVpmAFLProductView_var&,CATIVpmAFLAffectedObject_var&,CATIVpmAFLAffectedObject_var&)
Add a modification history to the action.
o AddObject(CATIVpmAFLAffectedObject_var&)
Add an affected object to the action.
o AddObject2(CATIVpmAFLAffectedObject_var&)
Available only from R17 onwards Add an affected object to the action.
o AddPV(CATIConfigurableObject_var&,CATIVpmAFLProductView_var&)
Create and add a product-view to the action by giving a CO.
o AddPV(CATIConfigurableObject_var&,CATIVpmAFLProductView_var&,CATICfgGroupModif_var&)
Create and add a product-view to the action by giving a CO.
o AddResponsability(CATIVpmAFLResp_var&)
Add a new responsability (user/role) to the current action.
o AddSimpleHistory(CATUnicodeString&,CATIVpmAFLHistory_var&)
Add an instrumented history: operation type, valuate date, user.
o AddSubscriber(CATIVpmAFLSubscribePV_var&)
Add a subscriber to the current action.
o DistributeObjects(CATIVpmAFLAction_var&,CATLISTV(CATIVpmAFLAffectedObject_var)&)
Distribute objects to another action.
o Dump(char*)
Print out all action attributes and related objects.
o FindAffObject(SEQUENCE(octet)&,CATIVpmAFLAffectedObject_var&)
Find an affected object giving its UUID.
o FindAffObject(SEQUENCE(octet)&,CATUnicodeString&,CATIVpmAFLAffectedObject_var&)
Find an affected object giving its UUID and change type.
o FindAffObject(SEQUENCE(octet)&,CATUnicodeString&,CATIVpmAFLAffectedObject_var&,CATUnicodeString&)
Available only from R17 onwards Find an affected object giving its UUID and change type and V_Source.
o GetAbstract(CATUnicodeString&)
Get the abstract of the action.
o GetActionsPointingMe(CATListValCATIVpmAFLAction_var&)
Get all the action pointing on me (as the leader for oriented links, or slave for symetric links).
o GetActionsPointingMe(CATUnicodeString,CATListValCATIVpmAFLAction_var&)
Get all the action pointing on me with a special type of link (as the leader for oriented links,or slave for symetric links).
o GetActualEndDate(CATTime&)
Get the actual end date of the action.
o GetActualStartDate(CATTime&)
Get the actual start date of the action.
o GetAllAffObj(CATLISTV(CATIVpmAFLAffectedObject_var)&,int)
Get all the affected objects.
o GetAllAttachements(CATLISTV(CATIVpmAFLAttachement_var)&)
Get all the attachements to the action.
o GetAllCOs(CATLISTV(CATIConfigurableObject_var)&,CATLISTV(CATUnicodeString)&)
Get all configurable objects related to the action.
o GetAllDatas(CATLISTV(CATIVpmAFLData_var)&)
Get all data associated with the action.
o GetAllHistories(CATLISTV(CATIVpmAFLHistory_var)&)
Get all history objects attached to the action.
o GetAllLinks(CATLISTV(CATIVpmAFLLink_var)&)
Get all the links of whatever type which go out from the current action.
o GetAllObjOfType(CATUnicodeString&,CATLISTV(CATIVpmAFLAffectedObject_var)&,int)
Get all the affected objects of a specific type.
o GetAllProductViews(CATLISTV(CATIVpmAFLProductView_var)&)
Get all product views related to the action.
o GetAllProducts(CATLISTV(CATIVpmAFLProduct_var)&)
Get all the products associated with the action.
o GetAllResponsabilities(CATLISTV(CATIVpmAFLResp_var)&)
Get the all responsabilities that are associated with the action.
o GetCreationDate(CATTime&)
Get the creation date of the action.
o GetCreator(CATUnicodeString&)
Get the creator's name of the action.
o GetDelinquency(long&)
Get the delinquency interval of the action.
o GetDelinquencyDays(long&)
Get the number of days to be in delinquency with the action dates.
o GetDescription(CATUnicodeString&)
Get the description of the action.
o GetDuration(long&)
Get the duration for performing the action.
o GetDurationUnit(CATUnicodeString&)
Get the duration unit.
o GetElapsedTime(long&)
Get the elapsed time for the action.
o GetElapsedTimeUnit(CATUnicodeString&)
Get the elapsed-time unit.
o GetEndDate(CATTime&)
Get the end date of the action.
o GetLastModifDate(CATTime&)
Get the last modification date for the action.
o GetLastModifUser(CATUnicodeString&)
Get the name of the user who made the last modification.
o GetLinksOfType(CATUnicodeString&,CATLISTV(CATIVpmAFLLink_var)&)
Get all the links of a given type which go out from the current action.
o GetLinksWithAction(CATIVpmAFLAction_var&,CATLISTV(CATIVpmAFLLink_var)&)
Get all the links (of whatever type) which relate the current action to another one.
o GetMyPointedActions(CATListValCATIVpmAFLAction_var&)
Get all the actions I am pointing (as the leader for oriented links, or slave for symetric links).
o GetMyPointedActions(CATUnicodeString,CATListValCATIVpmAFLAction_var&)
Get all the action I'm pointing with a special type of link (as the leader for oriented links, or slave for symetric links).
o GetName(CATUnicodeString&)
Get the action name.
o GetOtherActionAttr(CATIVpmAFLAction_var&)
Copy all attributes of another action to the current action.
o GetOwner(CATBaseUnknown_var&)
Get the owner of the action.
o GetPriority(CATUnicodeString&)
Get the priority of the action.
o GetProgress(CATUnicodeString&)
Get the action progress.
o GetRelatedProductView(CATIConfigurableObject_var&,CATIVpmAFLProductView_var&)
Get the Product-View related to an action giving the attached Configurable-Objet.
o GetStartDate(CATTime&)
Get the start date of the action.
o GetStatus(CATUnicodeString&)
Get the action status.
o GetSubscriberList(CATLISTV(CATIVpmAFLSubscribePV_var)&)
Get all subscribers to the current action.
o GetType(CATUnicodeString&)
Get the name of the action type.
o GetUUID(SEQUENCE(octet)&)
Get a binary unique identifier.
o IsAProductMngtType()
Check whether the action deals with product management.
o IsClose()
Recover the closure state of the current action.
o IsJustCreated()
Check whether this action is just created (no modification is made).
o IsLocked(boolean&)
Check whether the action is locked or not.
o RemoveAttachement(CATIVpmAFLAttachement_var&)
Remove the attachement from the action.
o RemoveData(CATIVpmAFLData_var&)
Remove a data from the action.
o RemoveObject(CATIVpmAFLAffectedObject_var&)
Remove the object from the action.
o RemoveProductView(CATIConfigurableObject_var&,int)
Remove a product view giving its related CO.
o RemoveProductView(CATIVpmAFLProductView_var&,int)
Remove a product view.
o RemoveResponsability(CATIVpmAFLResp_var&)
Remove a responsability which is already assigned to the action.
o RemoveSubscriber(CATIVpmAFLSubscribePV_var&)
Remove a subscriber to the current action.
o SetAbstract(CATUnicodeString&)
Set the abstract of the action.
o SetActualEndDate(CATTime&)
Set the actual end date of the action.
o SetActualStartDate(CATTime&)
Set the actual start date of the action.
o SetDelinquency(long)
Set the delinquency interval of the action.
o SetDelinquencyDays(long&)
Set the number of days to be in delinquency with the action dates.
o SetDescription(CATUnicodeString&)
Set the description of the action.
o SetDuration(long&)
Set the duration for performing the action.
o SetDurationUnit(CATUnicodeString&)
Set the duration unit.
o SetElapsedTime(long&)
Set the elapsed time for the action.
o SetElapsedTimeUnit(CATUnicodeString&)
Set the elapsed-time unit.
o SetEndDate(CATTime&)
Set the end date of the action.
o SetLock(boolean&)
Lock or unlock the action depending on the parameter passed (TRUE or FALSE).
o SetName(CATUnicodeString&)
Set the action name as a unique index in the database.
o SetPriority(CATUnicodeString&)
Set the priority of the action.
o SetProgress(CATUnicodeString&)
Set action progress.
o SetStartDate(CATTime&)
Set the start date of the action.

Enumerated Type Index


o Operation

Methods


o AddAttachement
public virtual HRESULT AddAttachement( const CATUnicodeString& iName,
const SEQUENCE(octet)& iId,
const CATUnicodeString& iType,
const CATUnicodeString& iDesc,
CATIVpmAFLAttachement_var& oAttach) = 0
Create an attachement and add it to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iName
iId
iDesc
oAttach
o AddData
public virtual HRESULT AddData(CATIVpmAFLData_var& oData) = 0
Create a data and add it to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oData
o AddHistory
public virtual HRESULT AddHistory(CATIVpmAFLHistory_var& oHistory) = 0
Create and add a history to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oHistory
o AddModifHistory
public virtual HRESULT AddModifHistory( const CATUnicodeString& iOperType,
CATIVpmAFLProductView_var& iModifPV,
const CATIVpmAFLAffectedObject_var& iObj1,
const CATIVpmAFLAffectedObject_var& iObj2) = 0
Add a modification history to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iOperType
iModifPV
iObj1
iObj2
o AddObject
public virtual HRESULT AddObject( const CATIVpmAFLAffectedObject_var& iObj) = 0
Add an affected object to the action. Object must be created by the AFLManager with all its associated attributes being valuated. The definition of the graph rules may copy it in another action. Associated Business Rule graph is "add_object".
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iObj
o AddObject2
public virtual HRESULT AddObject2( const CATIVpmAFLAffectedObject_var& iObj) = 0
Available only from R17 onwards Add an affected object to the action. Object must be created by the AFLManager with all its associated attributes being valuated. The definition of the graph rules may copy it in another action. Associated Business Rule graph is "add_object".
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iObj
o AddPV
public virtual HRESULT AddPV( const CATIConfigurableObject_var& iCfgObject,
CATIVpmAFLProductView_var& oProdView) = 0
Create and add a product-view to the action by giving a CO. A group-mode is automatically created and attached to the PV.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iCfgObject
oProdView
o AddPV
public virtual HRESULT AddPV( const CATIConfigurableObject_var& iCfgObject,
CATIVpmAFLProductView_var& oProdView,
CATICfgGroupModif_var& ioGroupModif) = 0
Create and add a product-view to the action by giving a CO. A group-mod may also be passed to be attached to the PV. If not, a new one is automatically created and attached to the PV.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iCfgObject
oProdView
ioGroupModif
o AddResponsability
public virtual HRESULT AddResponsability(CATIVpmAFLResp_var& iResp) = 0
Add a new responsability (user/role) to the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iResp
o AddSimpleHistory
public virtual HRESULT AddSimpleHistory( const CATUnicodeString& iOperType,
CATIVpmAFLHistory_var& oHistory) = 0
Add an instrumented history: operation type, valuate date, user...
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iOperType
oHistory
o AddSubscriber
public virtual HRESULT AddSubscriber(CATIVpmAFLSubscribePV_var& iSubscriber) = 0
Add a subscriber to the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iSubscriber
o DistributeObjects
public virtual HRESULT DistributeObjects(CATIVpmAFLAction_var& ioDestAction,
CATLISTV(CATIVpmAFLAffectedObject_var)& iObj) = 0
Distribute objects to another action. This method is used for "manual" distribution of affected objects. It uses the same rules as described in the distribution commands in the rules graph.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
ioDestAction
iObj
o Dump
public virtual HRESULT Dump(char* prefix) = 0
Print out all action attributes and related objects. Also a prefix may be specified.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
prefix
o FindAffObject
public virtual HRESULT FindAffObject(SEQUENCE(octet)& iUUID,
CATIVpmAFLAffectedObject_var& oObj) = 0
Find an affected object giving its UUID.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iUUID
oObj
o FindAffObject
public virtual HRESULT FindAffObject( const SEQUENCE(octet)& iUUID,
const CATUnicodeString& iChangeType,
CATIVpmAFLAffectedObject_var& oObj) = 0
Find an affected object giving its UUID and change type.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iUUID
iChangeType
oObj
o FindAffObject
public virtual HRESULT FindAffObject( const SEQUENCE(octet)& iUUID,
const CATUnicodeString& iChangeType,
CATIVpmAFLAffectedObject_var& oObj,
const CATUnicodeString& iVSource) = 0
Available only from R17 onwards Find an affected object giving its UUID and change type and V_Source.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iUUID
iChangeType
oObj
iVSource
o GetAbstract
public virtual HRESULT GetAbstract(CATUnicodeString& oAbstract) = 0
Get the abstract of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oAbstract
o GetActionsPointingMe
public virtual HRESULT GetActionsPointingMe(CATListValCATIVpmAFLAction_var& oListActions) = 0
Get all the action pointing on me (as the leader for oriented links, or slave for symetric links).
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListActions
o GetActionsPointingMe
public virtual HRESULT GetActionsPointingMe( const CATUnicodeString iLinkType,
CATListValCATIVpmAFLAction_var& oListActions) = 0
Get all the action pointing on me with a special type of link (as the leader for oriented links,or slave for symetric links).
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iLinkType
oListActions
o GetActualEndDate
public virtual HRESULT GetActualEndDate(CATTime& oDate) = 0
Get the actual end date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDate
o GetActualStartDate
public virtual HRESULT GetActualStartDate(CATTime& oDate) = 0
Get the actual start date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDate
o GetAllAffObj
public virtual HRESULT GetAllAffObj(CATLISTV(CATIVpmAFLAffectedObject_var)& oListObjs,
const int iWithRealObj=1) = 0
Get all the affected objects. The second parameter specifies whether these affected objects must point to real objects or not. By default only affected objects with real objects are returned.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListObjs
iWithRealObj
o GetAllAttachements
public virtual HRESULT GetAllAttachements(CATLISTV(CATIVpmAFLAttachement_var)& oListAttach) = 0
Get all the attachements to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListAttach
o GetAllCOs
public virtual HRESULT GetAllCOs(CATLISTV(CATIConfigurableObject_var)& oListCO,
CATLISTV(CATUnicodeString)& oListProdNames) = 0
Get all configurable objects related to the action. The names of related products are also returned.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListCO
oListProdNames
o GetAllDatas
public virtual HRESULT GetAllDatas(CATLISTV(CATIVpmAFLData_var)& oListData) = 0
Get all data associated with the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListData
o GetAllHistories
public virtual HRESULT GetAllHistories(CATLISTV(CATIVpmAFLHistory_var)& oListHistory) = 0
Get all history objects attached to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListHistory
o GetAllLinks
public virtual HRESULT GetAllLinks(CATLISTV(CATIVpmAFLLink_var)& oActionLinks) = 0
Get all the links of whatever type which go out from the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oActionLinks
o GetAllObjOfType
public virtual HRESULT GetAllObjOfType( const CATUnicodeString& iObjType,
CATLISTV(CATIVpmAFLAffectedObject_var)& oListObjs,
const int iWithRealObj=1) = 0
Get all the affected objects of a specific type. The second parameter specifies whether these affected objects must point to real objects or not. By default only affected objects with real objects are returned.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iObjType
oListObjs
iWithRealObj
o GetAllProductViews
public virtual HRESULT GetAllProductViews(CATLISTV(CATIVpmAFLProductView_var)& oListPV) = 0
Get all product views related to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListPV
o GetAllProducts
public virtual HRESULT GetAllProducts(CATLISTV(CATIVpmAFLProduct_var)& oListProduct) = 0
Get all the products associated with the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListProduct
o GetAllResponsabilities
public virtual HRESULT GetAllResponsabilities(CATLISTV(CATIVpmAFLResp_var)& oListResp) = 0
Get the all responsabilities that are associated with the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListResp
o GetCreationDate
public virtual HRESULT GetCreationDate(CATTime& oTime) = 0
Get the creation date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oTime
o GetCreator
public virtual HRESULT GetCreator(CATUnicodeString& oCreator) = 0
Get the creator's name of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oCreator
o GetDelinquency
public virtual HRESULT GetDelinquency(long& oDelinq) = 0
Get the delinquency interval of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDelinq
o GetDelinquencyDays
public virtual HRESULT GetDelinquencyDays(long& oDaysToGo) = 0
Get the number of days to be in delinquency with the action dates.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDaysToGo
o GetDescription
public virtual HRESULT GetDescription(CATUnicodeString& oDesc) = 0
Get the description of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDesc
o GetDuration
public virtual HRESULT GetDuration(long& oDuration) = 0
Get the duration for performing the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDuration
o GetDurationUnit
public virtual HRESULT GetDurationUnit(CATUnicodeString& oDurationUnit) = 0
Get the duration unit.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDurationUnit
o GetElapsedTime
public virtual HRESULT GetElapsedTime(long& oElapsTime) = 0
Get the elapsed time for the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oElapsTime
o GetElapsedTimeUnit
public virtual HRESULT GetElapsedTimeUnit(CATUnicodeString& oElapsTimeUnit) = 0
Get the elapsed-time unit.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oElapsTimeUnit
o GetEndDate
public virtual HRESULT GetEndDate(CATTime& oDate) = 0
Get the end date of the action. If not null, it must be considered as a fix point.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDate
o GetLastModifDate
public virtual HRESULT GetLastModifDate(CATTime& oTime) = 0
Get the last modification date for the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oTime
o GetLastModifUser
public virtual HRESULT GetLastModifUser(CATUnicodeString& oUserName) = 0
Get the name of the user who made the last modification.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oUserName
o GetLinksOfType
public virtual HRESULT GetLinksOfType( const CATUnicodeString& iLinkType,
CATLISTV(CATIVpmAFLLink_var)& oActionLinks) = 0
Get all the links of a given type which go out from the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iLinkType
oActionLinks
o GetLinksWithAction
public virtual HRESULT GetLinksWithAction( const CATIVpmAFLAction_var& iToAction,
CATLISTV(CATIVpmAFLLink_var)& oActionLinks) = 0
Get all the links (of whatever type) which relate the current action to another one.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iToAction
oActionLinks
o GetMyPointedActions
public virtual HRESULT GetMyPointedActions(CATListValCATIVpmAFLAction_var& oListActions) = 0
Get all the actions I am pointing (as the leader for oriented links, or slave for symetric links).
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListActions
o GetMyPointedActions
public virtual HRESULT GetMyPointedActions( const CATUnicodeString iLinkType,
CATListValCATIVpmAFLAction_var& oListActions) = 0
Get all the action I'm pointing with a special type of link (as the leader for oriented links, or slave for symetric links).
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iLinkType
oListActions
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) = 0
Get the action name.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oName
The name of the action.
o GetOtherActionAttr
public virtual HRESULT GetOtherActionAttr( const CATIVpmAFLAction_var& iFromAction) = 0
Copy all attributes of another action to the current action. Notice that referenced objects are not copied.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iFromAction
o GetOwner
public virtual HRESULT GetOwner(CATBaseUnknown_var& oPerson) = 0
Get the owner of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oPerson
o GetPriority
public virtual HRESULT GetPriority(CATUnicodeString& oPrior) = 0
Get the priority of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oPrior
o GetProgress
public virtual HRESULT GetProgress(CATUnicodeString& oProgress) = 0
Get the action progress.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oProgress
o GetRelatedProductView
public virtual HRESULT GetRelatedProductView(CATIConfigurableObject_var& iConfObj,
CATIVpmAFLProductView_var& oProdView) = 0
Get the Product-View related to an action giving the attached Configurable-Objet.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iConfObj
oProdView
o GetStartDate
public virtual HRESULT GetStartDate(CATTime& oDate) = 0
Get the start date of the action. If not null, it must be considered as a fix point.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oDate
o GetStatus
public virtual HRESULT GetStatus(CATUnicodeString& oStatus) = 0
Get the action status.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oStatus
o GetSubscriberList
public virtual HRESULT GetSubscriberList(CATLISTV(CATIVpmAFLSubscribePV_var)& oListSubscriber) = 0
Get all subscribers to the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oListSubscriber
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType) = 0
Get the name of the action type.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oType
o GetUUID
public virtual HRESULT GetUUID(SEQUENCE(octet)& oSequ) = 0
Get a binary unique identifier.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oSequ
o IsAProductMngtType
public virtual HRESULT IsAProductMngtType()= 0
Check whether the action deals with product management.
Legal values: S_OK In the positive case. S_FALSE The action does not deal with product management. E_FAIL The operation fails.
o IsClose
public virtual HRESULT IsClose()= 0
Recover the closure state of the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
o IsJustCreated
public virtual HRESULT IsJustCreated()= 0
Check whether this action is just created (no modification is made).
Legal values: S_OK The action is just created. S_FALSE The action is not just created. E_FAIL The operation fails.
o IsLocked
public virtual HRESULT IsLocked(boolean& oLocked) = 0
Check whether the action is locked or not.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
oLocked
o RemoveAttachement
public virtual HRESULT RemoveAttachement(CATIVpmAFLAttachement_var& iAttach) = 0
Remove the attachement from the action..
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iAttach
o RemoveData
public virtual HRESULT RemoveData(CATIVpmAFLData_var& iData) = 0
Remove a data from the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iData
o RemoveObject
public virtual HRESULT RemoveObject(CATIVpmAFLAffectedObject_var& iObj) = 0
Remove the object from the action. Associated Business Rule graph is "remove_object".
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iObj
o RemoveProductView
public virtual HRESULT RemoveProductView(CATIConfigurableObject_var& iConfObj,
const int iForce=0) = 0
Remove a product view giving its related CO. The second arguments allows to force or not (default) the suppression in case the PV has modifications.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iConfObj
iForce
o RemoveProductView
public virtual HRESULT RemoveProductView(CATIVpmAFLProductView_var& iProdView,
const int iForce=0) = 0
Remove a product view. The second arguments allows to force or not (default) the suppression in case the PV has modifications.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iProdView
iForce
o RemoveResponsability
public virtual HRESULT RemoveResponsability( const CATIVpmAFLResp_var& iResp) = 0
Remove a responsability which is already assigned to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iResp
o RemoveSubscriber
public virtual HRESULT RemoveSubscriber(CATIVpmAFLSubscribePV_var& iSubscriber) = 0
Remove a subscriber to the current action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iSubscriber
o SetAbstract
public virtual HRESULT SetAbstract( const CATUnicodeString& iAbstract) = 0
Set the abstract of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iAbstract
o SetActualEndDate
public virtual HRESULT SetActualEndDate( const CATTime& iDate) = 0
Set the actual end date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDate
o SetActualStartDate
public virtual HRESULT SetActualStartDate( const CATTime& iDate) = 0
Set the actual start date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDate
o SetDelinquency
public virtual HRESULT SetDelinquency( const long iDelinq) = 0
Set the delinquency interval of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDelinq
o SetDelinquencyDays
public virtual HRESULT SetDelinquencyDays( const long& iDaysToGo) = 0
Set the number of days to be in delinquency with the action dates.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDaysToGo
o SetDescription
public virtual HRESULT SetDescription( const CATUnicodeString& iDesc) = 0
Set the description of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDesc
o SetDuration
public virtual HRESULT SetDuration( const long& iDuration) = 0
Set the duration for performing the action. Real dates are calculated in connection to Start/End dates and duration.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDuration
o SetDurationUnit
public virtual HRESULT SetDurationUnit( const CATUnicodeString& iDurationUnit) = 0
Set the duration unit.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDurationUnit
o SetElapsedTime
public virtual HRESULT SetElapsedTime( const long& iElapsTime) = 0
Set the elapsed time for the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iElapsTime
o SetElapsedTimeUnit
public virtual HRESULT SetElapsedTimeUnit( const CATUnicodeString& iElapsTimeUnit) = 0
Set the elapsed-time unit.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iElapsTimeUnit
o SetEndDate
public virtual HRESULT SetEndDate( const CATTime& iDate) = 0
Set the end date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDate
o SetLock
public virtual HRESULT SetLock( const boolean& iLock) = 0
Lock or unlock the action depending on the parameter passed (TRUE or FALSE).
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iLock
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName) = 0
Set the action name as a unique index in the database. Notice that if this function is not called, a name is automatically set to the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iName
The name to be assigned to the action.
o SetPriority
public virtual HRESULT SetPriority( const CATUnicodeString& iPrior) = 0
Set the priority of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iPrior
o SetProgress
public virtual HRESULT SetProgress( const CATUnicodeString& iProgress) = 0
Set action progress.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iProgress
o SetStartDate
public virtual HRESULT SetStartDate( const CATTime& iDate) = 0
Set the start date of the action.
Legal values: S_OK The operations succeeds. E_FAIL The operation fails.
Parameters:
iDate

Enumerated Types


o Operation
enum Operation {
  Add,
  Cut,
  Replace,
  Move
}

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

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