wt.epm.workspaces
Interface EPMBaselineService

All Known Implementing Classes:

EPMBaselineServiceFwd, EPMStandardBaselineService

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

EPMWorkspace	add(EPMWorkspace workspace, Vector baselineable) Deprecated. at 8.0 Use EPMWorkspaceManager.addToWorkspace
Baseline	addMembers(Vector members, Baseline baseline) Deprecated.
Baseline	addToBaseline(Vector members, Baseline baseline) Deprecated.
QueryResult	checkinOrMove(EPMWorkspace workspace, Vector objects) Deprecated. at R8.0. Use EPMWorkspaceManager.checkin
QueryResult	checkinOrMove(EPMWorkspace workspace, Vector objects, Vector familyTablesToCheckin) Deprecated. at R8.0. Use EPMWorkspaceManager.checkin
Baseline	copyToBaseline(EPMWorkspace workspace, Baseline baseline) Copy the baseline in the workspace to the baseline provided.
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.
EPMCheckpoint	getAssociatedCheckpoint(EPMWorkspace workspace) This gets the checkpoint associated with a Workspace.
QueryResult	getBaselineItems(EPMWorkspace workspace) Deprecated. at R8.0. Use EPMWorkspaceManager.getObjectsInWorkspace
QueryResult	getBaselines(EPMFamilyTable familyTable) Supported API: false
QueryResult	getBaselines(EPMFamilyTable familyTable, Class baselineClass) Supported API: false
QueryResult	getFTBaselineItems(Baseline baseline) Supported API: false
List	getNewObjects(List objects, boolean ignorePrivateIterations) This method returns List of ObjectIdentifiers which are new in the given input list.
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.
boolean	isAnyIterationInBaseline(EPMFamilyTable familyTable, Baseline baseline) Supported API: false
boolean	isInBaseline(EPMFamilyTable familyTable, Baseline baseline) Supported API: false
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	refresh(EPMWorkspace workspace, EPMPopulateRule rule) Deprecated. in 7.0 Use refreshDocsAndParts
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	refreshWorkspace(EPMWorkspace workspace, Vector baselineable) Return a QueryResult of EPMDocuments and WTParts which represent the set of objects which need to be updated in the EPMWorkspace restricted to the input vector.
EPMWorkspace	remove(EPMWorkspace workspace, Vector baselinable) Deprecated. at 8.0 Use EPMWorkspaceManager.removeFromWorkspace
Baseline	removeFromBaseline(Vector members, Baseline baseline) Deprecated.
Collection	undoCheckout(EPMWorkspace workspace, Collection objects, Collection familyTablesToUndoCheckout) Supported API: false
QueryResult	update(EPMWorkspace workspace, EPMPopulateRule rule) Deprecated. in 7.0 Use updateDocsAndParts
QueryResult	update(EPMWorkspace workspace, Vector baselinable, EPMPopulateRule rule) Deprecated. in 7.0 Use updateDocsAndParts
QueryResult	updateWorkspace(EPMWorkspace workspace) Update the objects in the EPMWorkspace.
QueryResult	updateWorkspace(EPMWorkspace workspace, Vector baselineable) Update the objects given as parameters.

Method Detail

refresh

public QueryResult refresh(EPMWorkspace workspace,
                           EPMPopulateRule rule)
                    throws WTException

Deprecated. in 7.0 Use refreshDocsAndParts

Determine which objects would be affected by an update() call.

Supported API: false

Parameters:

workspace - The workspace to be affected by the call.

rule - The EPMPopulateRule which determines what dependent objets are also entered into the Baseline.

Returns:

QueryResult

Throws:

WTException

update

public QueryResult update(EPMWorkspace workspace,
                          EPMPopulateRule rule)
                   throws WTException

Deprecated. in 7.0 Use updateDocsAndParts

Update all objects in the Workspace.

Supported API: false

Parameters:

workspace - The workspace to be affected by the call.

rule - The EPMPopulateRule which determines what dependent objects are also entered into the Baseline.

Returns:

QueryResult

Throws:

WTException

update

public QueryResult update(EPMWorkspace workspace,
                          Vector baselinable,
                          EPMPopulateRule rule)
                   throws WTException

Deprecated. in 7.0 Use updateDocsAndParts

Update the objects given as parameters.

Supported API: false

Parameters:

workspace - The workspace to be affected by the call.

baselinable - The set of objects with which to populate the baseline (and whose dependencies will be used with the EPMPopulateRule).

rule - The EPMPopulateRule which determines what dependent objects are also entered into the Baseline.

Returns:

QueryResult

Throws:

WTException

remove

public EPMWorkspace remove(EPMWorkspace workspace,
                           Vector baselinable)
                    throws WTException

Deprecated. at 8.0 Use EPMWorkspaceManager.removeFromWorkspace

Remove the specified object from the Workspace.

Supported API: false

Parameters:

workspace - The workspace to be affected by the call.

baselinable -

Returns:

EPMWorkspace

Throws:

WTException

populate

public 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

add

public EPMWorkspace add(EPMWorkspace workspace,
                        Vector baselineable)
                 throws WTException

Deprecated. at 8.0 Use EPMWorkspaceManager.addToWorkspace

Add the specified objects to the Workspace. If another item in theWorkspace has the same Master as the Baselineable, then the current item in the Workspace is replaced with this Baselineable. If the iteration is currently part of theWorkspace, then nothing occurs and no exception is thrown

Supported API: false

Parameters:

workspace - The workspace to be affected by the call.

baselineable -

Returns:

EPMWorkspace

Throws:

WTException

populateAll

public 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

public 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

public 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

getBaselineItems

public QueryResult getBaselineItems(EPMWorkspace workspace)
                             throws WTException

Deprecated. at R8.0. Use EPMWorkspaceManager.getObjectsInWorkspace

Get the set of objects included in the Checkpoint associated with the workspace.

Supported API: false

Parameters:

workspace - The workspace referenced by the call.

Returns:

QueryResult

Throws:

WTException

getRelatedItems

public 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

public 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

public 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

checkinOrMove

public QueryResult checkinOrMove(EPMWorkspace workspace,
                                 Vector objects)
                          throws WTException,
                                 WTPropertyVetoException

Deprecated. at R8.0. Use EPMWorkspaceManager.checkin

This operation takes a Vector of EPMDocuments and WTPartsobjects, and either checks them in (if they are checked out), or vaults them, by moving them to the DocFolder or PartFolder, as appropriate.

All of this is accomplished within the bounds of a transaction.

The result returned is the objects in their new locations.

Supported API: false

Parameters:

workspace -

objects -

Returns:

QueryResult

Throws:

WTException

WTPropertyVetoException

getAssociatedCheckpoint

public EPMCheckpoint getAssociatedCheckpoint(EPMWorkspace workspace)
                                      throws WTException

This gets the checkpoint associated with a Workspace.

Supported API: false

Parameters:

workspace -

Returns:

EPMCheckpoint

Throws:

WTException

getPartsAndDocs

public 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

public 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

public QueryResult refreshWorkspace(EPMWorkspace workspace,
                                    Vector baselineable)
                             throws WTException

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

Supported API: false

Parameters:

workspace -

baselineable -

Returns:

QueryResult

Throws:

WTException

refreshWorkspace

public 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

public 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

public 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

getNewObjects

public List getNewObjects(List objects,
                          boolean ignorePrivateIterations)
                   throws WTException

This method returns List of ObjectIdentifiers which are new in the given input list. A given WTPart or EPMDocument is new when 1. When it has no iterations in a shared folder. 2. It belongs to the workspace folder. Some applications allow iterations in personal folders. The flag IgnorePrivateIterations tell if we consider them. If, true, then private iterations are ignored. That means, if there is atleast one iteration in a shared folder, the object is old. Otherwise it is new (it should belong to workspace folder)irrespective of the number of iterations in private. If false, the object is flagged old, if more than one iteration exist irrespective of the folder. Otherwise if the object belongs to workspace folder, it is flagged as new.

Supported API: false

Parameters:

objects -

ignorePrivateIterations -

Returns:

List

Throws:

WTException

checkinOrMove

public QueryResult checkinOrMove(EPMWorkspace workspace,
                                 Vector objects,
                                 Vector familyTablesToCheckin)
                          throws WTException,
                                 WTPropertyVetoException

Deprecated. at R8.0. Use EPMWorkspaceManager.checkin

Supported API: false

Parameters:

workspace -

objects -

familyTablesToCheckin -

Returns:

QueryResult

Throws:

WTException

WTPropertyVetoException

undoCheckout

public Collection undoCheckout(EPMWorkspace workspace,
                               Collection objects,
                               Collection familyTablesToUndoCheckout)
                        throws WTException,
                               WTPropertyVetoException

Supported API: false

Parameters:

workspace -

objects -

familyTablesToUndoCheckout -

Returns:

Collection

Throws:

WTException

WTPropertyVetoException

getBaselines

public QueryResult getBaselines(EPMFamilyTable familyTable)
                         throws WTException

Supported API: false

Parameters:

familyTable -

Returns:

QueryResult

Throws:

WTException

getBaselines

public QueryResult getBaselines(EPMFamilyTable familyTable,
                                Class baselineClass)
                         throws WTException

Supported API: false

Parameters:

familyTable -

baselineClass -

Returns:

QueryResult

Throws:

WTException

getFTBaselineItems

public QueryResult getFTBaselineItems(Baseline baseline)
                               throws WTException

Supported API: false

Parameters:

baseline -

Returns:

QueryResult

Throws:

WTException

isInBaseline

public boolean isInBaseline(EPMFamilyTable familyTable,
                            Baseline baseline)
                     throws WTException

Supported API: false

Parameters:

familyTable -

baseline -

Returns:

boolean

Throws:

WTException

isAnyIterationInBaseline

public boolean isAnyIterationInBaseline(EPMFamilyTable familyTable,
                                        Baseline baseline)
                                 throws WTException

Supported API: false

Parameters:

familyTable -

baseline -

Returns:

boolean

Throws:

WTException

addToBaseline

public Baseline addToBaseline(Vector members,
                              Baseline baseline)
                       throws WTException

Deprecated.

Add family tables to a baseline.

Supported API: false

Parameters:

members -

baseline -

Returns:

Baseline

Throws:

WTException

removeFromBaseline

public Baseline removeFromBaseline(Vector members,
                                   Baseline baseline)
                            throws WTException

Deprecated.

Remove family tables from baseline

Supported API: false

Parameters:

members -

baseline -

Returns:

Baseline

Throws:

WTException

addMembers

public Baseline addMembers(Vector members,
                           Baseline baseline)
                    throws WTException

Deprecated.

Add family table members

Supported API: false

Parameters:

members -

baseline -

Returns:

Baseline

Throws:

WTException