wt.projmgmt.definer
Interface ProjDefinerServiceSvr

All Known Implementing Classes:
StandardProjDefinerService

public interface ProjDefinerServiceSvr

ProjDefinerServiceSvr interface defines the project management template API that is accessible only in the server.

Supported API: false

Extendable: false


Method Summary
 ProjectNode addNode(ProjectNode node, WfContainer container)
          Adds node to container passed as argument.
 NodeTemplateLink createLink(WfNode source_node, WfNode dest_node, ProjectLinkType link_type)
          Creates dependency link between two nodes.
 Milestone createMilestoneTemplate(ProjectPlan plan, Milestone milestone)
          Creates a milestone template given the project plan and the milestone instance.
 ProjectNode createNodeTemplate(WfContainer container, ProjectNode node)
          Creates a project node template given the node container (plan or summary) and the node instance.
 ProjectActivity createProjectActivityTemplate(ProjectPlan plan, ProjectActivity activity)
          Creates a project activity template given the project plan, the activity instance and a vector containing references to activity assignees.
 ProjectProxy createProjectProxyTemplate(ProjectPlan plan, ProjectProxy proxy)
          Creates a project proxy template given the project plan and the proxy instance.
 void createStartEndConnectors(WfContainerTemplate template, WfContainer container)
          Creates the start and end connectors for a container passed as arguments.
 SummaryActivity createSummaryActivityTemplate(ProjectPlan plan, SummaryActivity summary)
          Creates a summary activity template given the project plan and the activity instance.
 void deleteFinalLink(WfNode pred_node, WfNode succ_node)
          Deletes the link that joins the first node to an end connector if both nodes belong to the same container.
 WfNode deleteInitialLink(WfNode node)
          Deletes the link that joins the start connector to the node passed as argument.
 void removeDependency(WfNode source_node, WfNode dest_node)
          Deletes all links between the templates of the nodes passed as argument.
 ProjectNode removeNode(ProjectNode node)
          Removes node from its current container.
 NodeTemplateLink setLinkType(WfNode source_node, WfNode dest_node, ProjectLinkType link_type)
          Sets the type of dependency beteween two nodes to the dependency passed as argument (ProjectLinkType).
 

Method Detail

createProjectActivityTemplate

public ProjectActivity createProjectActivityTemplate(ProjectPlan plan,
                                                     ProjectActivity activity)
                                              throws WTException
Creates a project activity template given the project plan, the activity instance and a vector containing references to activity assignees. The start connector of the plan template is connected to the activity template created.

Supported API: false

Parameters:
plan -
activity -
Returns:
ProjectActivity
Throws:
WTException
See Also:
ProjectActivityTemplate, ProjectActivity

createMilestoneTemplate

public Milestone createMilestoneTemplate(ProjectPlan plan,
                                         Milestone milestone)
                                  throws WTException
Creates a milestone template given the project plan and the milestone instance. The start connector of the plan template is connected to the milestone template created.

Supported API: false

Parameters:
plan -
milestone -
Returns:
Milestone
Throws:
WTException

createSummaryActivityTemplate

public SummaryActivity createSummaryActivityTemplate(ProjectPlan plan,
                                                     SummaryActivity summary)
                                              throws WTException
Creates a summary activity template given the project plan and the activity instance. The start connector of the plan template is connected to the activity template created.

Supported API: false

Parameters:
plan -
summary -
Returns:
SummaryActivity
Throws:
WTException
See Also:
SummaryActivityTemplate, SummaryActivity

createProjectProxyTemplate

public ProjectProxy createProjectProxyTemplate(ProjectPlan plan,
                                               ProjectProxy proxy)
                                        throws WTException
Creates a project proxy template given the project plan and the proxy instance. The start connector of the plan template is connected to the template created.

Supported API: false

Parameters:
plan -
proxy -
Returns:
ProjectProxy
Throws:
WTException
See Also:
ProjectProxyTemplate, ProjectProxy

createNodeTemplate

public ProjectNode createNodeTemplate(WfContainer container,
                                      ProjectNode node)
                               throws WTException
Creates a project node template given the node container (plan or summary) and the node instance. A node can can be a Milestone, a ProjectActivity, a SummaryActivity, or a ProjectProxy.

The start connector of the container template is connected to the project node template created.

Supported API: false

Parameters:
container -
node -
Returns:
ProjectNode
Throws:
WTException
See Also:
ProjectNodeTemplate, ProjectNode, WfContainer, ProjectPlan, SummaryActivity

removeDependency

public void removeDependency(WfNode source_node,
                             WfNode dest_node)
                      throws WTException
Deletes all links between the templates of the nodes passed as argument. Only links between source and destination are deleted.

Supported API: false

Parameters:
source_node -
dest_node -
Throws:
WTException

setLinkType

public NodeTemplateLink setLinkType(WfNode source_node,
                                    WfNode dest_node,
                                    ProjectLinkType link_type)
                             throws WTException
Sets the type of dependency beteween two nodes to the dependency passed as argument (ProjectLinkType). Assumes the source node is a ProjectNode (activity, milestone or summary) and the destination node is a connector (input connector of another project node).

Supported API: false

Parameters:
source_node -
dest_node -
link_type -
Returns:
NodeTemplateLink
Throws:
WTException

createLink

public NodeTemplateLink createLink(WfNode source_node,
                                   WfNode dest_node,
                                   ProjectLinkType link_type)
                            throws WTException
Creates dependency link between two nodes. The type of dependency is passed as argument. Assumes the source node is a ProjectNode (activity, milestone or summary) and the destination node is a connector (input connector of another project node).

Supported API: false

Parameters:
source_node -
dest_node -
link_type -
Returns:
NodeTemplateLink
Throws:
WTException

removeNode

public ProjectNode removeNode(ProjectNode node)
                       throws WTException
Removes node from its current container. This is done by deleting all links between the start connector and the node and from the node to the end connector.

Supported API: false

Parameters:
node -
Returns:
ProjectNode
Throws:
WTException

addNode

public ProjectNode addNode(ProjectNode node,
                           WfContainer container)
                    throws WTException
Adds node to container passed as argument. It does that by creating links from the start connector to the node and from the node to the end connector.

Supported API: false

Parameters:
node -
container -
Returns:
ProjectNode
Throws:
WTException

createStartEndConnectors

public void createStartEndConnectors(WfContainerTemplate template,
                                     WfContainer container)
                              throws WTException
Creates the start and end connectors for a container passed as arguments. Creates both the template and the instance connectors. Assumes container has been persisted.

This method is used when a summary or a project plan is created. It is called only once for each created object.

Supported API: false

Parameters:
template -
container -
Throws:
WTException

deleteInitialLink

public WfNode deleteInitialLink(WfNode node)
                         throws WTException
Deletes the link that joins the start connector to the node passed as argument. If there is no link in this situation, retrun 'null' otherwise returns the node possibly changed (connectors). Used when creating a dependency between two nodes to ensure that the node is not preceded by the start connector.

Supported API: false

Parameters:
node -
Returns:
WfNode
Throws:
WTException

deleteFinalLink

public void deleteFinalLink(WfNode pred_node,
                            WfNode succ_node)
                     throws WTException
Deletes the link that joins the first node to an end connector if both nodes belong to the same container. Used to ensure that the first node is only succeeded by the second node when creating a dependency between the two nodes.

Supported API: false

Parameters:
pred_node -
succ_node -
Throws:
WTException