com.ptc.windchill.uwgm.common.pdm
Class OutOfDateHelper

java.lang.Object
  com.ptc.windchill.uwgm.common.pdm.OutOfDateHelper

public class OutOfDateHelper

extends Object

Basically, a wrapper around EPMWorkspaceHelper.manager.getRefreshCandidates(), but digs up some additional useful information, such as the name of the user who created the "refresh candidate".

Nested Class Summary

private static class

OutOfDateHelper.Info Auxiliary data structure to keep collected information

Field Summary

private static OutOfDateHelper.Info	EMPTY_INFO
private WTKeyedMap	infoMap
private static Log	log
private boolean	useEPM
private WTPrincipal	user
private WTCollection	workables
private EPMWorkspace	ws

Constructor Summary

OutOfDateHelper(WTPrincipal user, EPMWorkspace ws, WTCollection workables)
Construct helper for a given set of PDM documents.

Method Summary

private OutOfDateHelper.Info	getInfo(Workable doc)
protected Map	getLatestObjects()
String	getModifiedBy(Workable doc)
Workable	getRefreshCandidate(Workable doc)
boolean	isModifiedByYou(Workable doc)
private void	populateLatestInfo()
private void	populateOODInfo()
private void	populateOODInfoEpm()
private void	retrieveLatestObjects(Class iterCl, ConfigSpec cs, Map latestMap)
private void	setInfo(Workable doc, Workable refreshCandidate)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static Log log

workables

private final WTCollection workables

user

private final WTPrincipal user

ws

private final EPMWorkspace ws

EMPTY_INFO

private static final OutOfDateHelper.Info EMPTY_INFO

infoMap

private WTKeyedMap infoMap

useEPM

private boolean useEPM

Constructor Detail

OutOfDateHelper

public OutOfDateHelper(WTPrincipal user,
                       EPMWorkspace ws,
                       WTCollection workables)

Construct helper for a given set of PDM documents.

Parameters:

user - WTPrincipal - current user

workables - Collection of EPMDocument or WTPart objects

Throws:

IllegalArgumentException - if any of the parameters is null

ClassCastException - if a member of the Collection is not Workable

Method Detail

getInfo

private OutOfDateHelper.Info getInfo(Workable doc)
                              throws WTException

Throws:

WTException

getModifiedBy

public String getModifiedBy(Workable doc)
                     throws WTException

Throws:

WTException

isModifiedByYou

public boolean isModifiedByYou(Workable doc)
                        throws WTException

Throws:

WTException

getRefreshCandidate

public Workable getRefreshCandidate(Workable doc)
                             throws WTException

Throws:

WTException

populateOODInfo

private void populateOODInfo()
                      throws WTException

Throws:

WTException

populateLatestInfo

private void populateLatestInfo()
                         throws WTException

Throws:

WTException

populateOODInfoEpm

private void populateOODInfoEpm()
                         throws WTException

Throws:

WTException

setInfo

private void setInfo(Workable doc,
                     Workable refreshCandidate)
              throws WTException

Throws:

WTException

getLatestObjects

protected Map getLatestObjects()
                        throws WTException

Throws:

WTException

retrieveLatestObjects

private void retrieveLatestObjects(Class iterCl,
                                   ConfigSpec cs,
                                   Map latestMap)
                            throws WTException

Throws:

WTException