WorkflowPriorityQueueService

Class of the Workflow Priority Queue Web Service.

Endpoint Metadata

  • Namespace: http://opencase.extend.com/workflowservice/webservices/workflowpriorityqueue
  • Endpoint Name: WorkflowPriorityQueueWebService
  • Endpoint Address: http(s)://{VMS URL}/WorkflowService/webservices/workflowpriorityqueue-service

The following methods are available on this endpoint:

addQueueEntry

Method adds entry to queue.

Input Parameters

name type description
workflowPriorityQueueEntry workflowPriorityQueueEntry the entry to add to queue

Return Value

type description
workflowPriorityQueueEntry the created queue entry

Faults

name description
WorkflowPriorityQueueWebServiceFault wrapped exception from persistence

checkIfExistByWorkflowNameAndWorkflowContextContent

Checks whether there is an entry in Workflow Priority Queue with the given workflowName and with WorkflowContext that contains givenstring or expression.

Input Parameters

name type description
workflowName string the workflow name to check to
searchExpressionInWorkflowContext string the string or expression to search in Workflow Context xml. As value of this parameter the Oracle CONTEXT grammar for CONTAINS operator can be used(for example: "some_value INPATH (//entry[key = "some_key";]/value)

Return Value

type description
boolean true if exist at least one such entry, false - otherwise

findWorkflowPriorityQueueEntriesByStatusAndMarker

Find Workflow Priority Queue Entries by status and marker fields.

Input Parameters

name type description
status string queue entry status
marker string queue entry marker (supported search by prefix of marker value)

Return Value

type description
list<workflowPriorityQueueEntry> list of found entries

findWorkflowPriorityQueueEntryByPk

Find the Workflow Priority Queue Entry based on the Pk

Input Parameters

name type description
entityPk int The pk of the entity

Return Value

type description
workflowPriorityQueueEntry The WorkflowPriorityQueueEntry

removeQueueEntry

Delete the queue entry by pk

Input Parameters

name type description
workflowPriorityQueueEntryPk int The pk of the workflow priority Queue.

unlockQueueAndIncrementRetry

Unlock the Queue Entry and Increment Retry

Input Parameters

name type description
workflowPriorityQueueEntryPk int the pk of the workflowPriorityQueueEntry

updateWorkflowPriorityQueueEntryStatusAndMarker

Update Workflow Priority Queue Entry status and marker fields.

Input Parameters

name type description
entityPk int entity pk
status string new status
marker string new marker