wt.effectivity
Class EffectivityServiceFwd

java.lang.Object
  wt.effectivity.EffectivityServiceFwd

All Implemented Interfaces:

EffectivityService, RemoteAccess, Serializable

public class EffectivityServiceFwd

extends Object

implements RemoteAccess, EffectivityService, Serializable

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: false

Extendable: false

See Also:

EffectivityHelper, EffService, Serialized Form

Field Summary

private static String	CLASSNAME
private static String	FC_RESOURCE
(package private) static boolean	SERVER

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

EffectivityServiceFwd()

Method Summary

ConfigurationItem	findConfigurationItem(String configItemName) Retrieve a Configuration Item by name.
QueryResult	getEffectivities(ConfigurationItem configItem) Retrieves the Effectivity objects which reference the given ConfigurationItem object.
QueryResult	getEffectivities(EffectivityHolder effectivityHolder) Retrieves the Effectivity objects for the given EffectivityHolder object.
private static Manager	getManager()
WTProductInstance	getWTProductInstance(String configItemName, String serialNumber) Returns the product instance for this configuration item and serial number, or null if it does not exist.
TransactionResult	persistEffectivityBatch(TransactionContainer aTran) Perform Insert, Modify, or Delete operations on any number of Effectivity objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER

static final boolean SERVER

FC_RESOURCE

private static final String FC_RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

EffectivityServiceFwd

public EffectivityServiceFwd()

Method Detail

getManager

private static Manager getManager()
                           throws WTException

Returns:

Manager

Throws:

WTException

getEffectivities

public QueryResult getEffectivities(EffectivityHolder effectivityHolder)
                             throws WTException

Retrieves the Effectivity objects for the given EffectivityHolder object.

Supported API: false

Specified by:

getEffectivities in interface EffectivityService

Parameters:

effectivityHolder - An object which implements the EffectivityHolder interface.

Returns:

QueryResult

Throws:

WTException

See Also:

Effectivity

persistEffectivityBatch

public TransactionResult persistEffectivityBatch(TransactionContainer aTran)
                                          throws WTException

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: false

Specified by:

persistEffectivityBatch in interface EffectivityService

Parameters:

aTran - A TransactionContainer containing any number of add, replace or delete assertions for Effectivity objects.

Returns:

TransactionResult

Throws:

WTException

See Also:

TransactionContainer

findConfigurationItem

public ConfigurationItem findConfigurationItem(String configItemName)
                                        throws WTException,
                                               ConfigItemNotFoundException

Retrieve a Configuration Item by name.

Supported API: false

Specified by:

findConfigurationItem in interface EffectivityService

Parameters:

configItemName - The name of the Configuration Item.

Returns:

ConfigurationItem

Throws:

WTException

ConfigItemNotFoundException

See Also:

ConfigurationItem

getEffectivities

public QueryResult getEffectivities(ConfigurationItem configItem)
                             throws WTException

Retrieves the Effectivity objects which reference the given ConfigurationItem object.

Supported API: false

Specified by:

getEffectivities in interface EffectivityService

Parameters:

configItem - A Configuration Item.

Returns:

QueryResult

Throws:

WTException

See Also:

Effectivity

getWTProductInstance

public WTProductInstance getWTProductInstance(String configItemName,
                                              String serialNumber)
                                       throws WTException

Returns the product instance for this configuration item and serial number, or null if it does not exist.

Supported API: false

Specified by:

getWTProductInstance in interface EffectivityService

Parameters:

configItemName -

serialNumber -

Returns:

WTProductInstance

Throws:

WTException