wt.configuration
Interface ConfigurationService

All Known Implementing Classes:

ConfigurationServiceFwd, StandardConfigurationService

public interface ConfigurationService

Supported API: true

Extendable: false

Method Summary

SerialNumberMapping	addMapping(SerialNumberedConfiguredInstanceVersion instance, PathOccurrence path, SerialNumberedInstanceIfc instanceToAllocate) Allocate this instanceToAllocate to this instance.
BaselineConfigurationOverride	addOverride(BaselineConfigurationVersion configuration, PathOccurrence path, ConfigurationManageable version) Add the version as an override for the given path.
BaselineConfigurationVersion	assignToConfiguration(BaselineConfigurationVersion configuration, ConfigurationManageable version) Assigns the given version to the configuration.
SerialNumberedConfiguredInstanceVersion	changeConfiguration(SerialNumberedConfiguredInstanceVersion instance, SerialNumberedBaselineConfigurationVersion configuration) Assign a different configuration to this instance.
QueryResult	getAll(BaselineConfigurationVersion configuration, boolean versionsOnly) Get all versions, normal and overrides, assigned to this configuration.
QueryResult	getAllConfigurations(ConfiguredMaster configuredMaster) Get all the configurations of this configured master.
QueryResult	getAllInstances(Configuration configuration) Return all the instances that are assigned to this configuration.
QueryResult	getAllInstances(ConfigurationManageable version) Get all the instances which use a configuration which configures this version.
QueryResult	getAllInstances(SerialNumbered serialNumbered) Get all instances of this serial numbered object.
QueryResult	getAllOverrides(BaselineConfigurationVersion configuration, boolean versionsOnly) Supported API: false
QueryResult	getConfigurations(ConfiguredVersion configuredVersion) Get the configurations of this configured version that configure it.
QueryResult	getConfigurationsAll(ConfigurationManageable version, boolean configurationsOnly) Get all the configurations this version is assigned to, as normal or override.
QueryResult	getConfigurationsNormal(ConfigurationManageable version) Get the configurations this version is assigned to.
QueryResult	getConfigurationsOverrides(ConfigurationManageable version, boolean configurationsOnly) Return the configurations this version is called out as an override in.
ConfiguredVersion	getConfiguredVersion(BaselineConfigurationVersion configuration) Get the version of the ConfiguredVersion assigned to this configuration, or null if one was not assigned.
Persistable	getConfiguredVersionOrMaster(BaselineConfigurationVersion configuration) Return the version of the ConfiguredVersion, if one is assigned to this configuration.
QueryResult	getIncorporatedInstances(ConfigurationManageable version, Timestamp incorporatedSince) Get all the incorporated instances which use a configuration which configures this version.
QueryResult	getIncorporatedInstances(SerialNumberedBaselineConfigurationVersion configuration, Timestamp incorporatedSince) Get all incorporated instances using this configuration.
QueryResult	getIncorporatedInstances(SerialNumberedConfiguredMaster serialNumbered, Timestamp incorporatedSince) Get all incorporated instances of this serial numbered object.
QueryResult	getMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered, Timestamp incorporated) Get all the instances of this serial numbered object that have been incorporated as of the given timestamp.
SerialNumberedConfiguredInstanceVersion	getMappedIntoInstance(SerialNumberedInstanceImpl serialNumbered, Timestamp incorporated) Get the instance, incorporated as of the given timestamp, that allocates this instance.
QueryResult	getNormal(BaselineConfigurationVersion configuration) Get all the versions assigned to this configuration.
ConfigurationManageable	getNormalVersion(BaselineConfigurationVersion configuration, Mastered master) Get the version, if any, that is assigned to this configuration.
QueryResult	getNormalVersions(BaselineConfigurationVersion configuration, QueryResult masters) Get the versions, if any, that are assigned to this configuration.
QueryResult	getOverrides(BaselineConfigurationVersion configuration, QueryResult pathOccurrences, boolean versionsOnly) Get all overrides in this configuration.
QueryResult	getOverrideVersions(BaselineConfigurationVersion configuration, Mastered master, boolean versionsOnly) Get all versions of this master, if any, that are assigned as overrides in this configuration.
QueryResult	getOverrideVersions(BaselineConfigurationVersion configuration, QueryResult masters, boolean versionsOnly) Get all versions of these masters, if any, that are assigned as overrides in this configuration.
QueryResult	getPlannedInstances(ConfigurationManageable version, Timestamp plannedFor) Get all the planned instances which use a configuration which configures this version.
QueryResult	getPlannedInstances(SerialNumberedBaselineConfigurationVersion configuration, Timestamp plannedFor) Get all planned instances using this configuration.
QueryResult	getPlannedInstances(SerialNumberedConfiguredMaster serialNumbered, Timestamp plannedFor) Get all planned instances of this serial numbered object.
QueryResult	getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf) Get all the instances that have not been allocated into another instance.
QueryResult	getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, QuerySpec instanceSpec) Get all the instances that have not been allocated into another instance.
SerialNumberedInstanceVersion	incorporate(SerialNumberedInstanceVersion instance, Timestamp incorporated) Incorporate this instance.
BaselineConfigurationVersion	populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Populates the configuration, starting at the configured version.
BaselineConfigurationVersion	populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfigurationManageable version) Populates the configuration, starting at the version.
BaselineConfigurationVersion	populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, Mastered master) Populates the configuration, starting at the master.
BaselineConfigurationVersion	removeFromConfiguration(BaselineConfigurationVersion configuration, ConfigurationManageable version) Removes the given version from the configuration Supported API: true
SerialNumberedConfiguredInstanceVersion	removeMapping(SerialNumberedConfiguredInstanceVersion instance, SerialNumberMapping mapping) Remove the allocation.
BaselineConfigurationVersion	removeOverride(BaselineConfigurationVersion configuration, BaselineConfigurationOverride override) Remove the override.
SerialNumberMapping	replaceMapping(SerialNumberMapping mapping, SerialNumberedInstanceIfc instanceToAllocate) Assign a different instance to this allocation.
BaselineConfigurationOverride	replaceVersionForOverride(BaselineConfigurationOverride override, ConfigurationManageable newVersion) Assign a different version to this override.
BaselineConfigurationVersion	repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Repopulate the configuration, starting at the configured version.
BaselineConfigurationVersion	repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfigurationManageable version) Repopulate the configuration, starting at the version.
BaselineConfigurationVersion	repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, Mastered master) Repopulate the configuration, starting at the master.
SerialNumberedInstanceVersion	setPlannedIncorporation(SerialNumberedInstanceVersion instance, Timestamp plannedIncorporation) Set the planned incorporation for this instance.
BaselineConfigurationVersion	storeNewConfiguration(BaselineConfigurationVersion configuration, ConfiguredMaster configurationFor) Stores the configuration.
BaselineConfigurationVersion	storeNewConfiguration(BaselineConfigurationVersion configuration, ConfiguredVersion configurationFor) Stores the configuration and adds the version (configurationFor) to it.
void	validateInstanceForIncorporation(SerialNumberedInstanceVersion instance, Timestamp incorporated) Validate this instance for incorporation.

Method Detail

storeNewConfiguration

public BaselineConfigurationVersion storeNewConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfiguredMaster configurationFor)
                                                   throws WTException

Stores the configuration. This API addresses the restriction that only one configuration master should exist for a given configured object. If one exists, it will use it. Otherwise, it'll create one.

Supported API: true

Parameters:

configuration -

configurationFor -

Returns:

BaselineConfigurationVersion

Throws:

WTException

storeNewConfiguration

public BaselineConfigurationVersion storeNewConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfiguredVersion configurationFor)
                                                   throws WTException

Stores the configuration and adds the version (configurationFor) to it. This API addresses the restriction that only one configuration master should exist for a given configured object. If one exists, it will use it. Otherwise, it'll create one.

Supported API: true

Parameters:

configuration -

configurationFor -

Returns:

BaselineConfigurationVersion

Throws:

WTException

assignToConfiguration

public BaselineConfigurationVersion assignToConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfigurationManageable version)
                                                   throws WTException

Assigns the given version to the configuration.

Supported API: true

Parameters:

configuration -

version -

Returns:

BaselineConfigurationVersion

Throws:

WTException

removeFromConfiguration

public BaselineConfigurationVersion removeFromConfiguration(BaselineConfigurationVersion configuration,
                                                            ConfigurationManageable version)
                                                     throws WTException

Removes the given version from the configuration

Supported API: true

Parameters:

configuration -

version -

Returns:

BaselineConfigurationVersion

Throws:

WTException

populateConfiguration

public BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfigSpec configSpec)
                                                   throws WTException

Populates the configuration, starting at the configured version. Note that populate does not replace versions already in the configuration.

Supported API: true

Parameters:

configuration -

configSpec -

Returns:

BaselineConfigurationVersion

Throws:

WTException

repopulateConfiguration

public BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration,
                                                            ConfigSpec configSpec)
                                                     throws WTException

Repopulate the configuration, starting at the configured version. The versions selected by the config spec will be added, replacing any versions already in the configuration.

Supported API: true

Parameters:

configuration -

configSpec -

Returns:

BaselineConfigurationVersion

Throws:

WTException

populateConfiguration

public BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfigSpec configSpec,
                                                          Mastered master)
                                                   throws WTException

Populates the configuration, starting at the master. Note that populate does not replace versions already in the configuration.

Supported API: true

Parameters:

configuration -

configSpec -

master -

Returns:

BaselineConfigurationVersion

Throws:

WTException

repopulateConfiguration

public BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration,
                                                            ConfigSpec configSpec,
                                                            Mastered master)
                                                     throws WTException

Repopulate the configuration, starting at the master. The versions selected by the config spec will be added, replacing any versions already in the configuration.

Supported API: true

Parameters:

configuration -

configSpec -

master -

Returns:

BaselineConfigurationVersion

Throws:

WTException

populateConfiguration

public BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration,
                                                          ConfigSpec configSpec,
                                                          ConfigurationManageable version)
                                                   throws WTException

Populates the configuration, starting at the version. Note that while populate does not generally replace versions already in the configuration, the version passed in is assumed to be the version the caller wants in the configuration, and will replace another version already in the configuration.

Supported API: true

Parameters:

configuration -

configSpec -

version -

Returns:

BaselineConfigurationVersion

Throws:

WTException

repopulateConfiguration

public BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration,
                                                            ConfigSpec configSpec,
                                                            ConfigurationManageable version)
                                                     throws WTException

Repopulate the configuration, starting at the version. The versions selected by the config spec will be added, replacing any versions already in the configuration. Note that the version passed in is added to the configuration, even if the config spec would not have selected it.

Supported API: true

Parameters:

configuration -

configSpec -

version -

Returns:

BaselineConfigurationVersion

Throws:

WTException

addOverride

public BaselineConfigurationOverride addOverride(BaselineConfigurationVersion configuration,
                                                 PathOccurrence path,
                                                 ConfigurationManageable version)
                                          throws WTException

Add the version as an override for the given path.

Supported API: true

Parameters:

configuration -

path -

version -

Returns:

BaselineConfigurationOverride

Throws:

WTException

removeOverride

public BaselineConfigurationVersion removeOverride(BaselineConfigurationVersion configuration,
                                                   BaselineConfigurationOverride override)
                                            throws WTException

Remove the override.

Supported API: true

Parameters:

configuration -

override -

Returns:

BaselineConfigurationVersion

Throws:

WTException

replaceVersionForOverride

public BaselineConfigurationOverride replaceVersionForOverride(BaselineConfigurationOverride override,
                                                               ConfigurationManageable newVersion)
                                                        throws WTException

Assign a different version to this override.

Supported API: true

Parameters:

override -

newVersion -

Returns:

BaselineConfigurationOverride

Throws:

WTException

addMapping

public SerialNumberMapping addMapping(SerialNumberedConfiguredInstanceVersion instance,
                                      PathOccurrence path,
                                      SerialNumberedInstanceIfc instanceToAllocate)
                               throws WTException

Allocate this instanceToAllocate to this instance.

Supported API: true

Parameters:

instance -

path -

instanceToAllocate -

Returns:

SerialNumberMapping

Throws:

WTException

removeMapping

public SerialNumberedConfiguredInstanceVersion removeMapping(SerialNumberedConfiguredInstanceVersion instance,
                                                             SerialNumberMapping mapping)
                                                      throws WTException

Remove the allocation.

Supported API: true

Parameters:

instance -

mapping -

Returns:

SerialNumberedConfiguredInstanceVersion

Throws:

WTException

replaceMapping

public SerialNumberMapping replaceMapping(SerialNumberMapping mapping,
                                          SerialNumberedInstanceIfc instanceToAllocate)
                                   throws WTException

Assign a different instance to this allocation.

Supported API: true

Parameters:

mapping -

instanceToAllocate -

Returns:

SerialNumberMapping

Throws:

WTException

changeConfiguration

public SerialNumberedConfiguredInstanceVersion changeConfiguration(SerialNumberedConfiguredInstanceVersion instance,
                                                                   SerialNumberedBaselineConfigurationVersion configuration)
                                                            throws WTException

Assign a different configuration to this instance.

Supported API: true

Parameters:

instance -

configuration -

Returns:

SerialNumberedConfiguredInstanceVersion

Throws:

WTException

setPlannedIncorporation

public SerialNumberedInstanceVersion setPlannedIncorporation(SerialNumberedInstanceVersion instance,
                                                             Timestamp plannedIncorporation)
                                                      throws WTException

Set the planned incorporation for this instance.

Supported API: true

Parameters:

instance -

plannedIncorporation -

Returns:

SerialNumberedInstanceVersion

Throws:

WTException

validateInstanceForIncorporation

public void validateInstanceForIncorporation(SerialNumberedInstanceVersion instance,
                                             Timestamp incorporated)
                                      throws WTException

Validate this instance for incorporation. This requires that the configuration be complete (all elements called out are configured), that all serial numbered objects called out have instances allocated, that all of these instances have an incorporated version (as of the date specified), and that the incorporation of this instance would not result in an allocated instance being allocated into more than one instance simultaneously.

Supported API: true

Parameters:

instance -

incorporated -

Throws:

WTException

incorporate

public SerialNumberedInstanceVersion incorporate(SerialNumberedInstanceVersion instance,
                                                 Timestamp incorporated)
                                          throws WTException

Incorporate this instance. Note, there is currently no mechanism to undo this if the user makes a mistake. The workaround is to create another version of the instance and incorporate it.

Supported API: true

Parameters:

instance -

incorporated -

Returns:

SerialNumberedInstanceVersion

Throws:

WTException

getConfiguredVersion

public ConfiguredVersion getConfiguredVersion(BaselineConfigurationVersion configuration)
                                       throws WTException

Get the version of the ConfiguredVersion assigned to this configuration, or null if one was not assigned.

Supported API: true

Parameters:

configuration -

Returns:

ConfiguredVersion

Throws:

WTException

getConfiguredVersionOrMaster

public Persistable getConfiguredVersionOrMaster(BaselineConfigurationVersion configuration)
                                         throws WTException

Return the version of the ConfiguredVersion, if one is assigned to this configuration. Otherwise, return the master.

Supported API: true

Parameters:

configuration -

Returns:

Persistable

Throws:

WTException

getConfigurationsNormal

public QueryResult getConfigurationsNormal(ConfigurationManageable version)
                                    throws WTException

Get the configurations this version is assigned to. Do not include any it is an override in.

Supported API: true

Parameters:

version -

Returns:

QueryResult

Throws:

WTException

getConfigurationsOverrides

public QueryResult getConfigurationsOverrides(ConfigurationManageable version,
                                              boolean configurationsOnly)
                                       throws WTException

Return the configurations this version is called out as an override in.

Supported API: true

Parameters:

version -

configurationsOnly -

Returns:

QueryResult

Throws:

WTException

getConfigurationsAll

public QueryResult getConfigurationsAll(ConfigurationManageable version,
                                        boolean configurationsOnly)
                                 throws WTException

Get all the configurations this version is assigned to, as normal or override.

Supported API: true

Parameters:

version -

configurationsOnly -

Returns:

QueryResult

Throws:

WTException

getNormal

public QueryResult getNormal(BaselineConfigurationVersion configuration)
                      throws WTException

Get all the versions assigned to this configuration. Do not include any overrides.

Supported API: true

Parameters:

configuration -

Returns:

QueryResult

Throws:

WTException

getOverrides

public QueryResult getOverrides(BaselineConfigurationVersion configuration,
                                QueryResult pathOccurrences,
                                boolean versionsOnly)
                         throws WTException

Get all overrides in this configuration.

Supported API: true

Parameters:

configuration -

pathOccurrences -

versionsOnly -

Returns:

QueryResult

Throws:

WTException

getAllOverrides

public QueryResult getAllOverrides(BaselineConfigurationVersion configuration,
                                   boolean versionsOnly)
                            throws WTException

Supported API: false

Parameters:

configuration -

versionsOnly -

Returns:

QueryResult

Throws:

WTException

getAll

public QueryResult getAll(BaselineConfigurationVersion configuration,
                          boolean versionsOnly)
                   throws WTException

Get all versions, normal and overrides, assigned to this configuration.

Supported API: true

Parameters:

configuration -

versionsOnly -

Returns:

QueryResult

Throws:

WTException

getNormalVersion

public ConfigurationManageable getNormalVersion(BaselineConfigurationVersion configuration,
                                                Mastered master)
                                         throws WTException

Get the version, if any, that is assigned to this configuration. Do not include overrides.

Supported API: true

Parameters:

configuration -

master -

Returns:

ConfigurationManageable

Throws:

WTException

getNormalVersions

public QueryResult getNormalVersions(BaselineConfigurationVersion configuration,
                                     QueryResult masters)
                              throws WTException

Get the versions, if any, that are assigned to this configuration. Do not include overrides.

Supported API: true

Parameters:

configuration -

masters -

Returns:

QueryResult

Throws:

WTException

getOverrideVersions

public QueryResult getOverrideVersions(BaselineConfigurationVersion configuration,
                                       Mastered master,
                                       boolean versionsOnly)
                                throws WTException

Get all versions of this master, if any, that are assigned as overrides in this configuration.

Supported API: true

Parameters:

configuration -

master -

versionsOnly -

Returns:

QueryResult

Throws:

WTException

getOverrideVersions

public QueryResult getOverrideVersions(BaselineConfigurationVersion configuration,
                                       QueryResult masters,
                                       boolean versionsOnly)
                                throws WTException

Get all versions of these masters, if any, that are assigned as overrides in this configuration.

Supported API: true

Parameters:

configuration -

masters -

versionsOnly -

Returns:

QueryResult

Throws:

WTException

getAllInstances

public QueryResult getAllInstances(Configuration configuration)
                            throws WTException

Return all the instances that are assigned to this configuration.

Supported API: true

Parameters:

configuration -

Returns:

QueryResult

Throws:

WTException

getPlannedInstances

public QueryResult getPlannedInstances(SerialNumberedBaselineConfigurationVersion configuration,
                                       Timestamp plannedFor)
                                throws WTException

Get all planned instances using this configuration.

Supported API: true

Parameters:

configuration -

plannedFor -

Returns:

QueryResult

Throws:

WTException

getIncorporatedInstances

public QueryResult getIncorporatedInstances(SerialNumberedBaselineConfigurationVersion configuration,
                                            Timestamp incorporatedSince)
                                     throws WTException

Get all incorporated instances using this configuration.

Supported API: true

Parameters:

configuration -

incorporatedSince -

Returns:

QueryResult

Throws:

WTException

getAllInstances

public QueryResult getAllInstances(SerialNumbered serialNumbered)
                            throws WTException

Get all instances of this serial numbered object.

Supported API: true

Parameters:

serialNumbered -

Returns:

QueryResult

Throws:

WTException

getPlannedInstances

public QueryResult getPlannedInstances(SerialNumberedConfiguredMaster serialNumbered,
                                       Timestamp plannedFor)
                                throws WTException

Get all planned instances of this serial numbered object.

Supported API: true

Parameters:

serialNumbered -

plannedFor -

Returns:

QueryResult

Throws:

WTException

getIncorporatedInstances

public QueryResult getIncorporatedInstances(SerialNumberedConfiguredMaster serialNumbered,
                                            Timestamp incorporatedSince)
                                     throws WTException

Get all incorporated instances of this serial numbered object.

Supported API: true

Parameters:

serialNumbered -

incorporatedSince -

Returns:

QueryResult

Throws:

WTException

getAllInstances

public QueryResult getAllInstances(ConfigurationManageable version)
                            throws WTException

Get all the instances which use a configuration which configures this version.

Supported API: true

Parameters:

version -

Returns:

QueryResult

Throws:

WTException

getPlannedInstances

public QueryResult getPlannedInstances(ConfigurationManageable version,
                                       Timestamp plannedFor)
                                throws WTException

Get all the planned instances which use a configuration which configures this version.

Supported API: true

Parameters:

version -

plannedFor -

Returns:

QueryResult

Throws:

WTException

getIncorporatedInstances

public QueryResult getIncorporatedInstances(ConfigurationManageable version,
                                            Timestamp incorporatedSince)
                                     throws WTException

Get all the incorporated instances which use a configuration which configures this version.

Supported API: true

Parameters:

version -

incorporatedSince -

Returns:

QueryResult

Throws:

WTException

getUnmappedInstances

public QueryResult getUnmappedInstances(SerialNumbered serialNumbered,
                                        Timestamp notIncorporatedByContextAsOf)
                                 throws WTException

Get all the instances that have not been allocated into another instance.

Supported API: true

Parameters:

serialNumbered -

notIncorporatedByContextAsOf -

Returns:

QueryResult

Throws:

WTException

getUnmappedInstances

public QueryResult getUnmappedInstances(SerialNumbered serialNumbered,
                                        Timestamp notIncorporatedByContextAsOf,
                                        QuerySpec instanceSpec)
                                 throws WTException

Get all the instances that have not been allocated into another instance. Use the query spec as a filter.

Supported API: true

Parameters:

serialNumbered -

notIncorporatedByContextAsOf -

instanceSpec -

Returns:

QueryResult

Throws:

WTException

getMappedInstances

public QueryResult getMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered,
                                      Timestamp incorporated)
                               throws WTException

Get all the instances of this serial numbered object that have been incorporated as of the given timestamp.

Supported API: true

Parameters:

serialNumbered -

incorporated -

Returns:

QueryResult

Throws:

WTException

getMappedIntoInstance

public SerialNumberedConfiguredInstanceVersion getMappedIntoInstance(SerialNumberedInstanceImpl serialNumbered,
                                                                     Timestamp incorporated)
                                                              throws WTException

Get the instance, incorporated as of the given timestamp, that allocates this instance.

Supported API: true

Parameters:

serialNumbered -

incorporated -

Returns:

SerialNumberedConfiguredInstanceVersion

Throws:

WTException

getConfigurations

public QueryResult getConfigurations(ConfiguredVersion configuredVersion)
                              throws WTException

Get the configurations of this configured version that configure it.

Supported API: true

Parameters:

configuredVersion -

Returns:

QueryResult

Throws:

WTException

getAllConfigurations

public QueryResult getAllConfigurations(ConfiguredMaster configuredMaster)
                                 throws WTException

Get all the configurations of this configured master.

Supported API: true

Parameters:

configuredMaster -

Returns:

QueryResult

Throws:

WTException