wt.epm.clients.relateditems
Class RelatedItemsSelector

java.lang.Object
  wt.epm.clients.relateditems.RelatedItemsSelector

Direct Known Subclasses:

DocCentricSelector, PartCentricSelector

public abstract class RelatedItemsSelector

extends Object

Nested Class Summary

static class	RelatedItemsSelector.IncludeType
static interface	RelatedItemsSelector.ItemInfo The RelatedItemsSelector class supports a caching mechanism based upon comma separated sets of character codes.

Field Summary

static RelatedItemsSelector.IncludeType	ASSOCIATED
static RelatedItemsSelector.IncludeType	DRAWING
static String	INCLUDE_DELIM
static RelatedItemsSelector.IncludeType	INSTANCE
static RelatedItemsSelector.IncludeType	OPTIONAL
static RelatedItemsSelector.IncludeType	REQUIRED
static RelatedItemsSelector.IncludeType	SECONDARY
static RelatedItemsSelector.IncludeType	SELECTED

Constructor Summary

RelatedItemsSelector()

Method Summary

IncludedAs	getIncludedAs(RelatedItemsSelector.ItemInfo itemInfo) Returns what this related item is included as (required dependent, related drawing, associated object, ...) given the options selected.
protected abstract IncludedAs	getIncludedAs(String code) Given a code that describes how this object is related to a selected object, return what this object is included as (required dependent, related drawing, associated object, ...).
protected boolean	isIncluded(RelatedItemsOption option, boolean requiresAll) Based upon the given option, returns whether to include or exclude the object.
boolean	isIncluded(RelatedItemsSelector.ItemInfo itemInfo) Returns whether or not this related item is included given the options selected.
protected IncludedAs	toIncludedAs(char code)
protected String	toString(EnumeratedType type)

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED

public static RelatedItemsSelector.IncludeType SELECTED

REQUIRED

public static RelatedItemsSelector.IncludeType REQUIRED

OPTIONAL

public static RelatedItemsSelector.IncludeType OPTIONAL

DRAWING

public static RelatedItemsSelector.IncludeType DRAWING

SECONDARY

public static RelatedItemsSelector.IncludeType SECONDARY

INSTANCE

public static RelatedItemsSelector.IncludeType INSTANCE

ASSOCIATED

public static RelatedItemsSelector.IncludeType ASSOCIATED

INCLUDE_DELIM

public static String INCLUDE_DELIM

Constructor Detail

RelatedItemsSelector

public RelatedItemsSelector()

Method Detail

isIncluded

public boolean isIncluded(RelatedItemsSelector.ItemInfo itemInfo)

Returns whether or not this related item is included given the options selected.

Returns:

whether or not this related item is included

getIncludedAs

public IncludedAs getIncludedAs(RelatedItemsSelector.ItemInfo itemInfo)

Returns what this related item is included as (required dependent, related drawing, associated object, ...) given the options selected.

Returns:

IncludedAs that describes what this related item is included as or null if the related item is not included

getIncludedAs

protected abstract IncludedAs getIncludedAs(String code)

Given a code that describes how this object is related to a selected object, return what this object is included as (required dependent, related drawing, associated object, ...).

Returns:

IncludedAs that describes what this object is included as or null if the object is not included

toIncludedAs

protected IncludedAs toIncludedAs(char code)

isIncluded

protected boolean isIncluded(RelatedItemsOption option,
                             boolean requiresAll)

Based upon the given option, returns whether to include or exclude the object. Depending upon how this object is related to a selected object, the given option may need to be set to ALL in order to include this object.

Returns:

true or false depending upon whether to include or exclude the object

toString

protected String toString(EnumeratedType type)