Package wt.effectivity

Interface EffectivityService

@Deprecated @RemoteInterface public interface EffectivityService
Deprecated.
use EffService
Most of the APIs represented in this service are available in the wt.eff package in EffService, EffGroupAssistant or EffConfigSpecAssistant and since the eff package's APIs are easier to use, they are recommended.
  • Cookie: None
  • Helper: EffectivityHelper
  • Service implementation: StandardEffectivityService (no listeners)
  • ServiceEvent: None
  • ServiceException: EffectivityException, ConfigItemNotFoundException
Identifies the client accessable, static, effectivity operations that execute in the method server. These client accessable , static, methods are invoked through the following syntax: 
 EffectivityHelper.service.[method]


Supported API: true

Extendable: false
See Also:

  • Method Details

    • getEffectivities

      QueryResult getEffectivities(EffectivityHolder effectivityHolder) throws WTException
      Deprecated.
      Retrieves the Effectivity objects for the given EffectivityHolder object.

      Supported API: true
      Parameters:
      effectivityHolder - An object which implements the EffectivityHolder interface.
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • persistEffectivityBatch

      TransactionResult persistEffectivityBatch(TransactionContainer aTran) throws WTException
      Deprecated.
      Perform Insert, Modify, or Delete operations on any number of Effectivity objects. The passed TransactionContainer will contain a add, delete, or replace assertion for each Effectivity object. Below is example code for setting up a TransactionContainer to pass to this method: 
       TransactionContainer effectivityTransaction = BatchContainerFactory.instantiateTransactionContainer();

 BatchContainer mainBatchContainer = BatchContainerFactory.instantiateGeneralBatchContainer(effectivityTransaction,
 "main");

 // Create a new Serial Numbered Effectivity
 mainBatchContainer.add(aSerialNumberedEffectivity);

 // Modify an existing Lot Effectivity
 mainBatchContainer.replace(aLotEffectivity);

 // Delete an existing Dated Effectivity
 mainBatchContainer.populate(aDatedEffectivity);
 mainBatchContainer.remove(aDatedEffectivity);


      Supported API: true
      Parameters:
      aTran - A TransactionContainer containing any number of add, replace or delete assertions for Effectivity objects.
      Returns:
      TransactionResult
      Throws:
      WTException
      See Also:

    • findConfigurationItem

      ConfigurationItem findConfigurationItem(String configItemName) throws WTException, ConfigItemNotFoundException
      Deprecated.
      Retrieve a Configuration Item by name.

      Supported API: true
      Parameters:
      configItemName - The name of the Configuration Item.
      Returns:
      ConfigurationItem
      Throws:
      WTException
      ConfigItemNotFoundException
      See Also:

    • getEffectivities

      QueryResult getEffectivities(ConfigurationItem configItem) throws WTException
      Deprecated.
      Retrieves the Effectivity objects which reference the given ConfigurationItem object.

      Supported API: true
      Parameters:
      configItem - A Configuration Item.
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • getWTProductInstance

      WTProductInstance getWTProductInstance(String configItemName, String serialNumber) throws WTException
      Deprecated.
      Returns the product instance for this configuration item and serial number, or null if it does not exist.

      Supported API: true
      Parameters:
      configItemName -
      serialNumber -
      Returns:
      WTProductInstance
      Throws:
      WTException