wt.epm.workspaces
Interface EPMBaselineService

public interface EPMBaselineService

The EPMBaselineService interface identifies the set of methods that applications use to manage the set of objects included in the workspace. While all of the methods declared by this interface execute on the server, they are accessable to client application through a helper class.

See EPMBaselineHelper.

Supported API: true

Extendable: false

Method Summary

Baseline	copyToBaseline(EPMWorkspace workspace, Baseline baseline) Copy the baseline in the workspace to the baseline provided.
wt.epm.workspaces.EPMAsStoredConfig	createEPMAsStoredConfig(EPMConfigurationType type, Vector owners, Vector members) This method creates an EPMAsStoredConfig with the given owners, members and type.
void	dispatchNewBaselineEvent(Baseline baseline, Vector baselineable, EPMWorkspace workspace) Dispatches a NEW_BASELINE event.
QueryResult	getPartsAndDocs(Vector baselineable, EPMWorkspace workspace, EPMPopulateRule rule) Return a QueryResult of EPMDocuments and WTParts which are related to the input set of WTParts subject to the ConfigSpecs of the EPMWorkspace and the given EPMPopulateRule.
QueryResult	getRelatedItems(EPMWorkspace workspace, EPMPopulateRule rule, Vector baselineable) Return a QueryResult of EPMDocuments that the given objects are related to by EPMDependencyLinks subject to the EPMDocConfigSpec of the given EPMWorkspace and the given EPMPopulateRule.
QueryResult	getStatus(EPMWorkspace workspace) Determine which objects in the workspace have been checked out to a different folder.
EPMWorkspace	populate(EPMWorkspace workspace, Vector baselineable, EPMPopulateRule populateRule) Adds the Baselineable item iterations to the Workspace.
EPMWorkspace	populateAll(EPMWorkspace workspace, Vector baselineable) Adds the Baselineable item iterations to the Workspace by navigating recursively from the object using the EPMDocConfigSpecNavigator.
EPMWorkspace	populateRequired(EPMWorkspace workspace, Vector baselineable) Adds the Baselineable item iterations to the Workspace by navigating recursively from the object using the EPMDocConfigSpecNavigator.
QueryResult	refreshWorkspace(EPMWorkspace workspace) Return a QueryResult of EPMDocuments and WTParts which represent the set of objects which need to be updated in the EPMWorkspace.
QueryResult	updateWorkspace(EPMWorkspace workspace) Update the objects in the EPMWorkspace.
QueryResult	updateWorkspace(EPMWorkspace workspace, Vector baselineable) Update the objects given as parameters.

Method Detail

populate

EPMWorkspace populate(EPMWorkspace workspace,
                      Vector baselineable,
                      EPMPopulateRule populateRule)
                      throws WTException

Adds the Baselineable item iterations to the Workspace. The PopulateRule indicates what type of traversal to use.

Supported API: true

Parameters:

workspace - The workspace to be affected by the call.

baselineable - A Vector of objects to be added (together with the related items determined by the populareRule) to the workspace.

populateRule -

Returns:

EPMWorkspace

Throws:

WTException

populateAll

EPMWorkspace populateAll(EPMWorkspace workspace,
                         Vector baselineable)
                         throws WTException

Adds the Baselineable item iterations to the Workspace by navigating recursively from the object using the EPMDocConfigSpecNavigator. Both required and optional dependencies are traversed. All items are added within a single transaction. If iterations for the same Master of an item appear more than once in the structure, then the item iteration that was first encountered will be added to the Workspace.

Supported API: true

Parameters:

workspace - The workspace to be affected by the call.

baselineable - A Vector of objects to be added to the workspace.

Returns:

EPMWorkspace

Throws:

WTException

populateRequired

EPMWorkspace populateRequired(EPMWorkspace workspace,
                              Vector baselineable)
                              throws WTException

Adds the Baselineable item iterations to the Workspace by navigating recursively from the object using the EPMDocConfigSpecNavigator. Only required dependencies are traversed. All items are added within a single transaction. If iterations for the same Master of an item appear more than once in the structure, then the item iteration that was first encountered will be added to the Workspace.

Supported API: true

Parameters:

workspace - The workspace to be affected by the call.

baselineable - A Vector of objects to be added to the workspace.

Returns:

EPMWorkspace

Throws:

WTException

copyToBaseline

Baseline copyToBaseline(EPMWorkspace workspace,
                        Baseline baseline)
                        throws WTException

Copy the baseline in the workspace to the baseline provided.

Supported API: true

Parameters:

workspace - The workspace referenced by the call.

baseline - The baseline to be filled in.

Returns:

Baseline

Throws:

WTException

getRelatedItems

QueryResult getRelatedItems(EPMWorkspace workspace,
                            EPMPopulateRule rule,
                            Vector baselineable)
                            throws WTException

Return a QueryResult of EPMDocuments that the given objects are related to by EPMDependencyLinks subject to the EPMDocConfigSpec of the given EPMWorkspace and the given EPMPopulateRule.

Supported API: true

Parameters:

workspace - The workspace referenced by the call.

rule -

baselineable - A Vector of objects whose related items are to be returned.

Returns:

QueryResult

Throws:

WTException

getStatus

QueryResult getStatus(EPMWorkspace workspace)
                      throws WTException

Determine which objects in the workspace have been checked out to a different folder.

Supported API: true

Parameters:

workspace - The workspace referenced by the call.

Returns:

QueryResult

Throws:

WTException

dispatchNewBaselineEvent

void dispatchNewBaselineEvent(Baseline baseline,
                              Vector baselineable,
                              EPMWorkspace workspace)
                              throws WTException

Dispatches a NEW_BASELINE event.

Supported API: true

Parameters:

baseline - Newly created baseline, referred by the call.

baselineable - Vector of baselineable objects checkedin by the client.

workspace - EPM Workspace referred by the call.

Throws:

WTException

getPartsAndDocs

QueryResult getPartsAndDocs(Vector baselineable,
                            EPMWorkspace workspace,
                            EPMPopulateRule rule)
                            throws WTException

Return a QueryResult of EPMDocuments and WTParts which are related to the input set of WTParts subject to the ConfigSpecs of the EPMWorkspace and the given EPMPopulateRule. WTParts are traced first and related EPMDocuments are chosen for dependency tracing using the DocConfigSpec

Supported API: true

Parameters:

baselineable -

workspace -

rule -

Returns:

QueryResult

Throws:

WTException

createEPMAsStoredConfig

wt.epm.workspaces.EPMAsStoredConfig createEPMAsStoredConfig(EPMConfigurationType type,
                                                            Vector owners,
                                                            Vector members)
                                                            throws WTPropertyVetoException,
                                                                   WTException

This method creates an EPMAsStoredConfig with the given owners, members and type. No two iteration of the same master is allowed in the owner and member lists.

Supported API: true

Parameters:

type - Any of the EPMConfiguration Type

owners - a list of unique EPMDocuments that do not belong to any EPMAsStoredConfig as owner

members - a list of unique EPMDocuments or WTDocuments

Returns:

EPMAsStoredConfig

Throws:

WTPropertyVetoException

WTException

refreshWorkspace

QueryResult refreshWorkspace(EPMWorkspace workspace)
                             throws WTException

Return a QueryResult of EPMDocuments and WTParts which represent the set of objects which need to be updated in the EPMWorkspace. Filtering is DocCentric or PartCentric depending on the EPMWorkspace property

Supported API: true

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

updateWorkspace

QueryResult updateWorkspace(EPMWorkspace workspace)
                            throws WTException

Update the objects in the EPMWorkspace. Filtering is done by checking the Workspace preference for Doc or Part Centric processing

Supported API: true

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

updateWorkspace

QueryResult updateWorkspace(EPMWorkspace workspace,
                            Vector baselineable)
                            throws WTException

Update the objects given as parameters. Filtering is done by checking the Workspace preference for Doc or Part Centric processing

Supported API: true

Parameters:

workspace -

baselineable -

Returns:

QueryResult

Throws:

WTException