All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface VPMIWflQuery
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMIWflQuery
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface VPMIWflQuery
Interface to query workflow processes.
Role : This interface provides methods to query workflow processes with different criteria.
Method Index
- o
GetActivity(CATUnicodeString&,VPMIWflActivity_var&)
- Get an activity instance giving its id.
- o
GetProcess(CATUnicodeString&,VPMIWflProcess_var&)
- Get a process instance given its id.
- o
GetProcessesWithName(CATUnicodeString&,CATLISTV(VPMIWflProcess_var)&)
- Get all process instances which have the same name.
- o
GetWflDefaultCalendar(VPMIWflCalendar_var&)
- Get the default calendar defined for the Workflow.
- o
QueryActivitiesInStatus(CATUnicodeString&,CATLISTV(VPMIWflActivity_var)&,CATLISTV(CATUnicodeString)&,CATIVpmPredicate_var)
- Specify a query to produce a list of all activity instances, which potentially
are in a given state, and matche a given predicate,
that are owned by a given user.
- o
QueryActivitiesPlannedIn(CATTime&,CATTime&,CATLISTV(VPMIWflActivity_var)&,CATUnicodeString&,CATIVpmPredicate_var&)
- Query for all activities which are planned within an interval of time.
- o
QueryActivitiesUsingObject(CATBaseUnknown_var&,CATLISTV(VPMIWflActivity_var)&,CATUnicodeString&,CATIVpmPredicate_var&)
- Query for all activities which use a specific object
as (1) input, (2) output, (3) input OR output.
- o
QueryActivitiesWithOrg(CATUnicodeString&,CATLISTV(VPMIWflRegularActivity_var)&,CATLISTV(CATUnicodeString)&,CATUnicodeString&)
- Query for all activities having ORGANIZATION ownership that matches a given user.
- o
QueryActivitiesWithOwner(CATUnicodeString&,CATLISTV(VPMIWflRegularActivity_var)&,CATLISTV(CATUnicodeString)&)
- Query for all activities which are currently owned by a given user.
- o
QueryActivitiesWithRole(CATUnicodeString&,CATLISTV(VPMIWflRegularActivity_var)&,CATLISTV(CATUnicodeString)&)
- Query for all activities having ROLE ownership that matches a given user.
- o
QueryActivitiesWithUser(CATUnicodeString&,CATLISTV(VPMIWflRegularActivity_var)&,CATLISTV(CATUnicodeString)&)
- Query for all activities having HUMAN ownership that matches a given user.
- o
QueryDelinquentActivities(long&,CATLISTV(VPMIWflActivity_var)&,CATLISTV(CATUnicodeString)&,CATIVpmPredicate_var&)
- Query for all delinquent activities from the current time.
- o
QueryProcessesInStatus(CATLISTV(VPMIWflProcess_var)&,CATLISTV(CATUnicodeString)&,CATIVpmPredicate_var&)
- Specify a query to produce a list of all process instances, which potentially
are in a given state, and matche a given predicate,
that are owned by a given user.
- o
QueryProcessesUsingObject(CATBaseUnknown_var&,CATLISTV(VPMIWflProcess_var)&,CATUnicodeString&,CATIVpmPredicate_var&)
- Query for all process instances which use a specific object as:
(1) a relevant data, (2) an input, (3) an output, (4) input OR output.
- o
QueryProcessesWithOrg(CATUnicodeString&,CATLISTV(VPMIWflProcess_var)&,CATLISTV(CATUnicodeString)&,CATUnicodeString&)
- Query for all processes having ORGANIZATION ownership that matches a given user.
- o
QueryProcessesWithOwner(CATUnicodeString&,CATLISTV(VPMIWflProcess_var)&,CATLISTV(CATUnicodeString)&)
- Query for all processes which are currently owned by a given user.
- o
QueryProcessesWithRole(CATUnicodeString&,CATLISTV(VPMIWflProcess_var)&,CATLISTV(CATUnicodeString)&)
- Query for all processes having ROLE ownership that matches a given user.
- o
QueryProcessesWithUser(CATUnicodeString&,CATLISTV(VPMIWflProcess_var)&,CATLISTV(CATUnicodeString)&)
- Query for all processes having HUMAN ownership that matches a given user.
Methods
o GetActivity
-
Get an activity instance giving its id.
Legal values:
S_OK If the operation succeeds and an activity instance is returned.
E_INVALIDARG Invalid process instance.
S_FALSE If no activity instance is found with the specified id.
E_FAIL The operation fails.
- Parameters:
-
- iActInstId
-
- oActInst
o GetProcess
-
Get a process instance given its id.
Legal values:
S_OK If the operation succeeds and a process instance is returned.
S_FALSE If no process instance is found with the specified id.
E_FAIL The operation fails.
- Parameters:
-
- iProcInstId
-
- oProcInst
o GetProcessesWithName
public virtual HRESULT GetProcessesWithName( | const CATUnicodeString& | iProcInstName, |
| CATLISTV(VPMIWflProcess_var)& | oProcList) = 0 |
-
Get all process instances which have the same name.
Legal values:
S_OK If the operation succeeds and at least one process instance is returned.
S_FALSE If no process instance is found with the specified name.
E_FAIL The operation fails.
- Parameters:
-
- iProcInstName
-
- oProcList
o GetWflDefaultCalendar
public virtual HRESULT GetWflDefaultCalendar( | VPMIWflCalendar_var& | oDefaultCal) = 0 |
-
Get the default calendar defined for the Workflow.
Legal values:
S_OK The operation succeeds
E_FAIL The operation failed.
- Parameters:
-
- oDefaultCal
o QueryActivitiesInStatus
-
Specify a query to produce a list of all activity instances, which potentially
are in a given state, and matche a given predicate,
that are owned by a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oProcessList
- The list of processes found.
- iStates
- Optional. The list of states to consider for the processes. If empty, all found
processes are returned no matter their current status is.
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesPlannedIn
public virtual HRESULT QueryActivitiesPlannedIn( | const CATTime& | iFromDate, |
| const CATTime& | iToDate, |
| CATLISTV(VPMIWflActivity_var)& | oActList, |
| const CATUnicodeString& | iFlag | ="INSIDE", |
| const CATIVpmPredicate_var& | iPred | =NULL_var) = 0 |
-
Query for all activities which are planned within an interval of time.
- Parameters:
-
- iFromDate
-
- iToDate
-
- oActList
- The list of activities found.
- iFlag
- Optional. Specifies which planned date of the activity is to be considered.
Legal values:
"START" Check if start date is within the interval.
"END" Check if end date is within the interval.
"INSIDE" Default. Check if start and end dates are within the interval.
"OVERLAY" Check if start and end dates overlay the interval.
"" Default value. Any of the planned start or end date is checked..
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesUsingObject
-
Query for all activities which use a specific object
as (1) input, (2) output, (3) input OR output.
- Parameters:
-
- iObject
- The object used by the candidate activities.
- oActList
- The list of activities found.
- iFlag
- Optional. Specifies how the object is used by the activity.
Legal values:
"IN" The object is used as input.
"OUT" The object is used as output.
"INOUT" Default value. The object is used as input OR output.
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesWithOrg
public virtual HRESULT QueryActivitiesWithOrg( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflRegularActivity_var)& | oActList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL, |
| const CATUnicodeString& | iMembership | ="MANAGER")=0 |
-
Query for all activities having ORGANIZATION ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oActList
- The list of activities found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- iMembership
- Optional. Specifies the organization membership to be considered.
Legal values:
MANAGER Only organizatios of which the user is the manager are considered (default).
MEMBER All organizations of which the user is a member are considered.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesWithOwner
public virtual HRESULT QueryActivitiesWithOwner( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflRegularActivity_var)& | oActList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all activities which are currently owned by a given user.
specified in the first parameter.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oActList
- The list of activities found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesWithRole
public virtual HRESULT QueryActivitiesWithRole( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflRegularActivity_var)& | oActList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all activities having ROLE ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oActList
- The list of activities found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryActivitiesWithUser
public virtual HRESULT QueryActivitiesWithUser( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflRegularActivity_var)& | oActList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all activities having HUMAN ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oActList
- The list of activities found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryDelinquentActivities
public virtual HRESULT QueryDelinquentActivities( | const long& | iDelInt, |
| CATLISTV(VPMIWflActivity_var)& | oActList, |
| const CATLISTV(CATUnicodeString)& | iDelinqStates | =NULL, |
| const CATIVpmPredicate_var& | iPred | =NULL_var) = 0 |
-
Query for all delinquent activities from the current time.
- Parameters:
-
- iDelInt
- The delinquent interval before the current time
- oActList
- The list of activities found.
- iDelinqStates
- Optional. The list of status to be considered as delinquent.
By default (NULL), delinquent status is retrieved from the enum-list in VPM_WORKFLOW_ENUMS.VGraph
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
o QueryProcessesInStatus
public virtual HRESULT QueryProcessesInStatus( | CATLISTV(VPMIWflProcess_var)& | oProcessList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL, |
| const CATIVpmPredicate_var& | iPred | =NULL_var) = 0 |
-
Specify a query to produce a list of all process instances, which potentially
are in a given state, and matche a given predicate,
that are owned by a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oProcessList
- The list of processes found.
- iStates
- Optional. The list of states to consider for the processes. If empty, all found
processes are returned no matter their current status is.
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some process instances are found.
S_FALSE If the operation succeeds but no process instances are found.
E_FAIL The operation fails.
o QueryProcessesUsingObject
-
Query for all process instances which use a specific object as:
(1) a relevant data, (2) an input, (3) an output, (4) input OR output.
- Parameters:
-
- iObject
- The object used by the candidate processes.
- oProcessList
- The list of processes found.
- iFlag
- Optional. Specifies how the object is used by the process.
Legal values:
"" Default value. The object is used as relevant data, no matter it is input or output.
"IN" The object is used as input.
"OUT" The object is used as output.
"INOUT" The object is used as input OR output.
- iPred
- Optional. An additional predicate to take into account.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some process instances are found.
S_FALSE If the operation succeeds but no process instances are found.
E_FAIL The operation fails.
o QueryProcessesWithOrg
public virtual HRESULT QueryProcessesWithOrg( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflProcess_var)& | oProcList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL, |
| const CATUnicodeString& | iMembership | ="MANAGER")=0 |
-
Query for all processes having ORGANIZATION ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oProcList
- The list of processes found.
- iStates
- Optional. The list of states to consider for the processes. If empty,
all found processes are returned no matter their current status is.
- iMembership
- Optional. Specifies the organization membership to be considered.
Legal values:
MANAGER Only organizatios of which the user is the manager are considered (default).
MEMBER All organizations of which the user is a member are considered.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some processes are found.
S_FALSE If the operation succeeds but no processes are found.
E_FAIL The operation fails.
o QueryProcessesWithOwner
public virtual HRESULT QueryProcessesWithOwner( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflProcess_var)& | oProcessList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all processes which are currently owned by a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oProcessList
- The list of processes found.
- iStates
- Optional. The list of states to consider for the processes. If empty, all found
processes are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some process instances are found.
S_FALSE If the operation succeeds but no process instances are found.
E_FAIL The operation fails.
o QueryProcessesWithRole
public virtual HRESULT QueryProcessesWithRole( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflProcess_var)& | oProcList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all processes having ROLE ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oProcList
- The list of processes found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some processes are found.
S_FALSE If the operation succeeds but no processes are found.
E_FAIL The operation fails.
o QueryProcessesWithUser
public virtual HRESULT QueryProcessesWithUser( | const CATUnicodeString& | iUserId, |
| CATLISTV(VPMIWflProcess_var)& | oProcessList, |
| const CATLISTV(CATUnicodeString)& | iStates | =NULL) = 0 |
-
Query for all processes having HUMAN ownership that matches a given user.
- Parameters:
-
- iUserId
- The user for which the query is to be processed.
- oActList
- The list of activities found.
- iStates
- Optional. The list of states to consider for the activities. If empty,
all found activities are returned no matter their current status is.
- Returns:
- A HRESULT.
Legal values:
S_OK If the operation succeeds and some activity instances are found.
S_FALSE If the operation succeeds but no activity instances are found.
E_FAIL The operation fails.
This object is included in the file: VPMIWflQuery.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces