com.ptc.windchill.uwgm.proesrv.util
Class DependencyHelper

java.lang.Object
  com.ptc.windchill.uwgm.proesrv.util.DependencyHelper

public class DependencyHelper

extends Object

This is a helper class.This class has methods to get the new objects, checkedOut objects and checkedIn Objects. This class uses the FamilyHelper to get the family objects based on inclusionCriteria and creates collection of new objects, checkedOut objects and checkedIn Objects. If no inclusionCriteria is while constructing the instance of this class then family objects will not be included By default the family objects are included in context of workspace. If the user of this class intends to use this class outside the context of workspace, then the empty contructor should be used and appropriate set methods provided should be used. This class has methods to get the usagelinks and buildLinks

Field Summary

private WTCollection	checkedInObjects
private WTCollection	checkedOutObjects
private boolean	checkInWorkspace
private WTCollection	docSet
private FamilyTableResult	familyResult
private int	inclusionCriteria
private static Log	log logging
private WTCollection	newObjects
private WTPrincipal	principal
private WTCollection	reqObjects
private EPMWorkspace	workspace

Constructor Summary

DependencyHelper()

DependencyHelper(WTCollection reqObjects, EPMWorkspace workspace)

DependencyHelper(WTCollection reqObjects, EPMWorkspace workspace, WTPrincipal principal)

DependencyHelper(WTCollection reqObjects, EPMWorkspace workspace, WTPrincipal principal, int inclusionCriteria)

DependencyHelper(WTCollection reqObjects, EPMWorkspace workspace, WTPrincipal principal, int inclusionCriteria, boolean checkInWorkspace)

Method Summary

Collection	getActivelyAssociatedWTParts(WTCollection actionObjects) This method returns the Association WTParts of the collection of epmdocuments passed.
Collection	getBuildLinks(WTCollection actionObjects) This method returns the AssociationLinks of the collection of objects
WTCollection	getCheckedInObjects() Gets checkedInObjects
WTCollection	getCheckedOutObjects() Gets checkedOutObjects
FamilyTableResult	getFamilyResult()
static WTCollection	getIterationDependencies(WTCollection seeds, WTContainer container, ConfigSpec cs) This method returns the Required Dependents of the collection of objects
Collection	getLinks(WTCollection actionObjects) This method returns all the links (Association, memberlinks and usage links of the objects in collection)
WTCollection	getNewObjects() Gets ObjectsToDelete
Collection	getUsageLinks(WTCollection actionObjects) This method returns the UsageLinks ofthe collection of objects
void	processWorkables() Splits the supplied WTCollection of objects into newObjects, CheckedOutObjects and checkedInObjects
void	setCheckInWorkspace(boolean checkInWorkspace)
void	setCurrentWorkspace(EPMWorkspace workspace) Sets the currnt workspace
void	setParameters(WTCollection reqObjects, EPMWorkspace workspace, WTPrincipal principal)
void	setPrincipal(WTPrincipal principal) Sets the principal
void	setReqObjects(WTCollection reqObjects) Sets the action objects which are to be processed

Methods inherited from class java.lang.Object

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

Field Detail

reqObjects

private WTCollection reqObjects

newObjects

private WTCollection newObjects

checkedOutObjects

private WTCollection checkedOutObjects

checkedInObjects

private WTCollection checkedInObjects

docSet

private WTCollection docSet

workspace

private EPMWorkspace workspace

principal

private WTPrincipal principal

inclusionCriteria

private int inclusionCriteria

checkInWorkspace

private boolean checkInWorkspace

familyResult

private FamilyTableResult familyResult

log

private static Log log

logging

Constructor Detail

DependencyHelper

public DependencyHelper()

DependencyHelper

public DependencyHelper(WTCollection reqObjects,
                        EPMWorkspace workspace)
                 throws WTException

DependencyHelper

public DependencyHelper(WTCollection reqObjects,
                        EPMWorkspace workspace,
                        WTPrincipal principal)
                 throws WTException

DependencyHelper

public DependencyHelper(WTCollection reqObjects,
                        EPMWorkspace workspace,
                        WTPrincipal principal,
                        int inclusionCriteria)
                 throws WTException

DependencyHelper

public DependencyHelper(WTCollection reqObjects,
                        EPMWorkspace workspace,
                        WTPrincipal principal,
                        int inclusionCriteria,
                        boolean checkInWorkspace)
                 throws WTException

Method Detail

processWorkables

public void processWorkables()
                      throws WTException

Splits the supplied WTCollection of objects into newObjects, CheckedOutObjects and checkedInObjects

Throws:

WTException

getNewObjects

public WTCollection getNewObjects()

Gets ObjectsToDelete

getCheckedOutObjects

public WTCollection getCheckedOutObjects()

Gets checkedOutObjects

getCheckedInObjects

public WTCollection getCheckedInObjects()

Gets checkedInObjects

setCurrentWorkspace

public void setCurrentWorkspace(EPMWorkspace workspace)

Sets the currnt workspace

setPrincipal

public void setPrincipal(WTPrincipal principal)

Sets the principal

setReqObjects

public void setReqObjects(WTCollection reqObjects)

Sets the action objects which are to be processed

setParameters

public void setParameters(WTCollection reqObjects,
                          EPMWorkspace workspace,
                          WTPrincipal principal)

setCheckInWorkspace

public void setCheckInWorkspace(boolean checkInWorkspace)

getBuildLinks

public Collection getBuildLinks(WTCollection actionObjects)
                         throws WTException,
                                WTPropertyVetoException

This method returns the AssociationLinks of the collection of objects

Parameters:

actionObjects - WTCollection

Returns:

linkCollection Collection

Throws:

WTException, - WTPropertyVetoException

WTException

WTPropertyVetoException

getActivelyAssociatedWTParts

public Collection getActivelyAssociatedWTParts(WTCollection actionObjects)
                                        throws WTException,
                                               WTPropertyVetoException

This method returns the Association WTParts of the collection of epmdocuments passed.

Parameters:

actionObjects - WTCollection

Returns:

Collection of WTParts

Throws:

WTException, - WTPropertyVetoException

WTException

WTPropertyVetoException

getUsageLinks

public Collection getUsageLinks(WTCollection actionObjects)
                         throws WTException,
                                WTPropertyVetoException

This method returns the UsageLinks ofthe collection of objects

Parameters:

actionObjects - WTCollection

Returns:

usageLinkCollection Collection

Throws:

WTException, - WTPropertyVetoException

WTException

WTPropertyVetoException

getLinks

public Collection getLinks(WTCollection actionObjects)
                    throws WTException,
                           WTPropertyVetoException

This method returns all the links (Association, memberlinks and usage links of the objects in collection)

Parameters:

actionObjects - WTCollection

Returns:

links Collection

Throws:

WTException, - WTPropertyVetoException

WTException

WTPropertyVetoException

getIterationDependencies

public static WTCollection getIterationDependencies(WTCollection seeds,
                                                    WTContainer container,
                                                    ConfigSpec cs)
                                             throws WTPropertyVetoException,
                                                    WTException

This method returns the Required Dependents of the collection of objects

Parameters:

container - WTContainer

cs - ConfigSpec

Returns:

result WTCollection

Throws:

WTException, - WTPropertyVetoException

WTPropertyVetoException

WTException

getFamilyResult

public FamilyTableResult getFamilyResult()