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

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

public class FamilyHelper

extends Object

This is a helper class.This class has methods to get familyObjects.It is a wrapper cclass over FamilyTableHelper. The user has to specify the inclusion critetia to get the family objects. By defalut the getFamilyObjects will also check if the retrieved object is in workspace or not. If the retrieved objectis not in workspace then it is not icluded by default. If the user of this class wants to use this class from outside the context of a workspace then he will have to setCheckInWorkspace to false explicitly If the inclusionCriteria is not specified then the default inclusion criteria will be INCLUDE_FAMILY

Field Summary

private boolean	checkInWorkspace
(package private) WTSet	docSet
private FamilyTableResult	familyResult
static int	INCLUDE_ALL_INSTANCES
static int	INCLUDE_FAMILY
static int	INCLUDE_GENERIC
static int	INCLUDE_INSTANCES
private int	inclusionCriteria
private static Log	log logging
static int	NONE
private WTCollection	reqObjects
private EPMWorkspace	workspace
private WorkspaceContent	wsContent

Constructor Summary

FamilyHelper(WTCollection actionObjects, EPMWorkspace workspace)

FamilyHelper(WTCollection actionObjects, EPMWorkspace workspace, int inclusionCriteria)

FamilyHelper(WTCollection actionObjects, EPMWorkspace workspace, int inclusionCriteria, boolean checkInWorkspace)

Method Summary

private void	addFamilyObjects()
private void	getFamilyInfo()
WTCollection	getFamilyObjects()
FamilyTableResult	getFamilyResult()
private void	includeAllInstances(EPMDocument epmDoc)
private void	includeFamily(EPMDocument epmDoc)
private void	includeGeneric(EPMDocument epmDoc)
private void	includeInstances(EPMDocument epmDoc)
private boolean	isInWorkspace(Persistable object, WorkspaceContent wsContent)
void	setCheckInWorkspace(boolean checkInWorkspace) sets the boolean checkInWorkspace.

Methods inherited from class java.lang.Object

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

Field Detail

reqObjects

private WTCollection reqObjects

docSet

WTSet docSet

workspace

private EPMWorkspace workspace

familyResult

private FamilyTableResult familyResult

checkInWorkspace

private boolean checkInWorkspace

NONE

public static final int NONE

See Also:

Constant Field Values

INCLUDE_INSTANCES

public static final int INCLUDE_INSTANCES

See Also:

Constant Field Values

INCLUDE_ALL_INSTANCES

public static final int INCLUDE_ALL_INSTANCES

See Also:

Constant Field Values

INCLUDE_GENERIC

public static final int INCLUDE_GENERIC

See Also:

Constant Field Values

INCLUDE_FAMILY

public static final int INCLUDE_FAMILY

See Also:

Constant Field Values

inclusionCriteria

private int inclusionCriteria

wsContent

private WorkspaceContent wsContent

log

private static Log log

logging

Constructor Detail

FamilyHelper

public FamilyHelper(WTCollection actionObjects,
                    EPMWorkspace workspace)
             throws WTException

FamilyHelper

public FamilyHelper(WTCollection actionObjects,
                    EPMWorkspace workspace,
                    int inclusionCriteria)
             throws WTException

FamilyHelper

public FamilyHelper(WTCollection actionObjects,
                    EPMWorkspace workspace,
                    int inclusionCriteria,
                    boolean checkInWorkspace)
             throws WTException

Method Detail

setCheckInWorkspace

public void setCheckInWorkspace(boolean checkInWorkspace)

sets the boolean checkInWorkspace. Its defalut value is true

getFamilyInfo

private void getFamilyInfo()
                    throws WTException

Throws:

WTException

addFamilyObjects

private void addFamilyObjects()
                       throws WTException

Throws:

WTException

includeAllInstances

private void includeAllInstances(EPMDocument epmDoc)
                          throws WTException

Throws:

WTException

includeFamily

private void includeFamily(EPMDocument epmDoc)
                    throws WTException

Throws:

WTException

includeGeneric

private void includeGeneric(EPMDocument epmDoc)
                     throws WTException

Throws:

WTException

includeInstances

private void includeInstances(EPMDocument epmDoc)
                       throws WTException

Throws:

WTException

isInWorkspace

private boolean isInWorkspace(Persistable object,
                              WorkspaceContent wsContent)

getFamilyObjects

public WTCollection getFamilyObjects()
                              throws WTException

Throws:

WTException

getFamilyResult

public FamilyTableResult getFamilyResult()