wt.epm.workspaces
Class EPMStandardBaselineService

java.lang.Object
  wt.services.StandardManager
      wt.epm.workspaces.EPMStandardBaselineService

All Implemented Interfaces:

EPMBaselineService, Manager, NetFactor, Serializable

public class EPMStandardBaselineService

extends StandardManager

implements EPMBaselineService, Serializable

Use the newEPMStandardBaselineService static factory method(s), not the EPMStandardBaselineService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Nested Class Summary

static class	EPMStandardBaselineService.FTCheckinOption
(package private) class	EPMStandardBaselineService.VectorFamilyTableOperation This class implements the abstract execute() method to add or remove a Vector of EPMFamilyTables items to a Baseline.

Field Summary

private static AuthoringAppDelegateFactory	authAppDelegateFactory
private static String	BASELINE_FOLDER
private static String	CHECKIN_MOVE_IN_PROGRESS
private static int	CHUNK_SIZE
private static String	CLASSNAME
private static String	EPMRESOURCE
static boolean	logTime
private static String	RESOURCE
private static String	USER_DISABLE_IN_PROGRESS
private static boolean	VERBOSE

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

EPMStandardBaselineService()

Method Summary

EPMWorkspace	add(EPMWorkspace workspace, Vector baselineable) Deprecated. at 8.0 Use EPMWorkspaceManager.addToWorkspace
protected boolean	add(Vector a_baselineFTMembers, Baseline a_baseline) Adds the Baselineable items to the Baseline.
Baseline	addMembers(Vector members, Baseline baseline) Deprecated.
Baseline	addToBaseline(Vector members, Baseline baseline) Deprecated.
protected static void	checkFamilyTablesOnPreCheckin(List objects)
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.
protected void	dispatchVetoableEvent(String a_eventType, List a_familyTables, Baseline a_baseline) This method dispatches a FamilyTableBaselineEvent.
protected void	dispatchVetoableEvent(String a_eventType, List a_familyTables, Baseline a_baseline, List a_replacedFamilyTables) This method dispatches a EPMFamilyTableBaselineEvent.
private QueryResult	filterIteratedPartialBaselines(QueryResult bms) This method is passed a query result containing BaselineMembers.
private EPMFamilyTableBaselineMember	find(EPMFamilyTable a_memberFT, Baseline a_baseline) Returns the BaselineMember object (if it exists) for the Baselineable and Baseline.
private EPMFamilyTableBaselineMember	findAnyFTIteration(EPMFamilyTable a_familyTable, Baseline a_baseline) Returns the BaselineMember object (if it exists) for the Baselineable and Baseline.
private QueryResult	findBaselineFTMembers(Class ftClass, long[] masterIds, Baseline a_baseline)
private List	findIfInWorkspaceFolder(HashMap masterToObject)
private List	findNewObjects(List objects, Class itrClass)
private List	findNewObjectsIgnorePrivateIterations(List objects, Class itrClass)
private void	findReplacements(Vector a_familyTables, Baseline a_baseline, ArrayList toAdd, ArrayList toReplace) Given a vector of BaselineMemberInfos, determine which are new to the baseline and which are replacements (another iteration with the same master already in the baseline).
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
private WTKeyedMap	getCheckpoints(WTCollection persistables)
String	getConceptualClassname() Deprecated.
private WTContainer	getContainer(EPMWorkspace workspace)
QueryResult	getFTBaselineItems(Baseline baseline) Supported API: false
private LocalizableMessageCollection	getNames(WTSet checkpoints)
List	getNewObjects(List objects, boolean ignorePrivateIterations) This method returns List of ObjectIdentifiers which are new in the given input list.
private WTSet	getOriginals(WTCollection targets)
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.
protected QueryResult	getRefreshDocsAndParts(EPMWorkspace workspace) Return a QueryResult of EPMDocuments and WTParts which represent the set of objects which need to be updated in the EPMWorkspace.
protected QueryResult	getRefreshDocsAndParts(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.
protected QueryResult	getRefreshPartsAndDocs(EPMWorkspace workspace) Return a QueryResult of EPMDocuments and WTParts which represent the set of objects which need to be updated in the EPMWorkspace.
protected QueryResult	getRefreshPartsAndDocs(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.
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.
private Vector	getWorkables(Collection objects, Map sortById) Given a list of objects and a map of ObjectIdentifier, CheckinOrMoveOption pairs, returns a vector of workable objects wrapped in CheckInOrMoveOption in the same order as given objects.
protected void	initialize() Supported API: false
boolean	isAnyIterationInBaseline(EPMFamilyTable familyTable, Baseline baseline) Supported API: false
boolean	isInBaseline(EPMFamilyTable familyTable, Baseline baseline) Supported API: false
static EPMStandardBaselineService	newEPMStandardBaselineService() Default factory for the class.
protected void	performStartupProcess() Overrides the startup process specific to the locking service to provide custom startup for event subscription.
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.
private void	processAsStoredConfigsOnPreMultiDelete(WTCollection targets)
private void	processConfigSpecsOnPreMultiDelete(WTCollection configSpecs)
protected static void	processFamilyTablesOnPostMultyCheckin()
private void	processPostCheckoutEvent(Workable object)
private void	processPostDeleteEvent(EPMWorkspace target)
private void	processPostDisableEvent(WTUser user) All the workspaces belonging to the user deleted will be purged and deleted.
private void	processPreDeleteEvent(Folder folder)
private void	processPreDeleteInWorkspace(WTCollection targets)
private void	processPreMarkForDeleteEvent(Project2 markedForDelete) Veto DeleteManagerEvent.PRE_MARK_FOR_DELETE if the markedForDelete object is a project that has at least one workspace.
private void	processPreModifyEvent(EPMWorkspace workspace)
protected void	processPreMultiDeleteEvent(WTCollection values)
private void	processPreStoreEvent(EPMWorkspace workspace)
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.
void	registerEvents(ManagerService manager) Overrides the registration of all applicable locking service events with the service manager.
EPMWorkspace	remove(EPMWorkspace workspace, Vector baselinable) Deprecated. at 8.0 Use EPMWorkspaceManager.removeFromWorkspace
protected boolean	remove(Vector a_baselineFTMembers, Baseline a_baseline) Removes the Baselineables from the Baseline.
Baseline	removeFromBaseline(Vector members, Baseline baseline) Deprecated.
private void	saveConfigSpecs(EPMWorkspace workspace)
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
protected QueryResult	updateDocsAndParts(EPMWorkspace workspace) Update the objects in the EPMWorkspace.
protected QueryResult	updateDocsAndParts(EPMWorkspace workspace, Vector baselineable) Update the objects given as parameters.
private Baseline	updateModificationTimestamp(Baseline a_baseline) Updates the modification timestamp on the Baseline object.
protected QueryResult	updatePartsAndDocs(EPMWorkspace workspace) Update the objects in the EPMWorkspace.
protected QueryResult	updatePartsAndDocs(EPMWorkspace workspace, Vector baselineable) Update the objects given as parameters.
QueryResult	updateWorkspace(EPMWorkspace workspace) Update the objects in the EPMWorkspace.
QueryResult	updateWorkspace(EPMWorkspace workspace, Vector baselineable) Update the objects given as parameters.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

EPMRESOURCE

private static final String EPMRESOURCE

See Also:

Constant Field Values

BASELINE_FOLDER

private static final String BASELINE_FOLDER

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

CHUNK_SIZE

private static int CHUNK_SIZE

authAppDelegateFactory

private static AuthoringAppDelegateFactory authAppDelegateFactory

CHECKIN_MOVE_IN_PROGRESS

private static final String CHECKIN_MOVE_IN_PROGRESS

See Also:

Constant Field Values

USER_DISABLE_IN_PROGRESS

private static final String USER_DISABLE_IN_PROGRESS

See Also:

Constant Field Values

logTime

public static boolean logTime

Constructor Detail

EPMStandardBaselineService

public EPMStandardBaselineService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

initialize

protected void initialize()
                   throws WTException

Supported API: false

Overrides:

initialize in class StandardManager

Throws:

WTException

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException

Overrides the startup process specific to the locking service to provide custom startup for event subscription. During subscription an anonymous inner class adapter is created per subscription to handle each specific event of interest.

Supported API: false

Overrides:

performStartupProcess in class StandardManager

Throws:

ManagerException

registerEvents

public void registerEvents(ManagerService manager)

Overrides the registration of all applicable locking service events with the service manager.

Supported API: false

Specified by:

registerEvents in interface Manager

Overrides:

registerEvents in class StandardManager

Parameters:

manager -

newEPMStandardBaselineService

public static EPMStandardBaselineService newEPMStandardBaselineService()
                                                                throws WTException

Default factory for the class.

Supported API: false

Returns:

EPMStandardBaselineService

Throws:

WTException

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

Specified by:

refresh in interface EPMBaselineService

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

Specified by:

update in interface EPMBaselineService

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

Specified by:

update in interface EPMBaselineService

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

Specified by:

remove in interface EPMBaselineService

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: false

Specified by:

populate in interface EPMBaselineService

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

Specified by:

add in interface EPMBaselineService

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: false

Specified by:

populateAll in interface EPMBaselineService

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: false

Specified by:

populateRequired in interface EPMBaselineService

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: false

Specified by:

copyToBaseline in interface EPMBaselineService

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

Specified by:

getBaselineItems in interface EPMBaselineService

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: false

Specified by:

getRelatedItems in interface EPMBaselineService

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: false

Specified by:

getStatus in interface EPMBaselineService

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: false

Specified by:

dispatchNewBaselineEvent in interface EPMBaselineService

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

Specified by:

checkinOrMove in interface EPMBaselineService

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

Specified by:

getAssociatedCheckpoint in interface EPMBaselineService

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: false

Specified by:

getPartsAndDocs in interface EPMBaselineService

Parameters:

baselineable -

workspace -

rule -

Returns:

QueryResult

Throws:

WTException

getRefreshPartsAndDocs

protected QueryResult getRefreshPartsAndDocs(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.

Supported API: false

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

getRefreshPartsAndDocs

protected QueryResult getRefreshPartsAndDocs(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.

Supported API: false

Parameters:

workspace -

baselineable -

Returns:

QueryResult

Throws:

WTException

updatePartsAndDocs

protected QueryResult updatePartsAndDocs(EPMWorkspace workspace)
                                  throws WTException

Update the objects in the EPMWorkspace. WTParts are considered first, and related EPMDocuments are updated or not as their associated WTPart.

Supported API: false

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

updatePartsAndDocs

protected QueryResult updatePartsAndDocs(EPMWorkspace workspace,
                                         Vector baselineable)
                                  throws WTException

Update the objects given as parameters. WTParts are considered first, and related EPMDocuments are updated or not as their associated WTPart.

Supported API: false

Parameters:

workspace -

baselineable -

Returns:

QueryResult

Throws:

WTException

getRefreshDocsAndParts

protected QueryResult getRefreshDocsAndParts(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 done using first the DocConfigSpec for EPMDocs, then the PartConfigSpec for WTParts

Supported API: false

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

getRefreshDocsAndParts

protected QueryResult getRefreshDocsAndParts(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 done using first the DocConfigSpec for EPMDocs, then the PartConfigSpec for WTParts

Supported API: false

Parameters:

workspace -

baselineable -

Returns:

QueryResult

Throws:

WTException

updateDocsAndParts

protected QueryResult updateDocsAndParts(EPMWorkspace workspace)
                                  throws WTException

Update the objects in the EPMWorkspace. Filtering is done using the DocConfigSpec for EPMDocs, then the PartConfigSpec for WTParts

Supported API: false

Parameters:

workspace -

Returns:

QueryResult

Throws:

WTException

updateDocsAndParts

protected QueryResult updateDocsAndParts(EPMWorkspace workspace,
                                         Vector baselineable)
                                  throws WTException

Update the objects given as parameters. Filtering is done using the DocConfigSpec for EPMDocs, then the PartConfigSpec for WTParts

Supported API: false

Parameters:

workspace -

baselineable -

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: false

Specified by:

createEPMAsStoredConfig in interface EPMBaselineService

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

Specified by:

refreshWorkspace in interface EPMBaselineService

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: false

Specified by:

refreshWorkspace in interface EPMBaselineService

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: false

Specified by:

updateWorkspace in interface EPMBaselineService

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: false

Specified by:

updateWorkspace in interface EPMBaselineService

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

Specified by:

getNewObjects in interface EPMBaselineService

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

Specified by:

checkinOrMove in interface EPMBaselineService

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

Specified by:

undoCheckout in interface EPMBaselineService

Parameters:

workspace -

objects -

familyTablesToUndoCheckout -

Returns:

Collection

Throws:

WTException

WTPropertyVetoException

getBaselines

public QueryResult getBaselines(EPMFamilyTable familyTable)
                         throws WTException

Supported API: false

Specified by:

getBaselines in interface EPMBaselineService

Parameters:

familyTable -

Returns:

QueryResult

Throws:

WTException

getBaselines

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

Supported API: false

Specified by:

getBaselines in interface EPMBaselineService

Parameters:

familyTable -

baselineClass -

Returns:

QueryResult

Throws:

WTException

getFTBaselineItems

public QueryResult getFTBaselineItems(Baseline baseline)
                               throws WTException

Supported API: false

Specified by:

getFTBaselineItems in interface EPMBaselineService

Parameters:

baseline -

Returns:

QueryResult

Throws:

WTException

isInBaseline

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

Supported API: false

Specified by:

isInBaseline in interface EPMBaselineService

Parameters:

familyTable -

baseline -

Returns:

boolean

Throws:

WTException

isAnyIterationInBaseline

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

Supported API: false

Specified by:

isAnyIterationInBaseline in interface EPMBaselineService

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

Specified by:

addToBaseline in interface EPMBaselineService

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

Specified by:

removeFromBaseline in interface EPMBaselineService

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

Specified by:

addMembers in interface EPMBaselineService

Parameters:

members -

baseline -

Returns:

Baseline

Throws:

WTException

findNewObjectsIgnorePrivateIterations

private List findNewObjectsIgnorePrivateIterations(List objects,
                                                   Class itrClass)
                                            throws WTException

Throws:

WTException

findNewObjects

private List findNewObjects(List objects,
                            Class itrClass)
                     throws WTException

Throws:

WTException

findIfInWorkspaceFolder

private List findIfInWorkspaceFolder(HashMap masterToObject)
                              throws WTException

Throws:

WTException

processPostCheckoutEvent

private void processPostCheckoutEvent(Workable object)
                               throws WTException

Throws:

WTException

processPreDeleteEvent

private void processPreDeleteEvent(Folder folder)
                            throws WTException

Throws:

WTException

processPreStoreEvent

private void processPreStoreEvent(EPMWorkspace workspace)
                           throws WTException

Throws:

WTException

processPreModifyEvent

private void processPreModifyEvent(EPMWorkspace workspace)
                            throws WTException

Throws:

WTException

processPostDeleteEvent

private void processPostDeleteEvent(EPMWorkspace target)
                             throws WTException

Throws:

WTException

checkFamilyTablesOnPreCheckin

protected static void checkFamilyTablesOnPreCheckin(List objects)
                                             throws WTException

Throws:

WTException

processFamilyTablesOnPostMultyCheckin

protected static void processFamilyTablesOnPostMultyCheckin()
                                                     throws WTException

Throws:

WTException

processPreMarkForDeleteEvent

private void processPreMarkForDeleteEvent(Project2 markedForDelete)
                                   throws WTException

Veto DeleteManagerEvent.PRE_MARK_FOR_DELETE if the markedForDelete object is a project that has at least one workspace.

Supported API: false

Throws:

WTException - thrown if project that has at least one workspace.

processPostDisableEvent

private void processPostDisableEvent(WTUser user)
                              throws WTException

All the workspaces belonging to the user deleted will be purged and deleted. The objects checked-out to the workspace will remain checked-out and the workspace sub-folder will not be deleted.

Throws:

WTException - thrown if any error occurs during workspace deletion.

getWorkables

private Vector getWorkables(Collection objects,
                            Map sortById)

Given a list of objects and a map of ObjectIdentifier, CheckinOrMoveOption pairs, returns a vector of workable objects wrapped in CheckInOrMoveOption in the same order as given objects.

saveConfigSpecs

private void saveConfigSpecs(EPMWorkspace workspace)
                      throws WTException

Throws:

WTException

getContainer

private WTContainer getContainer(EPMWorkspace workspace)
                          throws WTException

Throws:

WTException

dispatchVetoableEvent

protected void dispatchVetoableEvent(String a_eventType,
                                     List a_familyTables,
                                     Baseline a_baseline)
                              throws WTException

This method dispatches a FamilyTableBaselineEvent.

Supported API: true

Parameters:

a_eventType -

a_familyTables -

a_baseline -

Throws:

WTException

dispatchVetoableEvent

protected void dispatchVetoableEvent(String a_eventType,
                                     List a_familyTables,
                                     Baseline a_baseline,
                                     List a_replacedFamilyTables)
                              throws WTException

This method dispatches a EPMFamilyTableBaselineEvent.

Supported API: true

Parameters:

a_eventType -

a_familyTables -

a_baseline -

a_replacedFamilyTables -

Throws:

WTException

add

protected boolean add(Vector a_baselineFTMembers,
                      Baseline a_baseline)
               throws WTException

Adds the Baselineable items to the Baseline. If another item in the Baseline has the same Master as the Baselineable, then the current item in the Baseline is replaced with this Baselineable. If the iteration is currently part of the Baseline, then nothing occurs and no exception is thrown. If any of the items is added, then true is returned. PRE_ADD_BASELINE for all added objects is emitted followed by the corresponding POST_ADD_BASELINE. PRE_REPLACE_BASELINE for replaced objects is emitted followed by the corresponding POST_REPLACE_BASELINE. All baselineMemberInfos must be of the same type

Supported API: false

Parameters:

a_baseline -

Returns:

boolean

Throws:

WTException

remove

protected boolean remove(Vector a_baselineFTMembers,
                         Baseline a_baseline)
                  throws WTException

Removes the Baselineables from the Baseline. If the item is actually removed, then true is returned. The PRE_REMOVE_BASELINE and POST_REMOVE_BASELINE events are emitted.

Supported API: false

Parameters:

a_baselineFTMembers -

a_baseline -

Returns:

boolean

Throws:

WTException

findAnyFTIteration

private EPMFamilyTableBaselineMember findAnyFTIteration(EPMFamilyTable a_familyTable,
                                                        Baseline a_baseline)
                                                 throws WTException

Returns the BaselineMember object (if it exists) for the Baselineable and Baseline. A find query is made for any iteration of the Baselineable's Master is associated with this Baseline.

Parameters:

a_familyTable -

a_baseline -

Returns:

BaselineMember

Throws:

WTException

find

private EPMFamilyTableBaselineMember find(EPMFamilyTable a_memberFT,
                                          Baseline a_baseline)
                                   throws WTException

Returns the BaselineMember object (if it exists) for the Baselineable and Baseline. A find query is made for any iteration of the Baselineable's Master that is associated with this Baseline.

Parameters:

a_baseline -

Returns:

BaselineMember

Throws:

WTException

findReplacements

private void findReplacements(Vector a_familyTables,
                              Baseline a_baseline,
                              ArrayList toAdd,
                              ArrayList toReplace)
                       throws WTException

Given a vector of BaselineMemberInfos, determine which are new to the baseline and which are replacements (another iteration with the same master already in the baseline). If no iterations are found, the baselineMemberInfo will be added to toAdd vector. If an iteration is found in the baseline, an array consisting of the baselineMemberInfo, the iteration in the baseline, and the link will be added to toReplace.

Parameters:

a_familyTables -

a_baseline -

toAdd -

toReplace -

Throws:

WTException

findBaselineFTMembers

private QueryResult findBaselineFTMembers(Class ftClass,
                                          long[] masterIds,
                                          Baseline a_baseline)
                                   throws WTException

Throws:

WTException

updateModificationTimestamp

private Baseline updateModificationTimestamp(Baseline a_baseline)
                                      throws WTException

Updates the modification timestamp on the Baseline object.

Parameters:

a_baseline -

Returns:

Baseline

Throws:

WTException

filterIteratedPartialBaselines

private QueryResult filterIteratedPartialBaselines(QueryResult bms)
                                            throws WTException

This method is passed a query result containing BaselineMembers. For PartialIteratedBaselines, only those that are part of the latest iteration are considered to be part of the baseline. Return the baselines filtering out the PartialIteratedBaselines that do not fit that criteria.

Throws:

WTException

getCheckpoints

private WTKeyedMap getCheckpoints(WTCollection persistables)
                           throws WTException

Throws:

WTException

getNames

private LocalizableMessageCollection getNames(WTSet checkpoints)
                                       throws WTException

Throws:

WTException

processPreMultiDeleteEvent

protected void processPreMultiDeleteEvent(WTCollection values)
                                   throws WTException

Throws:

WTException

processPreDeleteInWorkspace

private void processPreDeleteInWorkspace(WTCollection targets)
                                  throws WTException

Throws:

WTException

processAsStoredConfigsOnPreMultiDelete

private void processAsStoredConfigsOnPreMultiDelete(WTCollection targets)
                                             throws WTException

Throws:

WTException

processConfigSpecsOnPreMultiDelete

private void processConfigSpecsOnPreMultiDelete(WTCollection configSpecs)
                                         throws WTException

Throws:

WTException

getOriginals

private WTSet getOriginals(WTCollection targets)
                    throws WTException

Throws:

WTException