Package wt.eff

Class EffGroup

java.lang.Object

wt.eff.EffGroup

All Implemented Interfaces:

Serializable, DisplayIdentification

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

Constructor Summary

Constructors

Constructor	Description
EffGroup(EffRecord effRecord)	Constructs a group based on the effectivity.
EffGroup(EffRecord[] effRecords, boolean populateAuditInfo)	Constructs a group based on the effectivities.
EffGroup(ObjectReference an_EffContext, Class a_Type, String a_Range)	Construct a group based on the provided values.
EffGroup(WTReference a_Target, WTReference effContextRef, Class a_Type, String a_Range)	Constructs a group based on the provided values.

Method Summary

Modifier and Type	Method	Description
EffContext	getEffContext()	Gets the object for the association that plays role: effContext; The context the range applies to.
EffGroup	getPredecessor()	Gets the object for the association that plays role: predecessor.
EffGroup	getSuccessor()	Gets the object for the association that plays role: successor.

Methods inherited from class java.lang.Object

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

Constructor Details

EffGroup

public EffGroup(EffRecord effRecord)
         throws WTPropertyVetoException

Constructs a group based on the effectivity.

Supported API: true

Parameters:

effRecord -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(EffRecord[] effRecords,
 boolean populateAuditInfo)
         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:

effRecords -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(WTReference a_Target,
 WTReference effContextRef,
 Class a_Type,
 String a_Range)
         throws WTPropertyVetoException

Constructs a group based on the provided values.

Supported API: true

Parameters:

a_Target -

effContextRef -

a_Type -

a_Range -

Throws:

WTPropertyVetoException

EffGroup

public EffGroup(ObjectReference 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

Method Details

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

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