Interface EffectivityItemInterface

The EffectivityItemInterface is a requirement used for the configuration system.

The configuration system is explained in the configurations.

The EffectivityItemInterface is included in the EffectivitiesInterface, and tells a requirement that must or must not be satisfied in order for a part instance to be included in a configuration.

The EffectivityItemInterface tells the attribute name and the accepted/rejected values that a document must feature in order to be accepted/rejected.

/** 
* Sample to illustrate the change of configuration in the ConfContextInterface.
*/
import { ConfContextInterface, DataSessionInterface, ConfigurationInterface } from 'generated/documentation/appinfiniteapi';

// the DataSessionInterface has been created previously and is connected
let lDataSession : DataSessionInterface;
// create a ConfContextInterface
const lConfContext : ConfContextInterface = lDataSession.createConfContext();
// retrieve the list of available configurations
const lActiveConfs : Array<ConfigurationInterface> = lDataSession.getConfigurationList();
// we will take the first ConfigurationInterface for this context
const lConfs : Array<string> = new Array<string>(1);
lConfs[0] = lActiveConfs[0].getConfigurationId();
console.log('Using the configuration ' + lActiveConfs[0].getName() + ' : ' + lActiveConfs[0].getDescription())
// set the active confs
lConfContext.setActiveConfs(lConfs);
// and ask to compute all changes requested since the last call to the DataSessionInterface
lDataSession.update();

Please refer to the Configuration System.
Metadata

See

Hierarchy

  • EffectivityItemInterface

Methods

  • Gets the attribute name of the requirement.

    Returns

    The attribute name of the requirement.

    Returns string

  • Gets the accepted/rejected values of the requirement.

    Such a list is sorted by values.

    DO NOT modify the returned string [].

    Returns

    const
    The accepted/rejected values of the requirement.

    Returns string[]