WMFetchProcessDefinitionStates WMFetchProcessDefinitionStatesThis call returns all the process definition states depending upon the filter criterion. The fetch process is complete when the call returns the error WM_NO_MORE_DATA.
You can view the XML input and output parameters which have to be passed for fetching the list and displaying it. There is a list of errors and warning that can occur in the execution.
* implies for the mandatory parameter.
|
Name |
Parent Tag |
Description |
Valid Value |
|
Option * |
Root |
It refers to the case sensitive call name. |
Case sensitive call name. |
|
EngineName * |
Root |
It is the cabinet or database name, which has to be connected. |
NA |
|
SessionID * |
Root |
It is the logged in user session id |
NA |
|
CountFlag |
Root |
It is flag which specifies whether to fetch the total count or not |
"Y" for yes to fetch the count. "N" for not to fetch the count. |
|
Type |
Filter (Filter tag is not mandatory tag. You can fetch the list of all the states not including filter tag)
|
Type of the filter criteria specified. Filter type can be SQL string or an attribute. If you are filtering on attributes, then filter string contains the value of the attribute. 0-255 are reserved , if it is 256 than its SQL type filter. Then you Filter string will contains an SQL query. |
NA |
|
AttributeName |
Filter |
The attribute name on which the filter is set.. |
NA |
|
Comparison |
Filter |
It is operator for the filter |
1 for > ; 2 for >= ;3 for =; 4 <> ; 5 for <; 6 for <=; 7 for like, 8 for not like. |
|
FilterString |
Filter |
It is string specified for the filtering |
NA |
|
NoOfRecordsToFetch |
BatchInfo (BatchInfo tag is not mandatory tag. You can fetch the list of all the states by not including this tag) |
It is the batch size for the process to be fetched. |
NA |
|
LastValue |
BatchInfo |
It is the last element of the list that is fetched. |
NA |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
It refers to the case sensitive call name. |
|
MainCode |
Exception |
Error code specified by WAPI. |
|
ProcessDefinitionState |
ProcessDefinitionStates |
It is the state of the process. It can be Enabled or Disabled. |
|
RetrieveCount |
Root |
It is the number of elements that are fetched in the result |
|
Count |
Root |
It is the total number of elements in the result. |
|
Code |
Constant Value |
Message |
|
11 |
WM_INVALID_SESSION_HANDLE |
Invalid session. |
|
12 |
WM_INVALID_QUERY_HANDLE |
WM_INVALID_QUERY_HANDLE |
|
18 |
WM_NO_MORE_DATA |
No more records |