Package com.prozima.pengine

The Prozima Planning Engine (PEngine) provides classes that facilitate the creation of and manipulation of projects, schedules and resources.

See:
Description

Interface Summary

Command	All commands passed to the method PEngine.invoke(Command) must implement this interface.
EventInterface	Encapsulates an event which informs listeners about significant events in the operation of the PEngine.
EventListener	Listens for notification events from the PEngine.
PEngineConstants	Constants provided by and used by PEngine.

Class Summary

Activity	Represents the state of an activity, which is one of the two types of schedule node.
ActivityDates	Represents the state of the scheduled and actual start and finish dates for a Activity.
AddWorkCommand	Command which adds work which contributes towards an activity.
Constraint	Places bounds on the scheduled start and finish dates of an activity or milestone.
CopyScheduleCommand	Copies a schedule and its schedule nodes.
Cost	Cost specifies an amount of money in a specific currency.
CostRule	Each Resource has one or more cost rules associated with it which define the cost of using the Resource.
CostTable	A CostTable controls the allocation of CostRules, allowing their organisation by time and priority.
CreateActivityCommand	Command to create a new activity in a schedule.
CreateMilestoneCommand	Creates a new milestone and adds it to a schedule.
CreateProjectCommand	Create a new project.
CreateResourceCommand	Create a new resource.
CreateScheduleCommand	Command which creates a new schedule, which is attached to a specific project.
CreateWBSComponentCommand	Command creates a new Work Breakdown Structure component and initialises its state.
DeleteActivityCommand	Command removes an activity from a specific schedule.
DeleteMilestoneCommand	Command removes an milestone from a specific schedule.
DeleteProjectCommand	Delete an existing project.
DeleteResourceCommand	Command which removes a resource.
DeleteScheduleCommand	Command requests the deletion of a schedule.
DeleteWBSComponentCommand	Command requests the deletion of a WBS Component from a project.
DeleteWorkCommand	Command deletes finished work for an activity.
EventSender	Inherited by all classes which can distribute PEngine events.
HourlyCostRule	Cost rule defines the cost of using a resource using an hourly rate.
LicenceLimits	Provides limits imposed by the licence which applies to this version of the library.
Milestone	Represents a milestone in a schedule.
MilestoneDates	Information about the scheduled and actual start and finish dates for a milestone.
NodeDates	Holds a description of the start and finish dates which have been assigned to a schedule node by PEngine.
PEngine	PEngine provides a static, singleton instance of the Prozima Planning Engine.
Project	Stores the state of a project.
Relationship	Represents a relationship between two nodes in a schedule.
ResetCommand	Command restores the state of PEngine to its initial configuration.
Resource	Resource represents the state of a resource.
Schedule	Encapsulates all the information which describes a schedule.
ScheduleNode	Represents the state of a node in a schedule.
UpdateActivityCommand	Command updates the state of an already existing activity.
UpdateMilestoneCommand	Command modifies the state of a milestone.
UpdateProjectCommand	Command describes how a project should be modified.
UpdateResourceCommand	Command specifies how a resource should be modified.
UpdateScheduleCommand	Command modifies the state of an existing schedule.
UpdateWBSComponentCommand	Command updates a WBS Component.
WBSComponent	Represents a component in the Work Breakdown Structure.
Work	Represents the effort which was or will be expended by a resource towards the completion of an activity.

Enum Summary

Constraint.ConstraintType	Type of constraint.
EventInterface.ID	Unique identifier which describes the type of PEngineEvent.
Relationship.RelationshipType	Defines the type of relationshipType which a schedule node can have with other nodes.
ScheduleNode.PredecessorType	Specifies the type of predecessor in a relationship.
ScheduleNode.Scheduling	Specifies if an schedule node should be scheduled ASAP or ALAP within its constraints and relationships.

Package com.prozima.pengine Description

The Prozima Planning Engine (PEngine) provides classes that facilitate the creation of and manipulation of projects, schedules and resources. Using the functionality provided by PEngine, it is possible to incorporate advanced project management capabilities in an application.

The state of PEngine must be initialised correctly by passing asynchronous commands to the API. All interaction with PEngine is asynchronous. Whenever the state of PEngine changes, it sends events to all registered listeners, notifying them of the type of change which took place. The API of PEngine provides numerous getter methods which allow the state of the library to be queried at any time.

As various versions of PEngine exist, depending on the licenced version being used there may be artificial limits placed on some features. Following is a summary of the limits applied to this version of the library:

• Maximum number of projects which may exist simultaneously: 4
• Maximum number of schedules which may be added to each project: 4
• Maximum number of resources which may exist simultaneously: 10