wt.vc.config
Interface ConfigService

All Known Implementing Classes:

ConfigServiceFwd, StandardConfigService

public interface ConfigService

This service helps obtain Iterated objects from Mastered objects (or a QuerySpec) and a ConfigSpec.

• Cookie: None
• Helper: ConfigHelper with several helper methods
• Service implementation: StandardConfigService with no listeners
• ServiceEvent: None
• ServiceException: ConfigException

Supported API: true

Extendable: true

Method Summary

QueryResult	filteredIterationsOf(Mastered master, ConfigSpec configSpec) Returns a QueryResult of Iterated objects that are related to the given Mastered object and are valid for the given ConfigSpec.
QueryResult	filteredIterationsOf(QueryResult masters, ConfigSpec configSpec) Returns a QueryResult of Iterated objects that are related to the given QueryResult of Mastered objects and are valid for the given ConfigSpec.
ConfigSpec	getConfigSpecFor(Iterated iteration) Supported API: false
ConfigSpec	getDefaultConfigSpecFor(Class masterOrIterationClass) Supported API: false
QueryResult	queryIterations(QuerySpec querySpec, ConfigSpec configSpec) Returns a QueryResult of Iterated objects that will be selcted by the given QuerySpec and are valid for the given ConfigSpec.

Method Detail

filteredIterationsOf

public QueryResult filteredIterationsOf(Mastered master,
                                        ConfigSpec configSpec)
                                 throws WTException,
                                        PersistenceException

Returns a QueryResult of Iterated objects that are related to the given Mastered object and are valid for the given ConfigSpec.

Supported API: true

Parameters:

master - The master to get the iterations for.

configSpec - The ConfigSpec to process this master's iterations against.

Returns:

QueryResult

Throws:

WTException

PersistenceException

filteredIterationsOf

public QueryResult filteredIterationsOf(QueryResult masters,
                                        ConfigSpec configSpec)
                                 throws WTException,
                                        PersistenceException

Returns a QueryResult of Iterated objects that are related to the given QueryResult of Mastered objects and are valid for the given ConfigSpec.

Supported API: true

Parameters:

masters - The QueryResult of masters to get the iterations for.

configSpec - The ConfigSpec to process the resulting iterations against.

Returns:

QueryResult

Throws:

WTException

PersistenceException

queryIterations

public QueryResult queryIterations(QuerySpec querySpec,
                                   ConfigSpec configSpec)
                            throws WTException,
                                   PersistenceException

Returns a QueryResult of Iterated objects that will be selcted by the given QuerySpec and are valid for the given ConfigSpec. Note that a QuerySpec is appended by the ConfigSpec's appendSearchCriteria. After the query, the query result is passed to the ConfigSpec's process API.

Supported API: true

Parameters:

querySpec - The QuerySpec based on iterations.

configSpec - The ConfigSpec to process the resulting iterations against.

Returns:

QueryResult

Throws:

WTException

PersistenceException

getConfigSpecFor

public ConfigSpec getConfigSpecFor(Iterated iteration)
                            throws WTException

Supported API: false

Parameters:

iteration -

Returns:

ConfigSpec

Throws:

WTException

getDefaultConfigSpecFor

public ConfigSpec getDefaultConfigSpecFor(Class masterOrIterationClass)
                                   throws WTException

Supported API: false

Parameters:

masterOrIterationClass -

Returns:

ConfigSpec

Throws:

WTException