wt.configuration
Interface ConfigurationDelegate

All Known Implementing Classes:

WTProductConfigurationConfigurationDelegate

public interface ConfigurationDelegate

The configuration package defines the concept of a configuration and instances, but does not assert the definition of a structure. This delegate is used by the configuration package to provide the implementation details that define structure.

Supported API: true

Extendable: true

Method Summary

double	getLinkQuantity(OccurrenceableLink link) Return the quantity of the link.
QueryResult	getLinksConfiguringVersions(BaselineConfigurationConfigSpec configurationConfigSpec, QueryResult versions) Return the links calling out the versions passed.
QueryResult	getLinksToSerialNumberedObjects(BaselineConfigurationConfigSpec configurationConfigSpec) Return the links calling out serial numbered objects in this configuration.
Navigator	getNavigator(BaselineConfigurationVersion configuration, ConfigSpec configSpec) Returns the navigator used to populate a configuration.
QueryResult	getUnconfiguredElements(BaselineConfigurationConfigSpec configurationConfigSpec) Returns the unconfigured elements of the configuration.
QueryResult	getUnconfiguredVersionsOf(BaselineConfigurationConfigSpec configurationConfigSpec, QueryResult versions) For the versions passed, return those no longer called out by anything in the configuration.
void	validateAddToConfiguration(BaselineConfigurationVersion configuration, WTCollection configurationManageables) Validates whether or not the object can be added to the configuration, that is, whether or not it is called out by something else in the configuration.

Method Detail

getNavigator

public Navigator getNavigator(BaselineConfigurationVersion configuration,
                              ConfigSpec configSpec)
                       throws WTException

Returns the navigator used to populate a configuration.

Supported API: true

Parameters:

configuration -

configSpec -

Returns:

Navigator

Throws:

WTException

validateAddToConfiguration

public void validateAddToConfiguration(BaselineConfigurationVersion configuration,
                                       WTCollection configurationManageables)
                                throws WTException

Validates whether or not the object can be added to the configuration, that is, whether or not it is called out by something else in the configuration. For example, if part 200.A is passed, and it is not used by anything in this configuration, it is not in the product's structure and is invalid. Remember to check both normal and override versions!

Supported API: true

Parameters:

configuration -

configurationManageables -

Throws:

WTException

getUnconfiguredElements

public QueryResult getUnconfiguredElements(BaselineConfigurationConfigSpec configurationConfigSpec)
                                    throws WTException

Returns the unconfigured elements of the configuration. These are elements called out by configured versions for which there is no version in the configuration. For example, if part 100.A is in the configuration and uses part 200, but no version of 200 is in the configuration, 200 would be returned. Remember to include both normal and override versions!

Supported API: true

Parameters:

configurationConfigSpec -

Returns:

QueryResult

Throws:

WTException

getUnconfiguredVersionsOf

public QueryResult getUnconfiguredVersionsOf(BaselineConfigurationConfigSpec configurationConfigSpec,
                                             QueryResult versions)
                                      throws WTException

For the versions passed, return those no longer called out by anything in the configuration. Remember to include overrides in the check!

Supported API: true

Parameters:

configurationConfigSpec -

versions -

Returns:

QueryResult

Throws:

WTException

getLinksConfiguringVersions

public QueryResult getLinksConfiguringVersions(BaselineConfigurationConfigSpec configurationConfigSpec,
                                               QueryResult versions)
                                        throws WTException

Return the links calling out the versions passed.

Supported API: true

Parameters:

configurationConfigSpec -

versions -

Returns:

QueryResult

Throws:

WTException

getLinksToSerialNumberedObjects

public QueryResult getLinksToSerialNumberedObjects(BaselineConfigurationConfigSpec configurationConfigSpec)
                                            throws WTException

Return the links calling out serial numbered objects in this configuration.

Supported API: true

Parameters:

configurationConfigSpec -

Returns:

QueryResult

Throws:

WTException

getLinkQuantity

public double getLinkQuantity(OccurrenceableLink link)
                       throws WTException

Return the quantity of the link.

Supported API: true

Parameters:

link -

Returns:

double

Throws:

WTException