All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmAFLManager

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

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


interface CATIVpmAFLManager

Class interface to the Action Flow Manager.
Role: Defines the interfaces to methods to manage Actions and Action related operations.


Method Index


o Cancel(CATIVpmAFLAction_var&,CATIVpmAFLAction_var&,CATIVpmAFLLink_var&)
Cancels an Action.
o CheckCondition(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,CATIVpmFactoryObject_var&)
Check whether a lifecycle condition is satisfied or not.
o CheckValue(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Compare two values using an operator.
o CopyObject(CATIVpmAFLAffectedObject_var&,CATIVpmAFLAction_var&,CATUnicodeString&)
Copies an object from one Action to another.
o CopyObjects(CATLISTV(CATIVpmAFLAffectedObject_var)&,CATIVpmAFLAction_var&,CATUnicodeString&)
Copies objects from one Action to another.
o CopyReferContext(CATIVpmAFLAction_var&,CATIVpmAFLAction_var&)
Copies ProductViews from one Action to another.
o CreateAffectedObject(CATUnicodeString&,CATILinkableObject_var&,CATIVpmAFLAffectedObject_var&,CATUnicodeString&)
Creates an Affected Object.
o CreateAffectedObject(CATUnicodeString&,CATIVpmAFLAffectedObject_var&,CATUnicodeString&)
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVIObjectInfo interface.
o CreateAflBinPredicate(CATUnicodeString&,CATVpmOperator,SEQUENCE(octet)&,int,CATIVpmPredicate_var&,CATUnicodeString&)
Creates a query predicate.
o CreateAflPredicate(CATUnicodeString&,CATVpmOperator,CATUnicodeString&,int,CATIVpmPredicate_var&,CATUnicodeString&)
Creates a query predicate.
o CreateFilter(CATUnicodeString&,CATIConfigurableObject_var&,CATLISTV(CATIVpmAFLAction_var)&,CATICfgFilter_var&)
Creates a Configuration Filter.
o CreateLink(CATIVpmAFLAction_var&,CATIVpmAFLAction_var&,CATIVpmAFLLink_var&,CATUnicodeString&)
Creates a Link between Actions.
o CreateResponsability(CATIVpmAFLResp_var&)
Creates a Responsability Object.
o DeleteAction(CATIVpmAFLAction_var&)
Removes an Action from memory.
o DestroyAction(CATIVpmAFLAction_var&)
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVILifeCycleObject->Remove() on the Action
o DistributeObjects(CATIVpmAFLAction_var&,CATIVpmAFLAction_var&,CATLISTV(CATIVpmAFLAffectedObject_var)&)
Distributes objects from one Action to another.
o ForceDestroyAction(CATIVpmAFLAction_var&)
Deletes an Action.
o GetActionFromAFLSimplePool(CATIVpmAFLAction_var&)
Retrieve an Action from the Simple variable pool.
o GetActionFromMod(CATListOfCATICfgModification_var&,CATLISTV(CATIVpmAFLAction_var)&)
Retrieves the actions using a list of mods.
o GetActions(CATTime&,CATTime&,CATActionDate,CATUnicodeString&,CATLISTV(CATIVpmAFLAction_var)&)
Retrieves a list Actions.
o GetDatabaseDate(CATTime&,int)
Retrieves the current time from the database.
o GetDelinquencyActions(CATTime&,CATTime&,CATUnicodeString&,CATLISTV(CATIVpmAFLAction_var)&)
Retrieves a list of delinquent Actions.
o GetFromURL(SEQUENCE(octet)&,CATIVpmAFLAction_var&)
Retrieves an Action by URL.
o GetGraphManager(CATUnicodeString&,CATIVpmGraphMng_var&)
Retrieves the Graph manager
o GetLastCmdResult()
Retrieves the last command result.
o GetMessageFromTag(CATUnicodeString&,CATUnicodeString&)
Retrieves a Message from a Tag.
o GetObjectFromAFLPool(CATUnicodeString&,CATIVpmFactoryObject_var&)
Retrieve an object from the AFL pool.
o GetObjectsFromAFLPool(CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
Retrieve a list of objects from the AFL pool.
o GetObjectsFromPath(CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
Retrieves a list of Objects from a Path.
o GetPersonsFromAFLPool(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Retrieves a list of person from the AFL pool.
o GetVpmObjectAttributeNames(CATUnicodeString&,CATListOfVPMCA&)
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVIObjectInfo interface.
o PutActionInAFLPool(CATIVpmAFLAction_var&)
Put an Action in the AFL pool.
o PutObjectInAFLPool(CATUnicodeString&,CATIVpmFactoryObject_var&)
Put an object in the AFL pool.
o PutObjectsInAFLPool(CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
Put a list of objects in the AFL pool.
o PutPersonsInAFLPool(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Push a list of persons in the AFL pool.
o QueryAFLActionsByXeff(CATListValCATIVpmAFLAction_var&,CATUnicodeString&,CATUnicodeString&,CATListValCATICfgNormalValue_var&,CATIVpmPredicate_var&)
Queries for Actions by Xeffs.
o QueryAFLHistoryByCV(CATIConfigurableObject_var&,CATIVpmPredicate_var&,long,CATListValCATIVpmAFLHistory_var&,CATUnicodeString&)
Queries on Histories using Operation flags and predicate
o QueryAFLHistoryByCV(CATIConfigurableObject_var&,CATListValCATIVpmAFLHistory_var&,CATUnicodeString&)
Queries on Histories to retrieve a ProductView life cycle
o QueryAFLHistoryByObject(SEQUENCE(octet)&,CATLISTV(CATIVpmAFLHistory_var)&)
Queries for Histories by Object.
o QueryAFLObjectAffected(SEQUENCE(octet)&,CATListValCATIVpmAFLAction_var&,CATIVpmAFLManager::Operation,CATIVpmPredicate_var&,CATIConfigurableObject_var&,CATListValCATICfgNormalValue_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Queries Actions using an Affected Object and (optional) Configuration.
o QueryAfl(CATIVpmPredicate_var&,CATLISTV(CATIVpmAFLAction_var)&,CATUnicodeString&,CATUnicodeString&)
Queries Actions using a predicate.
o QueryAflProductView(CATIVpmPredicate_var&,CATIConfigurableObject_var&,CATListValCATIVpmAFLAction_var&,CATUnicodeString&,CATUnicodeString&)
Queries Actions using a predicate and a Configurable Object.
o QueryAflProductView(CATIVpmPredicate_var&,CATIConfigurableObject_var&,CATListValCATIVpmAFLProductView_var&,CATUnicodeString&)
Queries ProductViews using a predicate and a Configurable Object.
o QueryAflProductView(CATIVpmPredicate_var&,CATListValCATIConfigurableObject_var&,CATListValCATIVpmAFLAction_var&,CATUnicodeString&,CATUnicodeString&)
Queries Actions using a predicate and a list of Configurable Objects.
o QueryAfl_Name(CATUnicodeString&,CATIVpmAFLAction_var&)
Queries an Action by name.
o RemoveLink(CATIVpmAFLLink_var&)
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVILifeCycleObject->Remove() on the link
o SetCaseSensitive()
Sets the Query policy to case sensitive.
o SetCaseUnsensitive()
Sets the Query policy to ignore case.
o SetLastCmdResult(HRESULT)
Assigns the last command result.
o StepForwardActionStatus(CATIVpmAFLAction_var&,CATUnicodeString&)
Advances the Action's status.
o StepForwardObjectStatus(CATIVpmAFLAffectedObject_var&,CATUnicodeString&)
Advances the Affected Object's status.
o StepForwardRespStatus(CATIVpmAFLResp_var&,CATUnicodeString&)
Advances the Responsability Object's status.
o Superseed(CATIVpmAFLAction_var&,CATIVpmAFLAction_var&,CATIVpmAFLLink_var&)
Supersedes an Action.
o TransferObject(CATIVpmAFLAffectedObject_var&,CATIVpmAFLAction_var&,CATUnicodeString&)
Moves an object from one Action to another.
o TransferObjects(CATLISTV(CATIVpmAFLAffectedObject_var)&,CATIVpmAFLAction_var&,CATUnicodeString&)
Moves objects from one Action to another.

Enumerated Type Index


o CATActionDate
enum CATActionDate describes Action date values.
o Generate
enum obsolete : to be removed in V5R5.
o Operation
enum Operation describes operation values used in Affected Object queries.
o Operation_Flag
enum Operation_Flag describes Operation flag values.

Methods


o Cancel
public virtual HRESULT Cancel(CATIVpmAFLAction_var& iCanceled,
CATIVpmAFLAction_var& iCanceling,
CATIVpmAFLLink_var& oCancelingLink)=0
Cancels an Action.
Parameters:
iCanceled
The Action to be canceled.
iCanceling
The canceling Action.
oCancelingLink
The canceling Link.
o CheckCondition
public virtual HRESULT CheckCondition( const CATUnicodeString& iConditionName,
const CATLISTV(CATBaseUnknown_var)& iGraphPredicatList,
CATIVpmFactoryObject_var& oFailingObj)=0
Check whether a lifecycle condition is satisfied or not.
Parameters:
iConditionName
The condition name declared in the lifecycle definition.
iGraphPredicatList
The list of predicates associated with the condition.
oFailingObj
If the condition is not satisfied, the object that most likely caused the failure is returned.
o CheckValue
public virtual HRESULT CheckValue(CATUnicodeString& iValue1,
const CATUnicodeString& iOp,
CATUnicodeString& iValue2)=0
Compare two values using an operator..
Parameters:
iValue1
The value to check.
iOp
The operator to be used for comparison.
Legal values: == | != | >= | <= | > | < | ISNULL | ISNOTNULL | INSIDE | NOTINS | IN_ENUM | NOT_IN_ENUM
iValue2
The value to compare to the first value.
o CopyObject
public virtual HRESULT CopyObject(CATIVpmAFLAffectedObject_var& iObjOrig,
CATIVpmAFLAction_var& iActionDest,
CATUnicodeString& iDestTypeObject)=0
Copies an object from one Action to another.
Parameters:
iObjOrig
The source object.
iActionDest
The target Action.
iDestTypeObject
The object type.
o CopyObjects
public virtual HRESULT CopyObjects(CATLISTV(CATIVpmAFLAffectedObject_var)& iListObjects,
CATIVpmAFLAction_var& iActionDest,
CATUnicodeString& iDestTypeObjects)=0
Copies objects from one Action to another.
Parameters:
iListObjects
The source objects.
iActionDest
The target Action.
iDestTypeObjects
The type of objects.
o CopyReferContext
public virtual HRESULT CopyReferContext(CATIVpmAFLAction_var& iFromAction,
CATIVpmAFLAction_var& iToAction)=0
Copies ProductViews from one Action to another.
Parameters:
iFromAction
The source Action.
iToAction
The target Action.
o CreateAffectedObject
public virtual HRESULT CreateAffectedObject( const CATUnicodeString& iTypeAffObj,
const CATILinkableObject_var& iPointingObj,
CATIVpmAFLAffectedObject_var& oAffObj,
const CATUnicodeString& iGraphCusto="")=0
Creates an Affected Object.
Parameters:
iTypeAffObj
The type of Affected Object.
iPointingObj
The reference to the actual object.
oAffObj
The created Affected Object.
iGraphCusto
The associated custom Graph.
o CreateAffectedObject
public virtual HRESULT CreateAffectedObject( const CATUnicodeString& iTypeAffObj,
CATIVpmAFLAffectedObject_var& oAffObj,
const CATUnicodeString& iGraphCusto="")=0
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVIObjectInfo interface.
o CreateAflBinPredicate
public virtual HRESULT CreateAflBinPredicate( const CATUnicodeString& iAttrName,
CATVpmOperator iOperator,
const SEQUENCE(octet)& iValue,
int iIsNot,
CATIVpmPredicate_var& oPredicate,
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY)=0
Creates a query predicate.
Parameters:
iAttrName
The attribute name.
iOperator
The operator.
iValue
The binary attribute value.
iIsNot
The negation operator.
oPredicate
The predicate.
iEntityName
The entity name.
o CreateAflPredicate
public virtual HRESULT CreateAflPredicate( const CATUnicodeString& iAttrName,
CATVpmOperator iOperator,
const CATUnicodeString& iValue,
int iIsNot,
CATIVpmPredicate_var& oPredicate,
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY)=0
Creates a query predicate.
Parameters:
iAttrName
The attribute name.
iOperator
The operator.
iValue
The attribute value.
iIsNot
The negation operator.
oPredicate
The predicate.
iEntityName
The entity name.
o CreateFilter
public virtual HRESULT CreateFilter( const CATUnicodeString& iXeffDomain,
const CATIConfigurableObject_var& iCfgObj,
const CATLISTV(CATIVpmAFLAction_var)& iListActions,
CATICfgFilter_var& oFilter)=0
Creates a Configuration Filter.
Parameters:
iXeffDomain
The Xeff domain.
iCfgObj
The Configurable Object.
iListActions
The list of Actions.
oFilter
The Filter.
o CreateLink
public virtual HRESULT CreateLink(CATIVpmAFLAction_var& iAction1,
CATIVpmAFLAction_var& iAction2,
CATIVpmAFLLink_var& oActionLink,
const CATUnicodeString& iTypeLink)=0
Creates a Link between Actions.
Parameters:
iAction1
The first Action.
iAction2
The second Action.
oActionLink
The Link.
iTypeLink
The link type.
o CreateResponsability
public virtual HRESULT CreateResponsability(CATIVpmAFLResp_var& oResp)=0
Creates a Responsability Object.
Parameters:
oResp
The Responsability Object.
o DeleteAction
public virtual HRESULT DeleteAction(CATIVpmAFLAction_var& iAction)=0
Removes an Action from memory.
Parameters:
iAction
The Action.
o DestroyAction
public virtual HRESULT DestroyAction(CATIVpmAFLAction_var& iAction)=0
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVILifeCycleObject->Remove() on the Action
o DistributeObjects
public virtual HRESULT DistributeObjects(CATIVpmAFLAction_var& iActionOrig,
CATIVpmAFLAction_var& iActionDest,
CATLISTV(CATIVpmAFLAffectedObject_var)& iListObjects)=0
Distributes objects from one Action to another.
Parameters:
iActionOrig
The source Action.
iActionDest
The target Action.
iListObjects
The list of objects.
o ForceDestroyAction
public virtual HRESULT ForceDestroyAction( const CATIVpmAFLAction_var& iAction)=0
Deletes an Action.
Parameters:
iAction
The Action to delete.
o GetActionFromAFLSimplePool
public virtual HRESULT GetActionFromAFLSimplePool(CATIVpmAFLAction_var& oAction)=0
Retrieve an Action from the Simple variable pool.
Parameters:
oAction
The Action.
Returns:
A HRESULT value.
Legal values:
S_OK
Action is found for the entry
S_FALSE
Entry or action not found in the pool
E_FAIL
Other problem occured during the operation
o GetActionFromMod
public virtual HRESULT GetActionFromMod( const CATListOfCATICfgModification_var& iListMod,
CATLISTV(CATIVpmAFLAction_var)& oListAction) const = 0
Retrieves the actions using a list of mods.
Parameters:
iListMod
List of modification.
oLisAction
List of all the action using at least one the modification given as input.
o GetActions
public virtual HRESULT GetActions( const CATTime& iMinusDate,
const CATTime& iPlusDate,
const CATActionDate iSearchDate,
const CATUnicodeString& iEnumStatusName,
CATLISTV(CATIVpmAFLAction_var)& oActions)=0
Retrieves a list Actions.
Parameters:
iMinusDate
The start date.
iPlusDate
The end date.
iSearchDate
The search date.
iEnumStatusName
The status name.
oActions
The list of Actions.
o GetDatabaseDate
public virtual HRESULT GetDatabaseDate(CATTime& oTime,
const int i=0)=0
Retrieves the current time from the database.
Parameters:
oTime
The time.
i
0 to have an interval of at least between 2 calls, 1 to have the exact date
o GetDelinquencyActions
public virtual HRESULT GetDelinquencyActions( const CATTime& iDate,
const CATTime& iEndDate,
const CATUnicodeString& iEnumStatusName,
CATLISTV(CATIVpmAFLAction_var)& oActions)=0
Retrieves a list of delinquent Actions.
Parameters:
iDate
The start date.
iEndDate
The end date.
iEnumStatusName
The status name.
oActions
The list of Actions.
o GetFromURL
public virtual HRESULT GetFromURL( const SEQUENCE(octet)& iURL,
CATIVpmAFLAction_var& oAction)=0
Retrieves an Action by URL.
Parameters:
iURL
The Action URL.
oAction
The Action.
o GetGraphManager
public virtual HRESULT GetGraphManager( const CATUnicodeString& iGraphName,
CATIVpmGraphMng_var& oGraphMgr)=0
Retrieves the Graph manager
Parameters:
iGraphName
The Graph name.
oGraphMgr
The Graph manager.
o GetLastCmdResult
public virtual HRESULT GetLastCmdResult()=0
Retrieves the last command result.
o GetMessageFromTag
public virtual HRESULT GetMessageFromTag( const CATUnicodeString& iTAG,
CATUnicodeString& oExpression)=0
Retrieves a Message from a Tag.
Parameters:
iTAG
The Tag.
oExpression
The Message.
o GetObjectFromAFLPool
public virtual HRESULT GetObjectFromAFLPool( const CATUnicodeString& iEntryKey,
CATIVpmFactoryObject_var& oObject)=0
Retrieve an object from the AFL pool.
Parameters:
iEntryKey
The entry key to the pool.
oObject
The object.
Returns:
A HRESULT value.
Legal values:
S_OK
Object is found for the entry
S_FALSE
Entry or object not found in the pool
E_FAIL
Other problem occured during the operation
o GetObjectsFromAFLPool
public virtual HRESULT GetObjectsFromAFLPool( const CATUnicodeString& iEntryKey,
CATLISTV(CATIVpmFactoryObject_var)& oObjectList)=0
Retrieve a list of objects from the AFL pool.
Parameters:
iEntryKey
The entry key to the pool.
oObject
The object.
Returns:
A HRESULT value.
Legal values:
S_OK
Object is found for the entry
S_FALSE
Entry not found in the pool
E_FAIL
Other problem occured during the operation
o GetObjectsFromPath
public virtual HRESULT GetObjectsFromPath( const CATUnicodeString& iPathToObjs,
CATLISTV(CATIVpmFactoryObject_var)& oListObjects)=0
Retrieves a list of Objects from a Path.
Parameters:
iPathToObjs
The Path.
oListObjects
The list of Objects.
o GetPersonsFromAFLPool
public virtual HRESULT GetPersonsFromAFLPool( const CATUnicodeString& iPoolName,
CATLISTV(CATBaseUnknown_var)& oListObj)=0
Retrieves a list of person from the AFL pool.
Parameters:
iPoolName
The pool entry name.
iListObj
The list of persons retrieved from the pool.
o GetVpmObjectAttributeNames
public virtual HRESULT GetVpmObjectAttributeNames( const CATUnicodeString& iEntityName,
CATListOfVPMCA& oVPMCAList)=0
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVIObjectInfo interface.
o PutActionInAFLPool
public virtual HRESULT PutActionInAFLPool( const CATIVpmAFLAction_var& iAction)=0
Put an Action in the AFL pool.
Parameters:
oAction
The Action.
Returns:
A HRESULT value.
Legal values:
S_OK
Operation succeeded
E_INVALIDARG
The action passed is not valid
E_FAIL
Other problem occured during the operation
o PutObjectInAFLPool
public virtual HRESULT PutObjectInAFLPool( const CATUnicodeString& iEntryKey,
const CATIVpmFactoryObject_var& iObject)=0
Put an object in the AFL pool.
Parameters:
iEntryKey
The entry key to the pool.
iObject
The object to put in the pool.
Returns:
A HRESULT value.
Legal values:
S_OK
Operation succeeded
E_INVALIDARG
The object passed is not valid
E_FAIL
Other problem occured during the operation
o PutObjectsInAFLPool
public virtual HRESULT PutObjectsInAFLPool( const CATUnicodeString& iEntryKey,
const CATLISTV(CATIVpmFactoryObject_var)& iObjectList)=0
Put a list of objects in the AFL pool.
Parameters:
iEntryKey
The entry key to the pool.
iObject
The object list to put in the pool.
Returns:
A HRESULT value.
Legal values:
S_OK
Operation succeeded
E_INVALIDARG
Object list is empty
E_FAIL
Other problem occured during the operation
o PutPersonsInAFLPool
public virtual HRESULT PutPersonsInAFLPool( const CATUnicodeString& iPoolName,
const CATLISTV(CATBaseUnknown_var)& iListObj)=0
Push a list of persons in the AFL pool.
Parameters:
iPoolName
The pool entry name.
iListObj
The list of persons to push in.
o QueryAFLActionsByXeff
public virtual HRESULT QueryAFLActionsByXeff(CATListValCATIVpmAFLAction_var& oActions,
const CATUnicodeString& iEntityName="",
const CATUnicodeString& iXDomain=NULL,
const CATListValCATICfgNormalValue_var& iORList=NULL,
const CATIVpmPredicate_var& iPred=NULL_var)=0
Queries for Actions by Xeffs.
Parameters:
oActions
The list of Actions
iEntityName
The entity name.
iXDomain
The domain name.
iORList
The list of Normal values.
iPred
The predicate.
o QueryAFLHistoryByCV
public virtual HRESULT QueryAFLHistoryByCV( const CATIConfigurableObject_var& iCfgObj,
const CATIVpmPredicate_var& iOtherPredicate,
long iOperations,
CATListValCATIVpmAFLHistory_var& oListHistories,
const CATUnicodeString& iAFLDomain="")=0
Queries on Histories using Operation flags and predicate
Parameters:
iCfgObj
The Configurable Object.
iOtherPredicate
The predicate.
iOperations
The Operation flags.
oListHistories
The list of Histories.
iAFLDomain
The domain name.
o QueryAFLHistoryByCV
public virtual HRESULT QueryAFLHistoryByCV( const CATIConfigurableObject_var& iCfgObj,
CATListValCATIVpmAFLHistory_var& oListHistories,
const CATUnicodeString& iAFLDomain="")=0
Queries on Histories to retrieve a ProductView life cycle
Parameters:
iCfgObj
The Configurable Object.
oListHistories
The list of Histories.
iAFLDomain
The domain name.
o QueryAFLHistoryByObject
public virtual HRESULT QueryAFLHistoryByObject( const SEQUENCE(octet)& iId,
CATLISTV(CATIVpmAFLHistory_var)& oListHist)=0
Queries for Histories by Object.
Parameters:
iId
The object identifier.
oListHist
The list of Histories.
o QueryAFLObjectAffected
public virtual HRESULT QueryAFLObjectAffected( const SEQUENCE(octet)& iAffObjId,
CATListValCATIVpmAFLAction_var& oListAction,
CATIVpmAFLManager::Operation iOper=CATIVpmAFLManager::NotDef,
const CATIVpmPredicate_var& iOtherPred=NULL_var,
const CATIConfigurableObject_var& iCfgObj=NULL_var,
const CATListValCATICfgNormalValue_var& iNVList=NULL,
const CATUnicodeString& iXeffDomain="",
const CATUnicodeString& iXeffStatus="",
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY,
const CATUnicodeString& iAFLDomain="")=0
Queries Actions using an Affected Object and (optional) Configuration.
Parameters:
iAffObjId
The Affected Object.
oListAction
The list of Actions.
iOper
The operation.
iOtherPred
The predicate.
iCfgObj
The Configurable Object.
iNVList
The Normal value.
iXeffDomain
The Xeff domain.
iXeffStatus
The Xeff status.
iEntityName
The entity name.
iAFLDomain
The domain name.
o QueryAfl
public virtual HRESULT QueryAfl( const CATIVpmPredicate_var& iPred,
CATLISTV(CATIVpmAFLAction_var)& oListAction,
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY,
const CATUnicodeString& iDomain="")=0
Queries Actions using a predicate.
Parameters:
iPred
The query predicate.
oListAction
The list of Actions.
iEntityName
The entity name.
iDomain
The domain name.
o QueryAflProductView
public virtual HRESULT QueryAflProductView( const CATIVpmPredicate_var& iOtherPred,
const CATIConfigurableObject_var& iCO,
CATListValCATIVpmAFLAction_var& oListAction,
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY,
const CATUnicodeString& iAFLDomain="")=0
Queries Actions using a predicate and a Configurable Object.
Parameters:
iOtherPred
The query predicate.
iCO
The configurable object.
oListAction
The list of Actions.
iEntityName
The entity name.
iAFLDomain
The domain name.
o QueryAflProductView
public virtual HRESULT QueryAflProductView( const CATIVpmPredicate_var& iOtherPred,
const CATIConfigurableObject_var& iCO,
CATListValCATIVpmAFLProductView_var& oListAPV,
const CATUnicodeString& iAFLDomain="")=0
Queries ProductViews using a predicate and a Configurable Object.
Parameters:
iOtherPred
The query predicate.
iCO
The configurable object.
oListAPV
The list of Product Views.
iAFLDomain
The domain name.
o QueryAflProductView
public virtual HRESULT QueryAflProductView( const CATIVpmPredicate_var& iOtherPred,
const CATListValCATIConfigurableObject_var& iCOs,
CATListValCATIVpmAFLAction_var& oListAction,
const CATUnicodeString& iEntityName=CATVPMAFL_ENTITY,
const CATUnicodeString& iAFLDomain="")=0
Queries Actions using a predicate and a list of Configurable Objects.
Parameters:
iOtherPred
The query predicate.
iCOs
The list of Configurable Objects.
oListAction
The list of Actions.
iEntityName
The entity name.
iAFLDomain
The domain name.
o QueryAfl_Name
public virtual HRESULT QueryAfl_Name( const CATUnicodeString& iId,
CATIVpmAFLAction_var& oAction)=0
Queries an Action by name.
Parameters:
iId
The Action name.
oAction
The Action object.
o RemoveLink
public virtual HRESULT RemoveLink(CATIVpmAFLLink_var& iLink)=0
obsolete in V5R5 ( ASSERT ) DO NOT USE Instead use ENOVILifeCycleObject->Remove() on the link
o SetCaseSensitive
public virtual void SetCaseSensitive()=0
Sets the Query policy to case sensitive.
o SetCaseUnsensitive
public virtual void SetCaseUnsensitive()=0
Sets the Query policy to ignore case.
o SetLastCmdResult
public virtual HRESULT SetLastCmdResult(HRESULT iResult)=0
Assigns the last command result.
Parameters:
iResult
The result.
o StepForwardActionStatus
public virtual HRESULT StepForwardActionStatus(CATIVpmAFLAction_var& iAction,
const CATUnicodeString& iEvent)=0
Advances the Action's status.
Parameters:
iAction
The Action.
iEvent
The event text.
o StepForwardObjectStatus
public virtual HRESULT StepForwardObjectStatus(CATIVpmAFLAffectedObject_var& iObject,
const CATUnicodeString& iEvent)=0
Advances the Affected Object's status.
Parameters:
iObject
The Affected Object.
iEvent
The event text.
o StepForwardRespStatus
public virtual HRESULT StepForwardRespStatus(CATIVpmAFLResp_var& iResp,
const CATUnicodeString& iEvent)=0
Advances the Responsability Object's status.
Parameters:
iResp
The Responsability object.
iEvent
The event text.
o Superseed
public virtual HRESULT Superseed(CATIVpmAFLAction_var& iSuperseded,
CATIVpmAFLAction_var& oSuperseding,
CATIVpmAFLLink_var& oSupersedingLink)=0
Supersedes an Action.
Parameters:
iSuperseded
The Action to be superseded.
oSuperseding
The superseding Action.
oSupersedingLink
The superseding Link.
o TransferObject
public virtual HRESULT TransferObject(CATIVpmAFLAffectedObject_var& iObjOrig,
CATIVpmAFLAction_var& iActionDest,
CATUnicodeString& iDestTypeObject)=0
Moves an object from one Action to another.
Parameters:
iObjOrig
The source object.
iActionDest
The target Action.
iDestTypeObject
The object type.
o TransferObjects
public virtual HRESULT TransferObjects(CATLISTV(CATIVpmAFLAffectedObject_var)& iListObjects,
CATIVpmAFLAction_var& iActionDest,
CATUnicodeString& iDestTypeObjects)=0
Moves objects from one Action to another.
Parameters:
iListObjects
The source objects.
iActionDest
The target Action.
iDestTypeObjects
The type of objects.

Enumerated Types


o CATActionDate
enum CATActionDate {
  STARTDATE,
  ENDDATE,
  ACTUALSTARTDATE,
  ACTUALENDDATE,
  DELINQUENCYDATE
}
enum CATActionDate describes Action date values.

STARTDATE :

ENDDATE :

ACTUALSTARTDATE :

ACTUALENDDATE :

DELINQUENCYDATE :

o Generate
enum Generate {
  NoId,
  GenId
}
enum obsolete : to be removed in V5R5. Replaced by real Action name.
o Operation
enum Operation {
  Add,
  Cut,
  Replaced,
  Replacing,
  Move,
  NotDef
}
enum Operation describes operation values used in Affected Object queries.

Add :

Cut :

Replaced :

Replacing :

Move :

NotDef :

o Operation_Flag
enum Operation_Flag {
  AFL_OP_ADD,
  AFL_OP_CUT,
  AFL_OP_REPLACE,
  AFL_OP_MOVE
}
enum Operation_Flag describes Operation flag values.

AFL_OP_ADD :

AFL_OP_CUT :

AFL_OP_REPLACE :

AFL_OP_MOVE :


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

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