MilestoneHelper

This helper class provides reusable milestone-related methods.

Refer to the comments in the sample source for further information. The samples are located on the P8 Documentation CD or ESD image in:

   ecm_help\developer_help\process_java_api\Developer Files\samples\api

See also Running the API Samples.

Methods

General descriptions of the MilestoneHelper methods follow:

MilestoneHelper()

The MileStoneHelper constructor initializes local variables to point to its VWSession and sample Logger class objects arguments.

getMilestoneDefinitions()

Milestone definitions are a part of the process information of a work object. A queue element represents the workflow object in a queue. Although this queue element provides access to fields in a queue without the expense of retrieving the work object, the API must use the original work object to obtain process information.

This method gets the work object for the queue element argument using VWQueueElement.fetchWorkObject, and gets the process information from the work object using VWWorkObject.fetchProcess. VWProcess.getMilestoneDefinitions then retrieves the milestone definition information as an array of VWMileStoneDefinition objects. This object array is the return value for this method.

printMilestoneInfo()

The milestone definitions (VWMileStoneDefinition objects) obtained through the local getMilestoneDefinitions method, contain milestone descriptions as a milestone name string, message string, and level (integer). This method iterates through the VWMileStoneDefinition array, and displays these values using the sample Logger.log.