wt.projmgmt.execution
Interface ProjExecService

All Known Implementing Classes:

ProjExecServiceFwd, StandardProjExecService

public interface ProjExecService

The ProjExecService class contains the definition of remotely accessible wt.projmgmt.execution API. The access is made through the ProjExecHelper class

Supported API: true

Extendable: false

See Also:

ProjExecHelper

Method Summary

Milestone	addMilestone(ProjectPlan plan, Milestone milestone) Persists and adds milestone to execution object.
QueryResult	addNodesToSummary(SummaryActivity summary, Vector nodes) Adds a set of project nodes to the summary activity passed as argument.
ProjectNode	addPredecessors(ProjectNode node, Vector predecessors, Vector link_types) Adds predecessors to the ProjectNode passed as argument.
ProjectActivity	addProjectActivity(ProjectPlan plan, ProjectActivity activity) Adds a project activity to a project plan.
ProjectNode	addProjectNode(WfContainer container, ProjectNode node, Vector predecessors, Vector link_types) Adds a node to a WfContainer (project plan or summary).
ProjectProxy	addProjectProxy(ProjectPlan plan, ProjectProxy proxy, ProjectPlan sub_project) Adds a project proxy to a project plan.
SummaryActivity	addSummaryActivity(ProjectPlan plan, SummaryActivity summary) Adds a summary activity to a project plan.
Milestone	changeToMilestone(ProjectNode node) Returns a milestone constructed from the project node passed as argument.
ProjectActivity	changeToProjectActivity(ProjectNode node) Returns a project activity constructed from the project node passed as argument.
ProjectProxy	changeToProjectProxy(ProjectNode node) Returns a project proxy constructed from the project node passed as argument.
SummaryActivity	changeToSummaryActivity(ProjectNode node) Returns a summary activity constructed from the project node passed as argument.
ProjectPlan	createPlan(String name, WTContainerRef context_ref) Creates a stand-alone ProjectPlan given its name in the given container.
ProjectPlan	createProjectPlan(Project2 project) Creates a project plan that is associated to the project passed as argument.
ProjectPlan	createProjectPlan(ProjectPlanTemplate template, RoleHolder role_holder) Creates a stand-alone plan.
void	deleteExecutionObject(ExecutionObject exec_obj) Deletes execution object if there is no event associated with it.
void	deleteObjectList(List obj_list) Deletes all execution objects passed as arguments and their linked counterparts in case the "link deliverables" option is true.
ProjectPlan	disableProjectPlan(ProjectPlan plan) Disables the ProjectPlan passed as argument.
QueryResult	getContainedNodes(WfContainer container) Returns all enabled project nodes contained in the workflow container passed as argument.
TimeToElapse	getDuration(ExecutionObject exec_obj) Returns the duration of an wt.projmgmt.executionExecutionObject.
QueryResult	getParentPlans(ProjectPlan plan) Returns a list of references to plans that host the plan passed as argument.
TimeToElapse	getPlannedDuration(ExecutionObject exec_obj) Returns the planned duration of an wt.projmgmt.executionExecutionObject.
QueryResult	getPredecessors(ProjectNode node) Returns all workflow nodes (WfNode) for which the node passed as argument is a successor.
ProjectNode	getProjectNode(ProjectPlan plan, int node_id) Returns project node in the given plan that has the node id passed as argument.
ProjectNode	getProjectNode(ProjectPlan plan, String node_name) Returns project node in the given plan that has the name passed as argument.
QueryResult	getProjectNodes(ProjectPlan plan, Class node_class, WTUser user) Returns all enabled ProjectNode contained in project plan passed as argument of the given class, belonging to a given user.
QueryResult	getProjectNodes(ProjectPlan plan, Class node_class, WTUser user, Integer queryLimit, String orderByStr) Returns all enabled ProjectNode contained in project plan passed as argument of the given class, belonging to a given user.
QueryResult	getProjectPlans() Returns all existing project plans.
QueryResult	getRequesters(ProjectPlan plan) Returns all objects requesting execution from the project plan passed as argument.
QueryResult	getSubPlans(ProjectPlan plan) Returns a list of references to sub-plans contained in the plan passed as argument.
QueryResult	getSuccessors(ProjectNode node) Returns all workflow nodes (WfNode) for which the node passed as argument is a predecessor.
TimeToElapse	getToDateDuration(ExecutionObject exec_obj) Returns the duration of an wt.projmgmt.executionExecutionObject from its start up to the present moment or to the end time in case the object is closed.
QueryResult	getWorkItems(ProjectActivity activity, WTUser user) Returns all project work items contained in the project activity passed as argument that are assigned to the given user.
QueryResult	getWorkItems(ProjectPlan plan, WTUser user) Returns all workitems assigned to the user passed as argument in a given project plan.
QueryResult	getWorkItems(SummaryActivity summary, WTUser user) Returns all workitems in the summary activity passed as argument that are owned by the given user.
ProjectNode	insertAfter(ProjectNode node1, ProjectNode node2) Inserts node1 immediately after node2 as a peer of node2.
ProjectNode	insertBefore(ProjectNode node1, ProjectNode node2) Inserts node1 immediately before node2 as a peer of node2.
ProjectActivity	linkDeliverable(ProjectActivity activity, Deliverable deliverable) Links a Deliverable to a ProjectActivity.
ProjectActivity	linkDeliverable(ProjectActivity activity, Persistable target_obj, boolean latest) Creates a Deliverable with the given target object and associates it to the ProjectActivity passed as argument.
QueryResult	removeNodesFromSummary(SummaryActivity summary, Vector nodes) Removes a set of project nodes from the summary activity passed as argument.
ProjectNode	removePredecessors(ProjectNode node, Vector predecessors) Remove predecessors from the ProjectNode passed as argument.
void	replaceUser(WTContainer container, WTUser replacedUser, WTUser newUser) Changes the ownership of ExecutionObjects in the container passed as argument.
ProjectPlan	setConfigFlags(ProjectPlan plan, boolean allow_change, boolean create_tasks, boolean compute_work) Sets the 'allowStateChange', 'createTask', and 'updateWorkComputePerComp' flags in the ProjectPlan passed as argument.
void	setContainedNodes(SummaryActivity summary, Vector nodes) Set the nodes contained in a SummaryActivity to be ones contained in the list passed as argument.
ExecutionObject	setDuration(ExecutionObject exec_obj, TimeToElapse duration) Sets the duration of an execution object.
ProjectProxy	setPerformerPlan(ProjectProxy proxy, ProjectPlan plan) Sets the performer ProjectPlan for the ProjectProxy passed as argument.
ProjectNode	setPredecessors(ProjectNode node, Vector predecessors, Vector link_types) Sets the predecessors of the ProjectNode passed argument.
ProjectActivity	unlinkDeliverable(ProjectActivity activity) Unlinks the Deliverable currently linked to given the ProjectActivity.

Method Detail

addMilestone

public Milestone addMilestone(ProjectPlan plan,
                              Milestone milestone)
                       throws WTException

Persists and adds milestone to execution object. Returns persisted milestone.

Milesone passed as argument must have not been persisted before.

Supported API: false

Parameters:

plan -

milestone -

Returns:

Milestone

Throws:

WTException

addNodesToSummary

public QueryResult addNodesToSummary(SummaryActivity summary,
                                     Vector nodes)
                              throws WTException

Adds a set of project nodes to the summary activity passed as argument. A project node (ProjectNode can be a project activity, a milestone, a project proxy or another summary activity. If a containment cycle is caused by the operation an exception is thrown.

Supported API: false

Parameters:

summary -

nodes -

Returns:

QueryResult

Throws:

WTException

See Also:

SummaryActivity, ProjectNode

addPredecessors

public ProjectNode addPredecessors(ProjectNode node,
                                   Vector predecessors,
                                   Vector link_types)
                            throws WTException

Adds predecessors to the ProjectNode passed as argument. The new predecessors and the type of dependency are also passed as arguments as two lists (Vector objects). The number of elements of both lists must be the same and the predecessor at position 'i' corresponds to dependency at the same position in the dependency type list.

Returns the node passed as argument, possibly updated.

If the node in the predecessor list already is a predecessor then its dependency type is changed if the dependency is different; otherwise nothing happens.

As a result of setting the predecessors, the time to start of the node passed as argument may change. The updated node is returned in this case.

Supported API: false

Parameters:

node -

predecessors -

link_types -

Returns:

ProjectNode

Throws:

WTException

See Also:

wt.projmgmt.definer.ProjectTypeLink, ProjectNode

addProjectActivity

public ProjectActivity addProjectActivity(ProjectPlan plan,
                                          ProjectActivity activity)
                                   throws WTException

Adds a project activity to a project plan. A list of assignees is passed as argument besides a yets to be persisted activity. Several objects are created and persisted, included templates and input connectors.

Supported API: false

Parameters:

plan -

activity -

Returns:

ProjectActivity

Throws:

WTException

See Also:

ProjectActivity, ProjectPlan

addProjectNode

public ProjectNode addProjectNode(WfContainer container,
                                  ProjectNode node,
                                  Vector predecessors,
                                  Vector link_types)
                           throws WTException

Adds a node to a WfContainer (project plan or summary). The node is also connected to the predecessors passed as argument according to the dependencies also passed as argument.

A node can may be a Milestone, a ProjectActivity, a SummaryActivity, or a ProjectProxy.

A node template object and input connectors are created as well.

The pre-conditions are the following:

• Node has not been persisted yet.
• Container is not completed or cancelled.
• Current user is a project manager.

Supported API: true

Parameters:

container -

node -

predecessors -

link_types -

Returns:

ProjectNode

Throws:

WTException

See Also:

ProjectNode, ProjectNodeTemplate, ProjectPlan

addProjectProxy

public ProjectProxy addProjectProxy(ProjectPlan plan,
                                    ProjectProxy proxy,
                                    ProjectPlan sub_project)
                             throws WTException

Adds a project proxy to a project plan. Several objects are created and persisted, included templates and input connectors.

Supported API: false

Parameters:

plan -

proxy -

sub_project -

Returns:

ProjectProxy

Throws:

WTException

See Also:

ProjectProxy, ProjectPlan

addSummaryActivity

public SummaryActivity addSummaryActivity(ProjectPlan plan,
                                          SummaryActivity summary)
                                   throws WTException

Adds a summary activity to a project plan. Several objects are created and persisted, included templates, requester activity and input connectors. Adding a summary activity has no effect on dynamic values of the project. Assumes summary activity has not been persisted yet.

Supported API: false

Parameters:

plan -

summary -

Returns:

SummaryActivity

Throws:

WTException

See Also:

SummaryActivity, ProjectPlan

changeToMilestone

public Milestone changeToMilestone(ProjectNode node)
                            throws WTException

Returns a milestone constructed from the project node passed as argument. If the node is a Milestone, the argument is simply returned back to the caller. Otherwise the following is true.

• The milestone returned has the same dependency and containment relationships with the other nodes as the project node passed as argument.
• All status/state information is copied over to the milestone.
• If the node passed as argument is a Project Activity the one of the assignees becomes the owner becomes of the milestone.
• The node passed as argument is deleted.

Supported API: true

Parameters:

node -

Returns:

Milestone

Throws:

WTException

changeToProjectActivity

public ProjectActivity changeToProjectActivity(ProjectNode node)
                                        throws WTException

Returns a project activity constructed from the project node passed as argument. If the node is a ProjectActivity, the argument is simply returned back to the caller. Otherwise the following is true.

• The activity returned has the same dependency and containment relationships with the other nodes as the project node passed as argument.
• All status information is copied over to the project activity.
• If the node passed as argument is a Milestone, the owner becomes one of the project activity assignees. Also, if the Milestone state is RUNNING, a task is created for the assignee.
• The node passed as argument is deleted.

Supported API: true

Parameters:

node -

Returns:

ProjectActivity

Throws:

WTException

changeToProjectProxy

public ProjectProxy changeToProjectProxy(ProjectNode node)
                                  throws WTException

Returns a project proxy constructed from the project node passed as argument. If the node is a ProjectProxy, the argument is simply returned back to the caller. Otherwise the following is true.

• The proxy returned has the same dependency and containment relationships with the other nodes as the project node passed as argument.
• All status information is copied over to the project proxy.
• The proxy refers to no sub-project (empty reference).
• The node passed as argument is deleted.

Supported API: true

Parameters:

node -

Returns:

ProjectProxy

Throws:

WTException

changeToSummaryActivity

public SummaryActivity changeToSummaryActivity(ProjectNode node)
                                        throws WTException

Returns a summary activity constructed from the project node passed as argument. If the node is a SummaryActivity, the argument is simply returned back to the caller. Otherwise the following is true.

• The summary returned has the same dependency and containment relationhips with the other nodes as the project node passed as argument.
• All status information is copied over to the summary activity.
• The summary has no contained nodes.
• The node passed as argument is deleted.

Supported API: true

Parameters:

node -

Returns:

SummaryActivity

Throws:

WTException

createPlan

public ProjectPlan createPlan(String name,
                              WTContainerRef context_ref)
                       throws WTException

Creates a stand-alone ProjectPlan given its name in the given container. A "stand-alone" plan is one that is not associated with a Project2 object.

Supported API: true

Parameters:

name -

context_ref -

Returns:

ProjectPlan

Throws:

WTException

createProjectPlan

public ProjectPlan createProjectPlan(ProjectPlanTemplate template,
                                     RoleHolder role_holder)
                              throws WTException

Creates a stand-alone plan. The plan's template is passed as argument as is the role holder to be used. Returns the created project plan.

Supported API: false

Parameters:

template -

role_holder -

Returns:

ProjectPlan

Throws:

WTException

See Also:

ProjectPlan, WfRequesterActivity

createProjectPlan

public ProjectPlan createProjectPlan(Project2 project)
                              throws WTException

Creates a project plan that is associated to the project passed as argument. The plan's template is passed as argument. Returns the created project plan.

Supported API: false

Parameters:

project -

Returns:

ProjectPlan

Throws:

WTException

See Also:

wt.workflow.admin.Project2, ProjectPlan

deleteExecutionObject

public void deleteExecutionObject(ExecutionObject exec_obj)
                           throws WTException

Deletes execution object if there is no event associated with it. Otherwise simply disables the object.

Supported API: true

Parameters:

exec_obj -

Throws:

WTException

See Also:

ExecutionObject, ProjMgmtEvent

deleteObjectList

public void deleteObjectList(List obj_list)
                      throws WTException

Deletes all execution objects passed as arguments and their linked counterparts in case the "link deliverables" option is true. If however the object is associated with a project management event, the object is disabled, not actually removed. All changes to the plan are propagated to containing and successor nodes (status, effort and schedule). Delete events are emitted corresponding to the affected execution objects.

Supported API: false

Parameters:

obj_list -

Throws:

WTException

disableProjectPlan

public ProjectPlan disableProjectPlan(ProjectPlan plan)
                               throws WTException

Disables the ProjectPlan passed as argument. Propagates the disabling to all contained objects. Existing project work items are deleted.

This operation is called after a project is logically (but not physically) deleted from the database.

Supported API: false

Parameters:

plan -

Returns:

ProjectPlan

Throws:

WTException

getContainedNodes

public QueryResult getContainedNodes(WfContainer container)
                              throws WTException

Returns all enabled project nodes contained in the workflow container passed as argument. The association queried in this case is the workflow container to containee association.

Supported API: true

Parameters:

container -

Returns:

QueryResult

Throws:

WTException

See Also:

WfContainer

getDuration

public TimeToElapse getDuration(ExecutionObject exec_obj)
                         throws WTException

Returns the duration of an wt.projmgmt.executionExecutionObject. The duration is computed by counting the number of working days between the computed finish and the computed start dates. The object has completed or cancelled, the computed finish is the actual end time. Otherwise is the estimated finish date. If the object has started, the start time is used. Otherwise, the time to start is used for ProjectNodes and ProjectPlan, the creation time for wt.resource.Deliverables and ProjectWorkItem.

Supported API: true

Parameters:

exec_obj -

Returns:

TimeToElapse

Throws:

WTException

getParentPlans

public QueryResult getParentPlans(ProjectPlan plan)
                           throws WTException

Returns a list of references to plans that host the plan passed as argument. A "host" is a plan that contains a ProjectProxy that references the plan

Supported API: true

Parameters:

plan -

Returns:

QueryResult

Throws:

WTException

getPlannedDuration

public TimeToElapse getPlannedDuration(ExecutionObject exec_obj)
                                throws WTException

Returns the planned duration of an wt.projmgmt.executionExecutionObject. The duration is computed by counting the number of working days between the estimated finish and the computed start dates. If the object has started, the start time is used. Otherwise, the time to start is used for ProjectNodes and ProjectPlan, the creation time for wt.resource.Deliverables and ProjectWorkItem.

Supported API: false

Parameters:

exec_obj -

Returns:

TimeToElapse

Throws:

WTException

getPredecessors

public QueryResult getPredecessors(ProjectNode node)
                            throws WTException

Returns all workflow nodes (WfNode) for which the node passed as argument is a successor. Normally a project node (ProjectNode) is preceded by another project nodes or a single connector ((@link wt.workflow.engine.WfConnector}) if it has no predecessor. Filtering the result of this query is necessary in order to obtain only the project nodes.

Supported API: true

Parameters:

node -

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectNode

getProjectNode

public ProjectNode getProjectNode(ProjectPlan plan,
                                  String node_name)
                           throws WTException

Returns project node in the given plan that has the name passed as argument. Returns 'null' if there is no node with such a name.

Supported API: true

Parameters:

plan -

node_name -

Returns:

ProjectNode

Throws:

WTException

getProjectNode

public ProjectNode getProjectNode(ProjectPlan plan,
                                  int node_id)
                           throws WTException

Returns project node in the given plan that has the node id passed as argument. Returns 'null' if there is no node with such id.

Supported API: true

Parameters:

plan -

node_id -

Returns:

ProjectNode

Throws:

WTException

getProjectNodes

public QueryResult getProjectNodes(ProjectPlan plan,
                                   Class node_class,
                                   WTUser user)
                            throws WTException

Returns all enabled ProjectNode contained in project plan passed as argument of the given class, belonging to a given user. If the given class is 'null' all enabled project nodes are returned. If a user is null, nodes belonging to all users are returned. A ProjectNode may be one of the following: a project activity (ProjectActivity) a summary activity (SummaryActivity), a sub-project (ProjectProxy) or a milestone (Milestone).

Supported API: true

Parameters:

plan -

node_class -

user -

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectActivity, SummaryActivity, Milestone

getProjectPlans

public QueryResult getProjectPlans()
                            throws WTException

Returns all existing project plans.

Supported API: false

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectPlan

getRequesters

public QueryResult getRequesters(ProjectPlan plan)
                          throws WTException

Returns all objects requesting execution from the project plan passed as argument. These objects are of type WfRequester. Normally the requester is a ProjectProxy.

Supported API: true

Parameters:

plan -

Returns:

QueryResult

Throws:

WTException

getSubPlans

public QueryResult getSubPlans(ProjectPlan plan)
                        throws WTException

Returns a list of references to sub-plans contained in the plan passed as argument. A "sub-plan" is a plan that is referenced by a ProjectProxy that is contained in the plan.

Supported API: true

Parameters:

plan -

Returns:

QueryResult

Throws:

WTException

getSuccessors

public QueryResult getSuccessors(ProjectNode node)
                          throws WTException

Returns all workflow nodes (WfNode) for which the node passed as argument is a predecessor. Normally a project node (ProjectNode) is preceded by another project nodes or a single connector ((@link wt.workflow.engine.WfConnector}) if it has no successor. Filtering the result of this query is necessary in order to obtain only the project nodes.

Supported API: true

Parameters:

node -

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectNode

getToDateDuration

public TimeToElapse getToDateDuration(ExecutionObject exec_obj)
                               throws WTException

Returns the duration of an wt.projmgmt.executionExecutionObject from its start up to the present moment or to the end time in case the object is closed. The duration is computed by counting the number of working days between the closed time or the present moment and the computed start dates. If the object has started, the start time is used. Otherwise, the time to start is used for ProjectNodes and ProjectPlan, the creation time for wt.resource.Deliverables and ProjectWorkItem.

Supported API: false

Parameters:

exec_obj -

Returns:

TimeToElapse

Throws:

WTException

getWorkItems

public QueryResult getWorkItems(ProjectActivity activity,
                                WTUser user)
                         throws WTException

Returns all project work items contained in the project activity passed as argument that are assigned to the given user. If the user passed as argument is 'null' then all project work items of the activity are returned.

Supported API: true

Parameters:

activity -

user -

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectWorkItem

getWorkItems

public QueryResult getWorkItems(SummaryActivity summary,
                                WTUser user)
                         throws WTException

Returns all workitems in the summary activity passed as argument that are owned by the given user. If user is 'null' all workitems are returned. The method recursively retrieves workitems down the containment hierarchy.

Supported API: true

Parameters:

summary -

user -

Returns:

QueryResult

Throws:

WTException

getWorkItems

public QueryResult getWorkItems(ProjectPlan plan,
                                WTUser user)
                         throws WTException

Returns all workitems assigned to the user passed as argument in a given project plan.

Supported API: true

Parameters:

plan -

user -

Returns:

QueryResult

Throws:

WTException

insertAfter

public ProjectNode insertAfter(ProjectNode node1,
                               ProjectNode node2)
                        throws WTException

Inserts node1 immediately after node2 as a peer of node2. If node2 is 'null' node1 is inserted in the first position.

Supported API: true

Parameters:

node1 -

node2 -

Returns:

ProjectNode

Throws:

WTException

insertBefore

public ProjectNode insertBefore(ProjectNode node1,
                                ProjectNode node2)
                         throws WTException

Inserts node1 immediately before node2 as a peer of node2. If node2 is 'null' node1 is inserted in the last position.

Supported API: true

Parameters:

node1 -

node2 -

Returns:

ProjectNode

Throws:

WTException

linkDeliverable

public ProjectActivity linkDeliverable(ProjectActivity activity,
                                       Persistable target_obj,
                                       boolean latest)
                                throws WTException

Creates a Deliverable with the given target object and associates it to the ProjectActivity passed as argument. The created deliverable inherits all attributes from the activity to which it becomes associated.

Supported API: true

Parameters:

activity -

target_obj -

latest -

Returns:

ProjectActivity

Throws:

WTException

linkDeliverable

public ProjectActivity linkDeliverable(ProjectActivity activity,
                                       Deliverable deliverable)
                                throws WTException

Links a Deliverable to a ProjectActivity. Operation assumes that the "link deliverables" option is in force. The deliverable may be persistent or not. In the latter case it is persisted in the database. All activity values (with the exception of name and description if they are not null) are inherited by the deliverable. The operation fails (a ProjectManagementException is thrown) in the following cases:

• The activity already has an associated deliverable.
• The deliverable already has an associated activity.

Supported API: true

Parameters:

activity -

deliverable -

Returns:

ProjectActivity

Throws:

WTException

removeNodesFromSummary

public QueryResult removeNodesFromSummary(SummaryActivity summary,
                                          Vector nodes)
                                   throws WTException

Removes a set of project nodes from the summary activity passed as argument. A project node (ProjectNode can be a project activity, a milestone, a project proxy or another summary activity. The node is ignored if it doesn't belong to the summary.

Supported API: false

Parameters:

summary -

nodes -

Returns:

QueryResult

Throws:

WTException

See Also:

SummaryActivity, ProjectNode

removePredecessors

public ProjectNode removePredecessors(ProjectNode node,
                                      Vector predecessors)
                               throws WTException

Remove predecessors from the ProjectNode passed as argument. The predecessors to be removed are passed as arguments as a Vector object. Returns the nodes actually removed, possibly updated.

If the node in the predecessor list is not a predecessor then nothing happens.

Returns the node passed as argument, possibly updated.

As a result of setting the predecessors, the time to start of the node passed as argument may change.

Supported API: false

Parameters:

node -

predecessors -

Returns:

ProjectNode

Throws:

WTException

See Also:

wt.projmgmt.definer.ProjectTypeLink, ProjectNode

replaceUser

public void replaceUser(WTContainer container,
                        WTUser replacedUser,
                        WTUser newUser)
                 throws WTException

Changes the ownership of ExecutionObjects in the container passed as argument. Both the old user and the new user are passed as argument.

Supported API: true

Parameters:

container -

replacedUser -

newUser -

Throws:

WTException

setConfigFlags

public ProjectPlan setConfigFlags(ProjectPlan plan,
                                  boolean allow_change,
                                  boolean create_tasks,
                                  boolean compute_work)
                           throws WTException

Sets the 'allowStateChange', 'createTask', and 'updateWorkComputePerComp' flags in the ProjectPlan passed as argument. The flags that are set are ExecutionConfiguration flags. The new values for these flags are also passed as arguments. The flags are propagated to all ProjectNode objects contained in the ProjectPlan.

Supported API: true

Parameters:

plan -

allow_change -

create_tasks -

compute_work -

Returns:

ProjectPlan

Throws:

WTException

setContainedNodes

public void setContainedNodes(SummaryActivity summary,
                              Vector nodes)
                       throws WTException

Set the nodes contained in a SummaryActivity to be ones contained in the list passed as argument.

Supported API: false

Parameters:

summary -

nodes -

Throws:

WTException

See Also:

ProjectNode

setDuration

public ExecutionObject setDuration(ExecutionObject exec_obj,
                                   TimeToElapse duration)
                            throws WTException

Sets the duration of an execution object.

Supported API: false

Parameters:

exec_obj -

duration -

Returns:

ExecutionObject

Throws:

WTException

setPerformerPlan

public ProjectProxy setPerformerPlan(ProjectProxy proxy,
                                     ProjectPlan plan)
                              throws WTException

Sets the performer ProjectPlan for the ProjectProxy passed as argument. If the performer plan is null, all proxy values are reset. Otherwise the performer values are read and propagated in the proxy's plan.

Throws exceptions in the following cases (inclusive):

• User has no privileges for the operation (requires manager privileges).
• Setting the performer would cause a cycle to be created.

Supported API: true

Parameters:

proxy -

plan -

Returns:

ProjectProxy

Throws:

WTException

setPredecessors

public ProjectNode setPredecessors(ProjectNode node,
                                   Vector predecessors,
                                   Vector link_types)
                            throws WTException

Sets the predecessors of the ProjectNode passed argument. The new predecessors and the type of dependency are also passed as arguments as two lists (Vector objects). The number of elements of both lists must be the same and the predecessor at position 'i' corresponds to dependency at the same position in the dependency type list. Returns the node passed as argument, possibly updated.

If the node in the predecessor list already is a predecessor then its dependency type is changed if the dependency is different; otherwise nothing happens. All current predecessor nodes that are not in the list of predecessors passed as argument are removed as predecessors.

As a result of setting the predecessors, the time to start of the node passed as argument may change. The updated node is returned in this case.

Supported API: false

Parameters:

node -

predecessors -

link_types -

Returns:

ProjectNode

Throws:

WTException

See Also:

wt.projmgmt.definer.ProjectTypeLink, ProjectNode

unlinkDeliverable

public ProjectActivity unlinkDeliverable(ProjectActivity activity)
                                  throws WTException

Unlinks the Deliverable currently linked to given the ProjectActivity. If there is no deliverable associated with the activity nothing happens. Operation assumes that the "link deliverables" option has been selected. The activity and deliverable maintain all its curernt values, so that no propagation takes place.

Supported API: true

Parameters:

activity -

Returns:

ProjectActivity

Throws:

WTException

getProjectNodes

public QueryResult getProjectNodes(ProjectPlan plan,
                                   Class node_class,
                                   WTUser user,
                                   Integer queryLimit,
                                   String orderByStr)
                            throws WTException

Returns all enabled ProjectNode contained in project plan passed as argument of the given class, belonging to a given user. If the given class is 'null' all enabled project nodes are returned. If a user is null, nodes belonging to all users are returned. A ProjectNode may be one of the following: a project activity (ProjectActivity) a summary activity (SummaryActivity), a sub-project (ProjectProxy) or a milestone (Milestone).

Supported API: true

Parameters:

plan -

node_class -

user -

queryLimit -

orderByStr -

Returns:

QueryResult

Throws:

WTException

See Also:

ProjectActivity, SummaryActivity, Milestone