Package wt.configuration
Interface ConfigurationService
- All Known Implementing Classes:
StandardConfigurationService
Provides an Application Programming Interface (API) for creating and editing
configurations and instances, as well as for retrieving the information about
these objects.
Supported API: true
Extendable: false
Supported API: true
Extendable: false
-
Method Summary
Modifier and TypeMethodDescriptionaddMapping(SerialNumberedConfiguredInstanceVersion instance, PathOccurrence path, SerialNumberedInstanceIfc instanceToAllocate) Allocate this instanceToAllocate to this instance.addOverride(BaselineConfigurationVersion configuration, PathOccurrence path, ConfigurationManageable version) Add the version as an override for the given path.assignToConfiguration(BaselineConfigurationVersion configuration, ConfigurationManageable version) Assigns the given version to the configuration.changeConfiguration(SerialNumberedConfiguredInstanceVersion instance, SerialNumberedBaselineConfigurationVersion configuration) Assign a different configuration to this instance.getAll(BaselineConfigurationVersion configuration, boolean versionsOnly) Get all versions, normal and overrides, assigned to this configuration.getAllConfigurations(ConfiguredMaster configuredMaster) Get all the configurations of this configured master.getAllInstances(Configuration configuration) Return all the instances that are assigned to this configuration.getAllInstances(ConfigurationManageable version) Get all the instances which use a configuration which configures this version.getAllInstances(SerialNumbered serialNumbered) Get all instances of this serial numbered object.getAllMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered) Returns the versions of the child instances allocated by this parent instance regardless of incorporation date.getAllMappedIntoInstances(SerialNumberedInstanceImpl serialNumbered) Returns all the versions of the parent instance(s) which allocate this child instance regardless of incorporation date.getConfigurations(ConfiguredVersion configuredVersion) Get the configurations of this configured version that configure it.getConfigurationsAll(ConfigurationManageable version, boolean configurationsOnly) Get all the configurations this version is assigned to, as normal or override.Get the configurations this version is assigned to.getConfigurationsOverrides(ConfigurationManageable version, boolean configurationsOnly) Return the configurations this version is called out as an override in.getConfiguredVersion(BaselineConfigurationVersion configuration) Get the version of the ConfiguredVersion assigned to this configuration, or null if one was not assigned.getConfiguredVersionOrMaster(BaselineConfigurationVersion configuration) Return the version of the ConfiguredVersion, if one is assigned to this configuration.getIncorporatedInstances(ConfigurationManageable version, Timestamp incorporatedSince) Get all the incorporated instances which use a configuration which configures this version.getIncorporatedInstances(SerialNumberedBaselineConfigurationVersion configuration, Timestamp incorporatedSince) Get all incorporated instances using this configuration.getIncorporatedInstances(SerialNumberedConfiguredMaster serialNumbered, Timestamp incorporatedSince) Get all incorporated instances of this serial numbered object.getMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered, Timestamp incorporated) Returns the versions of the child instances allocated by this parent instance according to the provided incorporated date.getMappedIntoInstance(SerialNumberedInstanceImpl serialNumbered, Timestamp incorporated) Get the instance, incorporated as of the given timestamp, that allocates this instance.getMappedIntoInstances(SerialNumberedInstanceImpl serialNumbered) Returns all the versions of the parent instance(s) which allocate this child instance and which were incorporated in the incorporated/unIncorporated range of this child instance.getNormal(BaselineConfigurationVersion configuration) Get all the versions assigned to this configuration.getNormalVersion(BaselineConfigurationVersion configuration, Mastered master) Get the version, if any, that is assigned to this configuration.getNormalVersions(BaselineConfigurationVersion configuration, QueryResult masters) Get the versions, if any, that are assigned to this configuration.getOverrides(BaselineConfigurationVersion configuration, QueryResult pathOccurrences, boolean versionsOnly) Get all overrides in this configuration.getOverrideVersions(BaselineConfigurationVersion configuration, QueryResult masters, boolean versionsOnly) Get all versions of these masters, if any, that are assigned as overrides in this configuration.getOverrideVersions(BaselineConfigurationVersion configuration, Mastered master, boolean versionsOnly) Get all versions of this master, if any, that are assigned as overrides in this configuration.getPlannedInstances(ConfigurationManageable version, Timestamp plannedFor) Get all the planned instances which use a configuration which configures this version.getPlannedInstances(SerialNumberedBaselineConfigurationVersion configuration, Timestamp plannedFor) Get all planned instances using this configuration.getPlannedInstances(SerialNumberedConfiguredMaster serialNumbered, Timestamp plannedFor) Get all planned instances of this serial numbered object.getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf) Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance.getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, SerialNumberedConfiguredInstanceVersion contextInstance) Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance.getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, SerialNumberedConfiguredInstanceVersion contextInstance, QuerySpec instanceSpec) Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance.getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, QuerySpec instanceSpec) Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance.incorporate(SerialNumberedInstanceVersion instance, Timestamp incorporated) Incorporate this instance.<T extends ConfigSpec>
BaselineConfigurationVersionpopulateBasicConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.<T extends ConfigSpec>
BaselineConfigurationVersionpopulateBasicConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, ConfiguredVersion topVersion) Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.populateBasicConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.populateBasicConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfiguredVersion topVersion) Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.<T extends ConfigSpec>
BaselineConfigurationVersionpopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) Populates the configuration, starting at the configured version.<T extends ConfigSpec>
BaselineConfigurationVersionpopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, ConfigurationManageable version) Populates the configuration, starting at the version.<T extends ConfigSpec>
BaselineConfigurationVersionpopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, Mastered master) Populates the configuration, starting at the master.populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Populates the configuration, starting at the configured version.populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfigurationManageable version) Populates the configuration, starting at the version.populateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, Mastered master) Populates the configuration, starting at the master.redoIncorporation(SerialNumberedInstanceVersion instance, Timestamp incorporated, Timestamp unIncorporated) Given an incorporated instance, this API will allow the user to reassign the incorporated/unIncorporated dates.removeFromConfiguration(BaselineConfigurationVersion configuration, ConfigurationManageable version) Removes the given version from the configuration
Supported API: trueremoveMapping(SerialNumberedConfiguredInstanceVersion instance, SerialNumberMapping mapping) Remove the allocation.removeOverride(BaselineConfigurationVersion configuration, BaselineConfigurationOverride override) Remove the override.replaceMapping(SerialNumberMapping mapping, SerialNumberedInstanceIfc instanceToAllocate) Assign a different instance to this allocation.replaceVersionForOverride(BaselineConfigurationOverride override, ConfigurationManageable newVersion) Assign a different version to this override.<T extends ConfigSpec>
BaselineConfigurationVersionrepopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) Repopulate the configuration, starting at the configured version.<T extends ConfigSpec>
BaselineConfigurationVersionrepopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, ConfigurationManageable version) Repopulate the configuration, starting at the version.<T extends ConfigSpec>
BaselineConfigurationVersionrepopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, Mastered master) Repopulate the configuration, starting at the master.repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Repopulate the configuration, starting at the configured version.repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfigurationManageable version) Repopulate the configuration, starting at the version.repopulateConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, Mastered master) Repopulate the configuration, starting at the master.setPlannedIncorporation(SerialNumberedInstanceVersion instance, Timestamp plannedIncorporation) Set the planned incorporation for this instance.storeNewConfiguration(BaselineConfigurationVersion configuration, ConfiguredMaster configurationFor) Stores the configuration.storeNewConfiguration(BaselineConfigurationVersion configuration, ConfiguredVersion configurationFor) Stores the configuration and adds the version (configurationFor) to it.voidvalidateInstanceForIncorporation(SerialNumberedInstanceVersion instance, Timestamp incorporated) Validate this instance for incorporation.
-
Method Details
-
storeNewConfiguration
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
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
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
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
-
populateBasicConfiguration
BaselineConfigurationVersion populateBasicConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec) throws WTException Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.
Supported API: true- Parameters:
configuration-configSpec-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateBasicConfiguration
BaselineConfigurationVersion populateBasicConfiguration(BaselineConfigurationVersion configuration, ConfigSpec configSpec, ConfiguredVersion topVersion) throws WTException Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths. If the top version is specified it will be used instead of the version selected by the config spec.
Supported API: true- Parameters:
configuration-configSpec-topVersion-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateBasicConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion populateBasicConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) throws WTException Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateBasicConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion populateBasicConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, ConfiguredVersion topVersion) throws WTException Populates a basic configuration, adding only the versions needed navigate paths to the traced children and creating those paths. If the top version is specified it will be used instead of the version selected by the config spec.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-topVersion-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateConfiguration
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
-
populateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) throws WTException Populates the configuration, starting at the configured version. Note that populate does not replace versions already in the configuration.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
repopulateConfiguration
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
-
repopulateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs) throws WTException Repopulate the configuration, starting at the configured version. The versions selected by the config specs will be added, replacing any versions already in the configuration.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateConfiguration
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
-
populateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, 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- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-master-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
repopulateConfiguration
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
-
repopulateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, Mastered master) throws WTException Repopulate the configuration, starting at the master. The versions selected by the config specs will be added, replacing any versions already in the configuration.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-master-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
populateConfiguration
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
-
populateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion populateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, 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- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-version-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
repopulateConfiguration
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
-
repopulateConfiguration
<T extends ConfigSpec> BaselineConfigurationVersion repopulateConfiguration(BaselineConfigurationVersion configuration, List<T> configSpecs, ConfigurationManageable version) throws WTException Repopulate the configuration, starting at the version. The versions selected by the config specs 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 specs would not have selected it.
Supported API: true- Type Parameters:
T- a sub-type of ConfigSpec- Parameters:
configuration-configSpecs-version-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
addOverride
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
BaselineConfigurationVersion removeOverride(BaselineConfigurationVersion configuration, BaselineConfigurationOverride override) throws WTException Remove the override.
Supported API: true- Parameters:
configuration-override-- Returns:
- BaselineConfigurationVersion
- Throws:
WTException
-
replaceVersionForOverride
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
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
SerialNumberedConfiguredInstanceVersion removeMapping(SerialNumberedConfiguredInstanceVersion instance, SerialNumberMapping mapping) throws WTException Remove the allocation.
Supported API: true- Parameters:
instance-mapping-- Returns:
- SerialNumberedConfiguredInstanceVersion
- Throws:
WTException
-
replaceMapping
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
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
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
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
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
-
redoIncorporation
SerialNumberedInstanceVersion redoIncorporation(SerialNumberedInstanceVersion instance, Timestamp incorporated, Timestamp unIncorporated) throws WTException Given an incorporated instance, this API will allow the user to reassign the incorporated/unIncorporated dates. The user may clear out the incorporated date or adjust it and, similarly, may clear out, set, or adjust the unIncorporated date. If the user changes the incorporated date, and there's another version unIncorporated at exactly the same time, the other version's unIncorporated date will be reassigned along with the incorporated date.This API will validate that the new dates don't overlap with other dates and don't violate the ranges parent instances call them out in. For example, if the parent -- incorporated as of 1/1/2006 -- calls out the child, the child can not change its incorporation to anything greater than 1/1/2006, as that would invalidate the parent.
NOTE: If you only want to adust one value and not both, you must pass in the original value -- (instance, newValue, instance.getUnIncorporated()) or (instance, instance.getIncorporated(), newValue).
Supported API: true- Parameters:
instance-incorporated-unIncorporated-- Returns:
- SerialNumberedInstanceVersion
- Throws:
WTException
-
getConfiguredVersion
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
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
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
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
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
Get all the versions assigned to this configuration. Do not include any overrides.
Supported API: true- Parameters:
configuration-- Returns:
- QueryResult
- Throws:
WTException
-
getOverrides
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
-
getAll
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
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
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
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
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
Return all the instances that are assigned to this configuration.
Supported API: true- Parameters:
configuration-- Returns:
- QueryResult
- Throws:
WTException
-
getPlannedInstances
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
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
Get all instances of this serial numbered object.
Supported API: true- Parameters:
serialNumbered-- Returns:
- QueryResult
- Throws:
WTException
-
getPlannedInstances
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
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
Get all the instances which use a configuration which configures this version.
Supported API: true- Parameters:
version-- Returns:
- QueryResult
- Throws:
WTException
-
getPlannedInstances
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
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
QueryResult getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf) throws WTException Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance.
Supported API: true- Parameters:
serialNumbered-notIncorporatedByContextAsOf-- Returns:
- QueryResult
- Throws:
WTException
-
getUnmappedInstances
QueryResult getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, SerialNumberedConfiguredInstanceVersion contextInstance) throws WTException Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance. If the context instance is not null, it will also retrieve instance masters which are allocated/mapped to instances of the same instance master as the given context instance, but not the context instance itself. To explain the context instance further, an instance master maybe allocated/mapped to an instance version and still be considered unallocated/unmapped with respect to another instance version of the same instance master. That is to say, maybe instance version A has it allocated/mapped, but instance version B does not have it allocated/mapped. We consider it allocated/mapped with respect to A and unallocated/unmapped with respect to B because they are of the same master.
Supported API: true- Parameters:
serialNumbered-notIncorporatedByContextAsOf-contextInstance-- Returns:
- QueryResult
- Throws:
WTException
-
getUnmappedInstances
QueryResult getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, QuerySpec instanceSpec) throws WTException Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance. Use the query spec as a filter.
Supported API: true- Parameters:
serialNumbered-notIncorporatedByContextAsOf-instanceSpec-- Returns:
- QueryResult
- Throws:
WTException
-
getUnmappedInstances
QueryResult getUnmappedInstances(SerialNumbered serialNumbered, Timestamp notIncorporatedByContextAsOf, SerialNumberedConfiguredInstanceVersion contextInstance, QuerySpec instanceSpec) throws WTException Get all the instance masters of the serial numbered object that have not been allocated/mapped into another instance. If the context instance is not null, it will also retrieve instance masters which are allocated/mapped to instances of the same instance master as the given context instance, but not the context instance itself. Use the query spec as a filter. To explain the context instance further, an instance master maybe allocated/mapped to an instance version and still be considered unallocated/unmapped with respect to another instance version of the same instance master. That is to say, maybe instance version A has it allocated/mapped, but instance version B does not have it allocated/mapped. We consider it allocated/mapped with respect to A and unallocated/unmapped with respect to B because they are of the same master.
Supported API: true- Parameters:
serialNumbered-notIncorporatedByContextAsOf-contextInstance-instanceSpec-- Returns:
- QueryResult
- Throws:
WTException
-
getMappedInstances
QueryResult getMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered, Timestamp incorporated) throws WTException Returns the versions of the child instances allocated by this parent instance according to the provided incorporated date. The parent version must be incorporated and must be incorporated before the passed in date (if given), or an empty QueryResult is passed. If a date is passed, this API will return the version for each allocated child instance that is incorporated as of the date specified. If the incorporated date is null, it will return all versions of the allocated child instances which were incorporated between the parent's incorporated and unIncorporated dates.
Supported API: true- Parameters:
serialNumbered-incorporated-- Returns:
- QueryResult
- Throws:
WTException
-
getAllMappedInstances
QueryResult getAllMappedInstances(SerialNumberedConfiguredInstanceVersion serialNumbered) throws WTException Returns the versions of the child instances allocated by this parent instance regardless of incorporation date. The instances returned have their configurations inflated.
Supported API: true- Parameters:
serialNumbered- Parent instance version.- Returns:
- QueryResult
- Throws:
WTException
-
getMappedIntoInstance
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
-
getMappedIntoInstances
Returns all the versions of the parent instance(s) which allocate this child instance and which were incorporated in the incorporated/unIncorporated range of this child instance.
Supported API: true- Parameters:
serialNumbered-- Returns:
- QueryResult
- Throws:
WTException
-
getAllMappedIntoInstances
Returns all the versions of the parent instance(s) which allocate this child instance regardless of incorporation date. The instances returned have their configurations inflated.
Supported API: true- Parameters:
serialNumbered- Child instance version.- Returns:
- QueryResult
- Throws:
WTException
-
getConfigurations
Get the configurations of this configured version that configure it.
Supported API: true- Parameters:
configuredVersion-- Returns:
- QueryResult
- Throws:
WTException
-
getAllConfigurations
Get all the configurations of this configured master.
Supported API: true- Parameters:
configuredMaster-- Returns:
- QueryResult
- Throws:
WTException
-