com.ptc.windchill.esi.svc
Class ESIHelper

java.lang.Object
  com.ptc.windchill.esi.svc.ESIHelper

All Implemented Interfaces:

Externalizable, Serializable

public final class ESIHelper

extends Object

implements Externalizable

Provides access to the ESIService implementation and provides several generally useful utility methods.

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
static String	root Supported API: true
(package private) static long	serialVersionUID
static ESIService	service Supported API: true
static String	txAlias Supported API: true

Constructor Summary

ESIHelper()

Method Summary

static String	getTxStatusURL(String txUfid) Returns a URL HREF for the ESI transaction log GUI associated with the given transaction UFID.
static boolean	hasESITargets(Persistable anObject) Returns true if the given object has ESI target assignments.
static boolean	isOnWfProcess(LifeCycleManaged anObject) Returns true if ESI workflow is OPEN_RUNNING and, therefore, processing the given object.
static boolean	isReleaseNeeded(Persistable persistable) Returns true if the given object has not been released.
static boolean	isTxActive(Persistable obj) Returns true if a transaction is active for the supplied object.
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(ESIHelper thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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

root

public static final String root

Supported API: true

txAlias

public static final String txAlias

Supported API: true

service

public static final ESIService service

Supported API: true

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

ESIHelper

public ESIHelper()

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(ESIHelper 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

getTxStatusURL

public static String getTxStatusURL(String txUfid)

Returns a URL HREF for the ESI transaction log GUI associated with the given transaction UFID.

Supported API: false

Parameters:

txUfid - An UFID for ESITransaction object

Returns:

String

hasESITargets

public static boolean hasESITargets(Persistable anObject)
                             throws WTException

Returns true if the given object has ESI target assignments.

Supported API: false

Parameters:

anObject -

Returns:

boolean

Throws:

WTException

isOnWfProcess

public static boolean isOnWfProcess(LifeCycleManaged anObject)

Returns true if ESI workflow is OPEN_RUNNING and, therefore, processing the given object.

Supported API: false

Parameters:

anObject - The object whose status is to be evaluated.

Returns:

boolean

isReleaseNeeded

public static boolean isReleaseNeeded(Persistable persistable)

Returns true if the given object has not been released.

Supported API: false

Parameters:

persistable -

Returns:

boolean

isTxActive

public static boolean isTxActive(Persistable obj)
                          throws ESIException

Returns true if a transaction is active for the supplied object. NOTE: The supplied object does not need to be the root (primary) object in a transaction, simply one of the pending published objects in a transaction.

Supported API: false

Parameters:

obj -

Returns:

boolean

Throws:

ESIException