wt.eff
Class EffConfigSpecGroup

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.eff.EffConfigSpecGroup

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Notifiable, Ownable, ConfigSpec

public class EffConfigSpecGroup
extends Simple
implements ConfigSpec, Ownable, Externalizable

A container config spec allowing multiple PersistableEffConfigSpecs to be considered. It is currently used in WTPartEffectivityConfigSpec.appendSearchCriteria(wt.query.QuerySpec) when the user has not selected a specific type of config spec (i. e. Date, Serial or Lot), because this means there can be any of these config spec types and so there is a need for several config specs to be applied together. At one time it was thought that for a product structure, for example, with a lot of configuration items, this config spec could be used to navigate the entire structure by specifying a PersistableEffConfigSpec for each configuration item. Now it looks as though the 6.0 revamping of effectivity will make this usage unnecessary.

Use the newEffConfigSpecGroup static factory method(s), not the EffConfigSpecGroup constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

wt.part.WTpartEffectivityConfigSpec, appendSearchCriteria(wt.query.QuerySpec), process(wt.fc.QueryResult), Serialized Form

Field Summary

static String	VIEW Label for the attribute; The view to consider.
static String	VIEW_CONFIG_SPEC Label for the attribute; The ViewConfigSpec is used to append view-related information to the QuerySpec and process view-dependent objects in the result.

Method Summary

void	add(PersistableEffConfigSpec persistableEffConfigSpec) Adds an effectivity config spec to the group.
QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends the search criteria for each PersistableEffConfigSpec contained by this group, separating them with the OR operator.
void	clear() Removes all effectivity config specs from the group.
boolean	contains(PersistableEffConfigSpec persistableEffConfigSpec) Returns true if the effectivity config spec is in the group.
View	getView() Gets the value of the attribute: VIEW.
ViewConfigSpec	getViewConfigSpec() Gets the object for the association that plays role: VIEW_CONFIG_SPEC.
protected void	initialize(PersistableEffConfigSpec persistableEffConfigSpec) Supports initialization, following construction of an instance.
protected void	initialize(PersistableEffConfigSpec[] persistableEffConfigSpecs) Supports initialization, following construction of an instance.
protected void	initialize(View a_View) Supports initialization, following construction of an instance.
protected void	initialize(View a_View, PersistableEffConfigSpec persistableEffConfigSpec) Supports initialization, following construction of an instance.
protected void	initialize(View a_View, PersistableEffConfigSpec[] persistableEffConfigSpecs) Supports initialization, following construction of an instance.
static EffConfigSpecGroup	newEffConfigSpecGroup(PersistableEffConfigSpec persistableEffConfigSpec) Construct a group, adding the effectivity config spec.
static EffConfigSpecGroup	newEffConfigSpecGroup(PersistableEffConfigSpec[] persistableEffConfigSpecs) Constructs a group with the given members.
static EffConfigSpecGroup	newEffConfigSpecGroup(View a_View) Constructs an empty group set to the provided view.
static EffConfigSpecGroup	newEffConfigSpecGroup(View a_View, PersistableEffConfigSpec persistableEffConfigSpec) Construct a group, adding the effectivity config spec and assigning the view.
static EffConfigSpecGroup	newEffConfigSpecGroup(View a_View, PersistableEffConfigSpec[] persistableEffConfigSpecs) Constructs a group with the given members and view.
Enumeration	persistableEffConfigSpecs() Returns an enumeration of the effectivity config specs in the group.
QueryResult	process(QueryResult results) Returns the latest effective version for each master based on view.
boolean	remove(PersistableEffConfigSpec persistableEffConfigSpec) Removes an effectivity config spec from the group.
void	setView(View a_View) Sets the value of the attribute: VIEW.
void	setViewConfigSpec(ViewConfigSpec a_ViewConfigSpec) Sets the object for the association that plays role: VIEW_CONFIG_SPEC.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Detail

VIEW

public static final String VIEW

Label for the attribute; The view to consider.

Supported API: true

See Also:

Constant Field Values

VIEW_CONFIG_SPEC

public static final String VIEW_CONFIG_SPEC

Label for the attribute; The ViewConfigSpec is used to append view-related information to the QuerySpec and process view-dependent objects in the result.

Supported API: true

See Also:

Constant Field Values

Method Detail

getView

public View getView()
             throws ObjectNoLongerExistsException

Gets the value of the attribute: VIEW. The view to consider.

Supported API: true

Returns:

View

Throws:

ObjectNoLongerExistsException

setView

public void setView(View a_View)
             throws WTPropertyVetoException

Sets the value of the attribute: VIEW. The view to consider.

Supported API: true

Parameters:

a_View -

Throws:

WTPropertyVetoException

getViewConfigSpec

public ViewConfigSpec getViewConfigSpec()

Gets the object for the association that plays role: VIEW_CONFIG_SPEC. The ViewConfigSpec is used to append view-related information to the QuerySpec and process view-dependent objects in the result.

Supported API: true

Returns:

ViewConfigSpec

setViewConfigSpec

public void setViewConfigSpec(ViewConfigSpec a_ViewConfigSpec)
                       throws WTPropertyVetoException

Sets the object for the association that plays role: VIEW_CONFIG_SPEC. The ViewConfigSpec is used to append view-related information to the QuerySpec and process view-dependent objects in the result.

Supported API: true

Parameters:

a_ViewConfigSpec -

Throws:

WTPropertyVetoException

add

public void add(PersistableEffConfigSpec persistableEffConfigSpec)

Adds an effectivity config spec to the group.

Supported API: true

Parameters:

persistableEffConfigSpec -

remove

public boolean remove(PersistableEffConfigSpec persistableEffConfigSpec)

Removes an effectivity config spec from the group.

Supported API: true

Parameters:

persistableEffConfigSpec -

Returns:

boolean

contains

public boolean contains(PersistableEffConfigSpec persistableEffConfigSpec)

Returns true if the effectivity config spec is in the group.

Supported API: true

Parameters:

persistableEffConfigSpec -

Returns:

boolean

clear

public void clear()

Removes all effectivity config specs from the group.

Supported API: true

persistableEffConfigSpecs

public Enumeration persistableEffConfigSpecs()

Returns an enumeration of the effectivity config specs in the group.

Supported API: true

Returns:

Enumeration

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends the search criteria for each PersistableEffConfigSpec contained by this group, separating them with the OR operator.

Supported API: true

Specified by:

appendSearchCriteria in interface ConfigSpec

Parameters:

querySpec - A QuerySpec with a target class that is Iterated.

Returns:

QuerySpec

Throws:

WTException

QueryException

See Also:

QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException

Returns the latest effective version for each master based on view.

Supported API: true

Specified by:

process in interface ConfigSpec

Parameters:

results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.

Returns:

QueryResult

Throws:

WTException

See Also:

QueryResult, Iterated

newEffConfigSpecGroup

public static EffConfigSpecGroup newEffConfigSpecGroup(PersistableEffConfigSpec persistableEffConfigSpec)
                                                throws WTException

Construct a group, adding the effectivity config spec.

Supported API: true

Parameters:

persistableEffConfigSpec -

Returns:

EffConfigSpecGroup

Throws:

WTException

initialize

protected void initialize(PersistableEffConfigSpec persistableEffConfigSpec)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

persistableEffConfigSpec -

Throws:

WTException

newEffConfigSpecGroup

public static EffConfigSpecGroup newEffConfigSpecGroup(PersistableEffConfigSpec[] persistableEffConfigSpecs)
                                                throws WTException

Constructs a group with the given members.

Supported API: true

Parameters:

persistableEffConfigSpecs -

Returns:

EffConfigSpecGroup

Throws:

WTException

initialize

protected void initialize(PersistableEffConfigSpec[] persistableEffConfigSpecs)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

persistableEffConfigSpecs -

Throws:

WTException

newEffConfigSpecGroup

public static EffConfigSpecGroup newEffConfigSpecGroup(View a_View)
                                                throws WTException,
                                                       WTPropertyVetoException

Constructs an empty group set to the provided view.

Supported API: true

Parameters:

a_View -

Returns:

EffConfigSpecGroup

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(View a_View)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

a_View -

Throws:

WTException

WTPropertyVetoException

newEffConfigSpecGroup

public static EffConfigSpecGroup newEffConfigSpecGroup(View a_View,
                                                       PersistableEffConfigSpec persistableEffConfigSpec)
                                                throws WTException,
                                                       WTPropertyVetoException

Construct a group, adding the effectivity config spec and assigning the view.

Supported API: true

Parameters:

a_View -

persistableEffConfigSpec -

Returns:

EffConfigSpecGroup

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(View a_View,
                          PersistableEffConfigSpec persistableEffConfigSpec)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

a_View -

persistableEffConfigSpec -

Throws:

WTException

WTPropertyVetoException

newEffConfigSpecGroup

public static EffConfigSpecGroup newEffConfigSpecGroup(View a_View,
                                                       PersistableEffConfigSpec[] persistableEffConfigSpecs)
                                                throws WTException,
                                                       WTPropertyVetoException

Constructs a group with the given members and view.

Supported API: true

Parameters:

a_View -

persistableEffConfigSpecs -

Returns:

EffConfigSpecGroup

Throws:

WTException

WTPropertyVetoException

initialize

protected void initialize(View a_View,
                          PersistableEffConfigSpec[] persistableEffConfigSpecs)
                   throws WTException,
                          WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

a_View -

persistableEffConfigSpecs -

Throws:

WTException

WTPropertyVetoException