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

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static EffectivityService	service Supported API: false

Constructor Summary

EffectivityHelper()

Method Summary

void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EffectivityHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
static void	setConfigurationItem(Effectivity effectivity, ConfigurationItem configItem) Helper method for setting the Configuration Item for an Effectivity.
static void	setEffectivityTarget(Effectivity effectivity, EffectivityHolder effectivityHolder) Helper method for setting the target object for an Effectivity.
private static void	setStandardTarget(Effectivity effectivity, EffectivityHolder effectivityHolder) Helper method of setEffectivityTarget for setting the Effectivity target to an EffectivityHolder object.
private static void	setVersionedTarget(Effectivity effectivity, EffectivityManageable effectivityManageable) Helper method of setEffectivityTarget for setting the Effectivity target to an EffectivityManageable object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

service

public static final EffectivityService service

Supported API: false

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EffectivityHelper

public EffectivityHelper()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EffectivityHelper thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

setConfigurationItem

public static void setConfigurationItem(Effectivity effectivity,
                                        ConfigurationItem configItem)
                                 throws WTException,
                                        WTPropertyVetoException,
                                        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

EffectivityException

setEffectivityTarget

public static void setEffectivityTarget(Effectivity effectivity,
                                        EffectivityHolder effectivityHolder)
                                 throws WTException,
                                        WTPropertyVetoException,
                                        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

EffectivityException

setVersionedTarget

private static void setVersionedTarget(Effectivity effectivity,
                                       EffectivityManageable effectivityManageable)
                                throws WTPropertyVetoException,
                                       WTException

Helper method of setEffectivityTarget for setting the Effectivity target to an EffectivityManageable object. EffectivityManageable objects are Versioned.

Parameters:

effectivity - The Effectivity which will have its target set.

effectivityManageable - An EffectivityManageable object.

Throws:

WTException

WTPropertyVetoException

setStandardTarget

private static void setStandardTarget(Effectivity effectivity,
                                      EffectivityHolder effectivityHolder)
                               throws WTPropertyVetoException,
                                      WTException

Helper method of setEffectivityTarget for setting the Effectivity target to an EffectivityHolder object. EffectivityHolder objects are Persistable.

Parameters:

effectivity - The Effectivity which will have its target set.

Throws:

WTException

WTPropertyVetoException