wt.eff
Class EffGroup

java.lang.Object
  wt.eff.EffGroup

All Implemented Interfaces:

DisplayIdentification, Serializable

public class EffGroup

extends Object

implements DisplayIdentification, Serializable

An in-memory-only object used to encapsulate all the Effs associated with a given EffManagedVersion and EffContext for client interaction purposes (for example, if three effectivities exist for configuration item X and part 100 Rev A, these three effectivities will be represented as a range like "1-10, 12, 20-").

Supported API: true

Extendable: false

See Also:

EffGroupAssistant.getValidEffGroups(EffManagedVersion, EffContext), EffGroupAssistant.getValidEffGroups(EffContext), Serialized Form

Nested Class Summary

private static class

EffGroup.RangeSet

Field Summary

private ChangeActivityIfc	authorizedBy
private static String	CLASSNAME
private EffContext	effContext
private Class	effRange
private Class	effRangeType
private WTPrincipal	modifier
private Timestamp	modifyStamp
private EffGroup	predecessor
private String	range
private static String	RESOURCE
private EffGroup	successor
private EffManagedVersion	target
private Class	type

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

	EffGroup(Eff eff) Constructs a group based on the effectivity.
	EffGroup(Eff[] effs) Constructs a group based on the effectivities.
	EffGroup(EffContext an_EffContext, Class a_Type, String a_Range) Construct a group based on the provided values.
private	EffGroup(EffGroup successor, SortedMap effHistoryMap)
	EffGroup(EffManagedVersion a_Target, EffContext an_EffContext, Class a_Type, String a_Range) Constructs a group based on the provided values.

Method Summary

protected EffGroup	duplicate()
ChangeActivityIfc	getAuthorizedBy() Gets the object for the association that plays role: authorizedBy.
LocalizableMessage	getDisplayIdentifier() Returns a localizable message describing the identifier for the object.
DisplayIdentity	getDisplayIdentity() Supported API: false
LocalizableMessage	getDisplayType() Returns a localizable message describing the object's type.
EffContext	getEffContext() Gets the object for the association that plays role: effContext; The context the range applies to.
Class	getEffRange() Gets the value of the attribute: effRange; The EffRange class.
Class	getEffRangeType() Gets the value of the attribute: effRangeType; The type (String, Timestamp) represented in the range.
WTPrincipal	getModifier() Gets the object for the association that plays role: modifier.
Timestamp	getModifyStamp() Gets the value of the attribute: modifyStamp.
EffGroup	getPredecessor() Gets the object for the association that plays role: predecessor.
String	getRange() Gets the value of the attribute: range; The range representation of all the EffRanges (in each Eff) this EffGroup is standing in for.
EffGroup	getSuccessor() Gets the object for the association that plays role: successor.
EffManagedVersion	getTarget() Gets the object for the association that plays role: target; The target for this EffGroup.
Class	getType() Gets the value of the attribute: type; The Eff class.
void	setEffContext(EffContext a_EffContext) Sets the object for the association that plays role: effContext; The context the range applies to.
private void	setEffRangeClassAttrs()
void	setRange(String a_Range) Sets the value of the attribute: range; The range representation of all the EffRanges (in each Eff) this EffGroup is standing in for.
void	setTarget(EffManagedVersion a_Target) Sets the object for the association that plays role: target; The target for this EffGroup.
private void	targetValidate(EffManagedVersion a_Target)
private void	validateType(EffContext an_EffContext, Class a_Type)

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

range

private String range

type

private Class type

effRange

private Class effRange

effRangeType

private Class effRangeType

modifyStamp

private Timestamp modifyStamp

effContext

private EffContext effContext

target

private EffManagedVersion target

modifier

private WTPrincipal modifier

authorizedBy

private ChangeActivityIfc authorizedBy

predecessor

private EffGroup predecessor

successor

private EffGroup successor

Constructor Detail

EffGroup

public EffGroup(Eff eff)
         throws WTPropertyVetoException

Constructs a group based on the effectivity.

Supported API: true

Parameters:

eff -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(Eff[] effs)
         throws WTPropertyVetoException

Constructs a group based on the effectivities. Note that each effectivity should be of the same type and against the same context. Each start/end value will be applied to the range.

Supported API: true

Parameters:

effs -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(EffManagedVersion a_Target,
                EffContext an_EffContext,
                Class a_Type,
                String a_Range)
         throws WTPropertyVetoException

Constructs a group based on the provided values.

Supported API: true

Parameters:

a_Target -

an_EffContext -

a_Type -

a_Range -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(EffContext an_EffContext,
                Class a_Type,
                String a_Range)
         throws WTPropertyVetoException

Construct a group based on the provided values.

Supported API: true

Parameters:

an_EffContext -

a_Type -

a_Range -

Throws:

WTPropertyVetoException

EffGroup

private EffGroup(EffGroup successor,
                 SortedMap effHistoryMap)
          throws WTPropertyVetoException

Method Detail

getRange

public String getRange()

Gets the value of the attribute: range; The range representation of all the EffRanges (in each Eff) this EffGroup is standing in for.

Supported API: false

Returns:

String

setRange

public void setRange(String a_Range)
              throws WTPropertyVetoException

Sets the value of the attribute: range; The range representation of all the EffRanges (in each Eff) this EffGroup is standing in for.

Supported API: false

Parameters:

a_Range -

Throws:

WTPropertyVetoException

getType

public Class getType()

Gets the value of the attribute: type; The Eff class.

Supported API: false

Returns:

Class

getEffRange

public Class getEffRange()

Gets the value of the attribute: effRange; The EffRange class.

Supported API: false

Returns:

Class

getEffRangeType

public Class getEffRangeType()

Gets the value of the attribute: effRangeType; The type (String, Timestamp) represented in the range.

Supported API: false

Returns:

Class

getModifyStamp

public Timestamp getModifyStamp()

Gets the value of the attribute: modifyStamp.

Supported API: false

Returns:

Timestamp

getEffContext

public EffContext getEffContext()

Gets the object for the association that plays role: effContext; The context the range applies to.

Supported API: true

Returns:

EffContext

setEffContext

public void setEffContext(EffContext a_EffContext)
                   throws WTPropertyVetoException

Sets the object for the association that plays role: effContext; The context the range applies to.

Supported API: true

Parameters:

a_EffContext -

Throws:

WTPropertyVetoException

getTarget

public EffManagedVersion getTarget()

Gets the object for the association that plays role: target; The target for this EffGroup. Note that setting the target will cause the target's effVector to be appended; setting the target to null will remove it from the target's effVector. SEE THE OTHER ROLE.

Supported API: true

Returns:

EffManagedVersion

setTarget

public void setTarget(EffManagedVersion a_Target)
               throws WTPropertyVetoException

Sets the object for the association that plays role: target; The target for this EffGroup. Note that setting the target will cause the target's effVector to be appended; setting the target to null will remove it from the target's effVector. SEE THE OTHER ROLE.

Supported API: true

Parameters:

a_Target -

Throws:

WTPropertyVetoException

targetValidate

private void targetValidate(EffManagedVersion a_Target)
                     throws WTPropertyVetoException

Parameters:

a_Target -

Throws:

WTPropertyVetoException

getModifier

public WTPrincipal getModifier()

Gets the object for the association that plays role: modifier.

Supported API: false

Returns:

WTPrincipal

getAuthorizedBy

public ChangeActivityIfc getAuthorizedBy()

Gets the object for the association that plays role: authorizedBy.

Supported API: false

Returns:

ChangeActivityIfc

getPredecessor

public EffGroup getPredecessor()

Gets the object for the association that plays role: predecessor.

Supported API: true

Returns:

EffGroup

getSuccessor

public EffGroup getSuccessor()

Gets the object for the association that plays role: successor.

Supported API: true

Returns:

EffGroup

getDisplayType

public LocalizableMessage getDisplayType()

Returns a localizable message describing the object's type.

Supported API: false

Specified by:

getDisplayType in interface DisplayIdentification

Returns:

LocalizableMessage

getDisplayIdentifier

public LocalizableMessage getDisplayIdentifier()

Returns a localizable message describing the identifier for the object.

Supported API: false

Specified by:

getDisplayIdentifier in interface DisplayIdentification

Returns:

LocalizableMessage

getDisplayIdentity

public DisplayIdentity getDisplayIdentity()

Supported API: false

Specified by:

getDisplayIdentity in interface DisplayIdentification

Returns:

DisplayIdentity

validateType

private void validateType(EffContext an_EffContext,
                          Class a_Type)
                   throws WTPropertyVetoException

Throws:

WTPropertyVetoException

setEffRangeClassAttrs

private void setEffRangeClassAttrs()

duplicate

protected EffGroup duplicate()
                      throws WTException

Throws:

WTException