wt.eff
Interface EffService

All Known Implementing Classes:

EffServiceFwd, StandardEffService

public interface EffService

This service provides general effectivity functionality, both through its API and through listeners, that operate on EffManagedVersion, Eff, EffContext, EffConfigurationItem, ProductSolution and ProductInstance objects; this functionality can be reused by various implementations of effectivity including the reference implementation in wt.effectivity. EffConfigSpecAssistant and EffGroupAssistant also execute server-side actions for several classes of objects in this package.

The reference implementation of this service interface also manages effectivity data during various business operations via listeners defined in StandardEffService.

• Cookie: None
• Helper: EffHelper has helper methods
• Service implementation: StandardEffService (has listeners)
• ServiceEvent: None
• ServiceException: None

Supported API: true

Extendable: false

Method Summary

QueryResult	getAllContexts() Return all EffContext objects in the DB.
EffConfigurationItem	getEffConfigurationItem(String name) Returns the EffConfigurationItem that has this name.
Eff[]	getEffectivities(EffManagedVersion version, EffContext context, Class effType, boolean includeHistory) Returns a sorted array of Eff objects of the concrete type represented by the effType parameter, and related to the version and context parameters.
QueryResult	getEffs(EffManagedVersion version) For a given EffManagedVersion, return all Effs assigned to it.
QueryResult	getInstances(EffConfigurationItem configItem) Returns all ProductInstances for this EffConfigurationItem.
ProductSolution	getSolution(EffConfigurationItem effConfigurationItem) Gets the ProductSolution for this EffConfigurationItem, returning null if none exist.

Method Detail

getEffs

public QueryResult getEffs(EffManagedVersion version)
                    throws WTException

For a given EffManagedVersion, return all Effs assigned to it.

Supported API: true

Parameters:

version -

Returns:

QueryResult

Throws:

WTException

getAllContexts

public QueryResult getAllContexts()
                           throws WTException

Return all EffContext objects in the DB. The result is filtered by access control.

Supported API: true

Returns:

QueryResult

Throws:

WTException

getEffConfigurationItem

public EffConfigurationItem getEffConfigurationItem(String name)
                                             throws WTException

Returns the EffConfigurationItem that has this name. If none exists, returns null.

Supported API: true

Parameters:

name -

Returns:

EffConfigurationItem

Throws:

WTException

getSolution

public ProductSolution getSolution(EffConfigurationItem effConfigurationItem)
                            throws WTException

Gets the ProductSolution for this EffConfigurationItem, returning null if none exist. The solution is subject to access control.

Supported API: false

Parameters:

effConfigurationItem -

Returns:

ProductSolution

Throws:

WTException

getInstances

public QueryResult getInstances(EffConfigurationItem configItem)
                         throws WTException

Returns all ProductInstances for this EffConfigurationItem. The instances are subject to access control.

Supported API: true

Parameters:

configItem -

Returns:

QueryResult

Throws:

WTException

getEffectivities

public Eff[] getEffectivities(EffManagedVersion version,
                              EffContext context,
                              Class effType,
                              boolean includeHistory)
                       throws WTException

Returns a sorted array of Eff objects of the concrete type represented by the effType parameter, and related to the version and context parameters. The results are sorted in the order of creation of the Eff objects. Object reference attributes of the results are not expanded. This is an internal API to support ESI product functionality.

Supported API: false

Parameters:

version - EffManagedVersion object for which related Eff objects are to be retrieved -- may not be null

context - EffContext object for which related Eff objects are to be retrieved -- may be null to signify context-free (global) effectivity

effType - Class object representing the concrete type of the Eff objects in the result set: only Eff objects of this type will be returned -- may not be null and must represent a concrete implementation of the wt.eff.Eff interface

includeHistory - boolean value indicating whether the result should include factually deleted (i.e., historical) Eff objects

Returns:

Eff[]

Throws:

WTException