Within the Process Java APIs there exist a limited number of classes which you must use to access the APIs. Most classes in the Process Java APIs require prior existence of one, or more, of these objects. In most cases, working with the Process Java APIs requires initial calls to one of these classes. The primary classes are listed here and discussed below:
The following sections provide a general introduction to the classes you can access using the APIs listed above. Refer to the Process Java APIs reference documentation for more detailed information.
Constructed using the following method:
VWSession(username, password, router_URL)
Once you have a VWSession object, you can access the following classes to perform these general tasks:
Class |
Functional description |
---|---|
VWQueue | With this object you can query queues and retrieves queue descriptions, information on the supported data fields, and step elements. |
VWRoster | With this object you query rosters and retrieve information about the workflow participants. |
VWLog | With this object you can log system and user-driven events to a log and retrieve log elements from the system. |
Constructed using the following method:
VWWorkflowDefinition()
Once you have a VWWorkflowDefinition object to access the following classes to perform these general tasks:
Class |
Functional description |
---|---|
VWMapDefinition | With this object you can access workflow steps and workflow map properties. |
VWFieldDefinition | With this object you can access or set field definitions. |
VWMilestoneDefinition | With this object you can access or set milestone definitions. |
Created using the following methods:
VWSession(username, password, router_URL)
VWSession.fetchSystemConfiguration()
Once you have a VWSession object, you can create a VWSystemConfiguration object to access the following classes to perform these general tasks:
Class |
Functional description |
---|---|
VWRosterDefinition | With this object you can access and administer rosters. |
VWLogDefinition | With this object you can access and administer event log definitions. |
VWQueueDefinition | With this object you can access and administer queues. |
VWStepProcessorInfoDefinition | With this object you can access and administer Step Processors. |
Created using the following methods:
VWSession(username, password, router_URL)
VWSession.fetchSystemAdministration()
Once you have a VWSession object, you can create a VWSystemAdministration object to create users or access user information, using the VWUserInfo class.