IBM FileNet P8, Version 5.2.1            

MilestoneHelper

This helper class provides reusable milestone-related methods.

For more information, see the comments in the sample source. The samples are supplied in the Developer samples section of the IBM® FileNet® P8 Platform publication library.

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. The queue element provides access to fields in a queue without the expense of retrieving the work object. To obtain process information, however, the API must use the original work object.

This method gets the work object for the queue element argument by using VWQueueElement.fetchWorkObject, and gets the process information from the work object by 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 by using the sample Logger.log.



Last updated: March 2016
milestonehelper.htm

© Copyright IBM Corporation 2016.