wt.effectivity
Class EffectivityHelper

java.lang.Object
  wt.effectivity.EffectivityHelper

All Implemented Interfaces:

Externalizable, Serializable

public class EffectivityHelper
extends Object
implements Externalizable

This helper is used to access an implementation of EffectivityService via the static reference EffectivityHelper.service.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

static void	setConfigurationItem(wt.effectivity.Effectivity effectivity, ConfigurationItem configItem) Helper method for setting the Configuration Item for an Effectivity.
static void	setEffectivityTarget(wt.effectivity.Effectivity effectivity, wt.effectivity.EffectivityHolder effectivityHolder) Helper method for setting the target object for an Effectivity.

Methods inherited from class java.lang.Object

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

Method Detail

setConfigurationItem

public static void setConfigurationItem(wt.effectivity.Effectivity effectivity,
                                        ConfigurationItem configItem)
                                 throws WTException,
                                        WTPropertyVetoException,
                                        wt.effectivity.EffectivityException

Helper method for setting the Configuration Item for an Effectivity.

Supported API: true

Parameters:

effectivity - Any concrete subclass of Effectivity, or null. If null, the Effectivity will have no Configuration Item.

configItem - A configuration item.

Throws:

WTException

WTPropertyVetoException

wt.effectivity.EffectivityException

setEffectivityTarget

public static void setEffectivityTarget(wt.effectivity.Effectivity effectivity,
                                        wt.effectivity.EffectivityHolder effectivityHolder)
                                 throws WTException,
                                        WTPropertyVetoException,
                                        wt.effectivity.EffectivityException

Helper method for setting the target object for an Effectivity. If the target object is versioned, this method will set Effectivity.versionedTarget. If the target object is not versioned, the method will set Effectivity.standardTarget.

Supported API: true

Parameters:

effectivity - Any concrete subclass of Effectivity, or null. If null, the Effectivity will have no Configuration Item.

effectivityHolder - A configuration item.

Throws:

WTException

WTPropertyVetoException

wt.effectivity.EffectivityException