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

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.

Methods inherited from class java.lang.Object

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

Method Detail

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