com.ptc.windchill.esi.utl
Class ESIPropertyRequest

java.lang.Object
  com.ptc.windchill.esi.utl.ESIPropertyRequest

All Implemented Interfaces:

Externalizable, Serializable

public final class ESIPropertyRequest

extends Object

implements Externalizable

This class abstracts and consolidates all of the ESI property requests so that property consumers all get the same property name and have consistent default values.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static ESIPropertyRequest	ADMIN_USER
static ESIPropertyRequest	AIG_ENABLED
static ESIPropertyRequest	ALTERNATE_LINK_MAP
static ESIPropertyRequest	ALTERNATE_QUERY_TASK
static ESIPropertyRequest	BOM_CLASS
static ESIPropertyRequest	BOM_COMPONENT_MAP
static ESIPropertyRequest	BOM_COMPONENT_RENDERER
static ESIPropertyRequest	BOM_HEADER_MAP
static ESIPropertyRequest	BOM_HEADER_RENDERER
static ESIPropertyRequest	BOM_ORG_FILTER
static ESIPropertyRequest	BOM_RENDERER
static ESIPropertyRequest	BOM_TREE_NAVIGATOR
static ESIPropertyRequest	BOM_TREE_NAVIGATOR_FACTORY
static ESIPropertyRequest	BOM_TREEQUERY_TASK
static ESIPropertyRequest	CHANGE_ACTIVITY_FACTORY
static ESIPropertyRequest	CHANGE_ORDER_FACTORY
static ESIPropertyRequest	CHANGE_REQUEST_FACTORY
static ESIPropertyRequest	CHECK_ITERATION
private static String	CLASSNAME
static ESIPropertyRequest	CONFIGSPEC_STATE
private String	defaultValue
static ESIPropertyRequest	DOCUMENT_CLASS
static ESIPropertyRequest	DOCUMENT_DESCLINK_CLASS
static ESIPropertyRequest	DOCUMENT_LINK_MAP
static ESIPropertyRequest	DOCUMENT_MAP
static ESIPropertyRequest	DOCUMENT_QUERY_TASK
static ESIPropertyRequest	DOCUMENT_REFLINK_CLASS
static ESIPropertyRequest	DOCUMENT_RENDERER_CLASS
static ESIPropertyRequest	ECN_CHANGE_HEADER_RENDERER
static ESIPropertyRequest	ECN_CHANGE_ORDER2_RENDERER
static ESIPropertyRequest	ECN_HEADER_MAP
static ESIPropertyRequest	ECN_QUERY_TASK
static ESIPropertyRequest	EFECTIVITY_HANDLER
static ESIPropertyRequest	EFFECTIVITY_CLASS
static ESIPropertyRequest	ENFORCE_LINE_NUMBERS
static ESIPropertyRequest	ENFORCE_ORGS
static ESIPropertyRequest	EPMBUILDHISTORY_CLASS
static ESIPropertyRequest	EPMDOCUMENT_CLASS
static ESIPropertyRequest	EPMDOCUMENTLINK_CLASS
static ESIPropertyRequest	ESITARGET_MAPFILE
static ESIPropertyRequest	EVENT_AUTO_GENERATE_ECN
static ESIPropertyRequest	EVENT_ECN_FACTORY
static ESIPropertyRequest	EVENT_ECN_VALIDATOR
static ESIPropertyRequest	EVENT_ENFORCE_NONPENDING
static ESIPropertyRequest	EVENT_PART_VALIDATOR
static ESIPropertyRequest	EVENT_QUEUE_NAME
static ESIPropertyRequest	EVENT_QUEUE_PASSWORD
static ESIPropertyRequest	EVENT_QUEUE_TASK
static ESIPropertyRequest	EVENT_QUEUE_USER
static ESIPropertyRequest	EVENT_SOAP_RENDERER
static ESIPropertyRequest	EVENT_VALIDATOR
static ESIPropertyRequest	EVENT_WTOBJECT_VALIDATOR
static long	EXTERNALIZATION_VERSION_UID
private static String	FALSE
(package private) static String	FILE_SEPARATOR
static ESIPropertyRequest	FIX_SAP_LINENUMBER_BAPI
static ESIPropertyRequest	LOG_FAILURE
static ESIPropertyRequest	LOG_SUCCESS
static ESIPropertyRequest	MASTER_ITERATION_CLASS
private String	name
static ESIPropertyRequest	OBJECT_HISTORY_BUILDER_CLASS
static ESIPropertyRequest	OBJECT_HISTORY_MAP
static ESIPropertyRequest	OBJECT_HISTORY_RENDERER_CLASS
protected static long	OLD_FORMAT_VERSION_UID
static ESIPropertyRequest	PART_ALTLINK_CLASS
static ESIPropertyRequest	PART_CLASS
static ESIPropertyRequest	PART_MAP
static ESIPropertyRequest	PART_QUERY_TASK
static ESIPropertyRequest	PART_RELEASE_CLASS
static ESIPropertyRequest	PART_RENDERER_CLASS
static ESIPropertyRequest	PARTMASTER_CLASS
private static String	PROPERTY_PREFIX
static ESIPropertyRequest	REF_DESIGNATOR_MAP
static ESIPropertyRequest	REFERENCE_DESIGNATOR_RENDERER
static ESIPropertyRequest	RELATED_TRANSACTION_CLASS
static ESIPropertyRequest	RELEASE_ACTIVITY_CLASS
static ESIPropertyRequest	RELEASE_ACTIVITY_MESSAGE_CLASS
static ESIPropertyRequest	RENDERER_EFFECTIVITY_END
static ESIPropertyRequest	RENDERER_EFFECTIVITY_FORMAT
static ESIPropertyRequest	RENDERER_EFFECTIVITY_START
static ESIPropertyRequest	REQUEST_QUEUE
static ESIPropertyRequest	REQUIRE_CHANGE
static ESIPropertyRequest	REQUIRE_COMPONENT_QUANTITY
private static String	RESOURCE
static ESIPropertyRequest	RESULT_QUEUE
(package private) static long	serialVersionUID
static ESIPropertyRequest	STANDARD_RELEASE_CLASS
static ESIPropertyRequest	SUBSTITUTE_MAP
static ESIPropertyRequest	SUBSTITUTE_RENDERER
static ESIPropertyRequest	TARGET_ASSIGNMENT_CLASS
static ESIPropertyRequest	TARGET_CAN_DELETE_ASSIGNMENT
static ESIPropertyRequest	TARGET_CAN_DELETE_HISTORY
static ESIPropertyRequest	TARGET_CAN_DELETE_ORGANIZATION
static ESIPropertyRequest	TARGET_CLASS
static ESIPropertyRequest	TARGET_FINDER_CLASS
static ESIPropertyRequest	TARGET_ORGANIZATION_CLASS
static ESIPropertyRequest	TRANSACTION_CLASS
static ESIPropertyRequest	TRANSACTION_MESSAGE_CLASS
static ESIPropertyRequest	TRANSACTION_OBJECT_LINK_CLASS
static ESIPropertyRequest	TRANSACTION_RELEASE_CLASS
private static String	TRUE
static ESIPropertyRequest	TRUNCATE_EXCESS_MESSAGE_TEXT
static ESIPropertyRequest	UFID_DELIMITER
static ESIPropertyRequest	VDB_BUILDER_CLASS
static ESIPropertyRequest	WTPART_CAN_DELETE_HISTORY
static ESIPropertyRequest	WTPART_CAN_DELETE_TRANSACTION
static ESIPropertyRequest	WTPART_CLASS
static ESIPropertyRequest	WTPARTMASTER_CLASS

Constructor Summary

ESIPropertyRequest()

ESIPropertyRequest(String name)

ESIPropertyRequest(String name, String defaultValue)

Method Summary

String	getDefaultValue() Gets the value of the attribute: defaultValue; An optional value to provide if the property isn't found in ESI.properties.
String	getName() Gets the value of the attribute: name; The name of the property to fetch.
static ESIPropertyRequest	newESIPropertyRequest(String name) Creates a new ESIPropertyRequest with a property name.
static ESIPropertyRequest	newESIPropertyRequest(String name, String defaultValue) Creates a new ESIPropertyRequest object with the name and defaultValue attributes initialized.
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(ESIPropertyRequest 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

name

private String name

defaultValue

private String defaultValue

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

PROPERTY_PREFIX

private static final String PROPERTY_PREFIX

See Also:

Constant Field Values

FALSE

private static final String FALSE

See Also:

Constant Field Values

TRUE

private static final String TRUE

See Also:

Constant Field Values

FILE_SEPARATOR

static final String FILE_SEPARATOR

FIX_SAP_LINENUMBER_BAPI

public static final ESIPropertyRequest FIX_SAP_LINENUMBER_BAPI

AIG_ENABLED

public static final ESIPropertyRequest AIG_ENABLED

BOM_COMPONENT_MAP

public static final ESIPropertyRequest BOM_COMPONENT_MAP

BOM_HEADER_MAP

public static final ESIPropertyRequest BOM_HEADER_MAP

SUBSTITUTE_MAP

public static final ESIPropertyRequest SUBSTITUTE_MAP

REF_DESIGNATOR_MAP

public static final ESIPropertyRequest REF_DESIGNATOR_MAP

BOM_ORG_FILTER

public static final ESIPropertyRequest BOM_ORG_FILTER

BOM_RENDERER

public static final ESIPropertyRequest BOM_RENDERER

BOM_HEADER_RENDERER

public static final ESIPropertyRequest BOM_HEADER_RENDERER

BOM_COMPONENT_RENDERER

public static final ESIPropertyRequest BOM_COMPONENT_RENDERER

SUBSTITUTE_RENDERER

public static final ESIPropertyRequest SUBSTITUTE_RENDERER

REFERENCE_DESIGNATOR_RENDERER

public static final ESIPropertyRequest REFERENCE_DESIGNATOR_RENDERER

BOM_TREE_NAVIGATOR_FACTORY

public static final ESIPropertyRequest BOM_TREE_NAVIGATOR_FACTORY

BOM_TREE_NAVIGATOR

public static final ESIPropertyRequest BOM_TREE_NAVIGATOR

ENFORCE_LINE_NUMBERS

public static final ESIPropertyRequest ENFORCE_LINE_NUMBERS

BOM_TREEQUERY_TASK

public static final ESIPropertyRequest BOM_TREEQUERY_TASK

REQUIRE_COMPONENT_QUANTITY

public static final ESIPropertyRequest REQUIRE_COMPONENT_QUANTITY

ECN_HEADER_MAP

public static final ESIPropertyRequest ECN_HEADER_MAP

ECN_QUERY_TASK

public static final ESIPropertyRequest ECN_QUERY_TASK

ECN_CHANGE_HEADER_RENDERER

public static final ESIPropertyRequest ECN_CHANGE_HEADER_RENDERER

ECN_CHANGE_ORDER2_RENDERER

public static final ESIPropertyRequest ECN_CHANGE_ORDER2_RENDERER

CHANGE_REQUEST_FACTORY

public static final ESIPropertyRequest CHANGE_REQUEST_FACTORY

CHANGE_ORDER_FACTORY

public static final ESIPropertyRequest CHANGE_ORDER_FACTORY

CHANGE_ACTIVITY_FACTORY

public static final ESIPropertyRequest CHANGE_ACTIVITY_FACTORY

ADMIN_USER

public static final ESIPropertyRequest ADMIN_USER

ENFORCE_ORGS

public static final ESIPropertyRequest ENFORCE_ORGS

EVENT_QUEUE_NAME

public static final ESIPropertyRequest EVENT_QUEUE_NAME

EVENT_QUEUE_USER

public static final ESIPropertyRequest EVENT_QUEUE_USER

EVENT_QUEUE_PASSWORD

public static final ESIPropertyRequest EVENT_QUEUE_PASSWORD

EVENT_QUEUE_TASK

public static final ESIPropertyRequest EVENT_QUEUE_TASK

EVENT_SOAP_RENDERER

public static final ESIPropertyRequest EVENT_SOAP_RENDERER

EVENT_PART_VALIDATOR

public static final ESIPropertyRequest EVENT_PART_VALIDATOR

EVENT_ECN_VALIDATOR

public static final ESIPropertyRequest EVENT_ECN_VALIDATOR

EVENT_WTOBJECT_VALIDATOR

public static final ESIPropertyRequest EVENT_WTOBJECT_VALIDATOR

EVENT_AUTO_GENERATE_ECN

public static final ESIPropertyRequest EVENT_AUTO_GENERATE_ECN

EVENT_ENFORCE_NONPENDING

public static final ESIPropertyRequest EVENT_ENFORCE_NONPENDING

EVENT_ECN_FACTORY

public static final ESIPropertyRequest EVENT_ECN_FACTORY

EVENT_VALIDATOR

public static final ESIPropertyRequest EVENT_VALIDATOR

REQUEST_QUEUE

public static final ESIPropertyRequest REQUEST_QUEUE

RESULT_QUEUE

public static final ESIPropertyRequest RESULT_QUEUE

CONFIGSPEC_STATE

public static final ESIPropertyRequest CONFIGSPEC_STATE

PART_RENDERER_CLASS

public static final ESIPropertyRequest PART_RENDERER_CLASS

PART_MAP

public static final ESIPropertyRequest PART_MAP

ALTERNATE_LINK_MAP

public static final ESIPropertyRequest ALTERNATE_LINK_MAP

PART_QUERY_TASK

public static final ESIPropertyRequest PART_QUERY_TASK

ALTERNATE_QUERY_TASK

public static final ESIPropertyRequest ALTERNATE_QUERY_TASK

UFID_DELIMITER

public static final ESIPropertyRequest UFID_DELIMITER

RENDERER_EFFECTIVITY_START

public static final ESIPropertyRequest RENDERER_EFFECTIVITY_START

RENDERER_EFFECTIVITY_END

public static final ESIPropertyRequest RENDERER_EFFECTIVITY_END

RENDERER_EFFECTIVITY_FORMAT

public static final ESIPropertyRequest RENDERER_EFFECTIVITY_FORMAT

EFFECTIVITY_CLASS

public static final ESIPropertyRequest EFFECTIVITY_CLASS

EFECTIVITY_HANDLER

public static final ESIPropertyRequest EFECTIVITY_HANDLER

VDB_BUILDER_CLASS

public static final ESIPropertyRequest VDB_BUILDER_CLASS

REQUIRE_CHANGE

public static final ESIPropertyRequest REQUIRE_CHANGE

CHECK_ITERATION

public static final ESIPropertyRequest CHECK_ITERATION

OBJECT_HISTORY_RENDERER_CLASS

public static final ESIPropertyRequest OBJECT_HISTORY_RENDERER_CLASS

OBJECT_HISTORY_BUILDER_CLASS

public static final ESIPropertyRequest OBJECT_HISTORY_BUILDER_CLASS

OBJECT_HISTORY_MAP

public static final ESIPropertyRequest OBJECT_HISTORY_MAP

LOG_SUCCESS

public static final ESIPropertyRequest LOG_SUCCESS

LOG_FAILURE

public static final ESIPropertyRequest LOG_FAILURE

BOM_CLASS

public static final ESIPropertyRequest BOM_CLASS

RELEASE_ACTIVITY_CLASS

public static final ESIPropertyRequest RELEASE_ACTIVITY_CLASS

TRANSACTION_CLASS

public static final ESIPropertyRequest TRANSACTION_CLASS

TRANSACTION_OBJECT_LINK_CLASS

public static final ESIPropertyRequest TRANSACTION_OBJECT_LINK_CLASS

RELATED_TRANSACTION_CLASS

public static final ESIPropertyRequest RELATED_TRANSACTION_CLASS

TRANSACTION_RELEASE_CLASS

public static final ESIPropertyRequest TRANSACTION_RELEASE_CLASS

RELEASE_ACTIVITY_MESSAGE_CLASS

public static final ESIPropertyRequest RELEASE_ACTIVITY_MESSAGE_CLASS

TRANSACTION_MESSAGE_CLASS

public static final ESIPropertyRequest TRANSACTION_MESSAGE_CLASS

TARGET_CAN_DELETE_HISTORY

public static final ESIPropertyRequest TARGET_CAN_DELETE_HISTORY

WTPART_CAN_DELETE_TRANSACTION

public static final ESIPropertyRequest WTPART_CAN_DELETE_TRANSACTION

WTPART_CAN_DELETE_HISTORY

public static final ESIPropertyRequest WTPART_CAN_DELETE_HISTORY

TRUNCATE_EXCESS_MESSAGE_TEXT

public static final ESIPropertyRequest TRUNCATE_EXCESS_MESSAGE_TEXT

ESITARGET_MAPFILE

public static final ESIPropertyRequest ESITARGET_MAPFILE

TARGET_CLASS

public static final ESIPropertyRequest TARGET_CLASS

TARGET_ASSIGNMENT_CLASS

public static final ESIPropertyRequest TARGET_ASSIGNMENT_CLASS

TARGET_ORGANIZATION_CLASS

public static final ESIPropertyRequest TARGET_ORGANIZATION_CLASS

TARGET_FINDER_CLASS

public static final ESIPropertyRequest TARGET_FINDER_CLASS

TARGET_CAN_DELETE_ASSIGNMENT

public static final ESIPropertyRequest TARGET_CAN_DELETE_ASSIGNMENT

TARGET_CAN_DELETE_ORGANIZATION

public static final ESIPropertyRequest TARGET_CAN_DELETE_ORGANIZATION

PART_CLASS

public static final ESIPropertyRequest PART_CLASS

PARTMASTER_CLASS

public static final ESIPropertyRequest PARTMASTER_CLASS

PART_ALTLINK_CLASS

public static final ESIPropertyRequest PART_ALTLINK_CLASS

PART_RELEASE_CLASS

public static final ESIPropertyRequest PART_RELEASE_CLASS

STANDARD_RELEASE_CLASS

public static final ESIPropertyRequest STANDARD_RELEASE_CLASS

DOCUMENT_RENDERER_CLASS

public static final ESIPropertyRequest DOCUMENT_RENDERER_CLASS

DOCUMENT_QUERY_TASK

public static final ESIPropertyRequest DOCUMENT_QUERY_TASK

DOCUMENT_CLASS

public static final ESIPropertyRequest DOCUMENT_CLASS

DOCUMENT_DESCLINK_CLASS

public static final ESIPropertyRequest DOCUMENT_DESCLINK_CLASS

DOCUMENT_REFLINK_CLASS

public static final ESIPropertyRequest DOCUMENT_REFLINK_CLASS

EPMDOCUMENT_CLASS

public static final ESIPropertyRequest EPMDOCUMENT_CLASS

EPMDOCUMENTLINK_CLASS

public static final ESIPropertyRequest EPMDOCUMENTLINK_CLASS

EPMBUILDHISTORY_CLASS

public static final ESIPropertyRequest EPMBUILDHISTORY_CLASS

DOCUMENT_MAP

public static final ESIPropertyRequest DOCUMENT_MAP

DOCUMENT_LINK_MAP

public static final ESIPropertyRequest DOCUMENT_LINK_MAP

WTPART_CLASS

public static final ESIPropertyRequest WTPART_CLASS

WTPARTMASTER_CLASS

public static final ESIPropertyRequest WTPARTMASTER_CLASS

MASTER_ITERATION_CLASS

public static final ESIPropertyRequest MASTER_ITERATION_CLASS

Constructor Detail

ESIPropertyRequest

public ESIPropertyRequest()

ESIPropertyRequest

public ESIPropertyRequest(String name)

ESIPropertyRequest

public ESIPropertyRequest(String name,
                          String defaultValue)

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

getName

public String getName()

Gets the value of the attribute: name; The name of the property to fetch.

Supported API: true

Returns:

String

getDefaultValue

public String getDefaultValue()

Gets the value of the attribute: defaultValue; An optional value to provide if the property isn't found in ESI.properties.

Supported API: true

Returns:

String

newESIPropertyRequest

public static ESIPropertyRequest newESIPropertyRequest(String name)

Creates a new ESIPropertyRequest with a property name.

Supported API: true

Parameters:

name - The name of the property to request.

Returns:

ESIPropertyRequest

newESIPropertyRequest

public static ESIPropertyRequest newESIPropertyRequest(String name,
                                                       String defaultValue)

Creates a new ESIPropertyRequest object with the name and defaultValue attributes initialized.

Supported API: true

Parameters:

name - The property name.

defaultValue - The value to return if the property is not found in ESI properties.

Returns:

ESIPropertyRequest