com.ptc.windchill.ws
Class PropertyDescription

java.lang.Object
  com.ptc.windchill.ws.PropertyDescription

All Implemented Interfaces:

Serializable

public class PropertyDescription
extends Object
implements Serializable

The PropertyDescription class is a bean class that describes the detailed characteristics of a business object property.

Supported API: true

Extendable: false

See Also:

Serialized Form

Constructor Summary

PropertyDescription()
Constructs a new PropertyDescription.

Method Summary

String	getDefaultLocalizedValue() Returns the default localized value of this property.
String	getDefaultValue() Returns the default value of this property.
String	getLabel() Returns the label associated with this property.
String[]	getLocalizedValues() Returns a list of localized values corresponding to this property's enumerated values.
String	getLocalizedValues(int i) Returns a localized value by index.
String[]	getLongDescriptions() Returns a list of long descriptions corresponding to this property's enumerated values.
String	getLongDescriptions(int i) Returns a long description by index.
String[]	getLongLabels() Returns a list of long labels corresponding to this property's enumerated values.
String	getLongLabels(int i) Returns a long label by index.
String	getLowerLimit() Returns the lower limit constraint of this property if there is one.
String	getName() Returns the property name.
boolean	getRequired() Returns whether or not this property is required.
boolean[]	getSelectable() Returns an array of booleans corresponding to enumerated values that indicate whether or not a particular value is selectable.
boolean	getSelectable(int i) Returns the selectability of a particular enumerated value by index.
String[]	getShortDescriptions() Returns a list of short descriptions corresponding to this property's enumerated values.
String	getShortDescriptions(int i) Returns a short description by index.
String[]	getShortLabels() Returns a list of short labels corresponding to this property's enumerated values.
String	getShortLabels(int i) Returns a short label by index.
String[]	getStringValues() Returns a list of string values corresponding to this property's enumerated values.
String	getStringValues(int i) Returns a string value by index.
String	getSyntax() Returns the syntax of this property.
String	getUpperLimit() Returns the upper limit constraint of this property if there is one.
String[]	getValues() Returns a list of enumerated values for this property if there are any.
String	getValues(int i) Returns an enumerated value by index.
void	setDefaultLocalizedValue(String defaultLocalizedValue) Sets the default localized value of this property.
void	setDefaultValue(String defaultValue) Sets the default value of this property.
void	setLabel(String label) Sets the label associated with this property.
void	setLocalizedValues(int i, String localizedValue) Sets a localized value by index.
void	setLocalizedValues(String[] localizedValues) Sets a list of localized values corresponding to this property's enumerated values.
void	setLongDescriptions(int i, String longDescription) Sets a long description by index.
void	setLongDescriptions(String[] longDescriptions) Sets a list of long descriptions corresponding to this property's enumerated values.
void	setLongLabels(int i, String longLabel) Sets a long label by index.
void	setLongLabels(String[] longLabels) Sets a list of long labels corresponding to this property's enumerated values.
void	setLowerLimit(String lowerLimit) Sets the lowere limit constraint of this property.
void	setName(String name) Sets the property name.
void	setRequired(boolean required) Sets whether or not this property is required.
void	setSelectable(boolean[] selectable) Sets a list of boolean values corresponding to this property's enumerated values indicating selectability.
void	setSelectable(int i, boolean selectable) Sets the selectability of a particular enumerated value by index.
void	setShortDescriptions(int i, String shortDescription) Sets a short description by index.
void	setShortDescriptions(String[] shortDescriptions) Sets a list of short descriptions corresponding to this property's enumerated values.
void	setShortLabels(int i, String shortLabel) Sets a short label by index.
void	setShortLabels(String[] shortLabels) Sets a list of short labels corresponding to this property's enumerated values.
void	setStringValues(int i, String stringValue) Sets a string value by index.
void	setStringValues(String[] stringValues) Sets a list of string values corresponding to this property's enumerated values.
void	setSyntax(String syntax) Sets the syntax of this property.
void	setUpperLimit(String upperLimit) Sets the upper limit constraint of this property.
void	setValues(int i, String value) Sets an enumerated value by index.
void	setValues(String[] values) Sets a list of enumerated values for this property.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDescription

public PropertyDescription()

Constructs a new PropertyDescription.

Supported API: true

Method Detail

getName

public String getName()

Returns the property name.

Supported API: true

Returns:

The property name.

setName

public void setName(String name)

Sets the property name.

Supported API: true

Parameters:

name - The property name.

getSyntax

public String getSyntax()

Returns the syntax of this property.

Supported API: true

Returns:

The syntax.

setSyntax

public void setSyntax(String syntax)

Sets the syntax of this property.

Supported API: true

Parameters:

syntax - The new syntax.

getLabel

public String getLabel()

Returns the label associated with this property.

Supported API: true

Returns:

The label.

setLabel

public void setLabel(String label)

Sets the label associated with this property.

Supported API: true

Parameters:

label - The label.

getUpperLimit

public String getUpperLimit()

Returns the upper limit constraint of this property if there is one.

Supported API: true

Returns:

The upper limit.

setUpperLimit

public void setUpperLimit(String upperLimit)

Sets the upper limit constraint of this property.

Supported API: true

Parameters:

upperLimit - The new upper limit.

getLowerLimit

public String getLowerLimit()

Returns the lower limit constraint of this property if there is one.

Supported API: true

Returns:

The lower limit.

setLowerLimit

public void setLowerLimit(String lowerLimit)

Sets the lowere limit constraint of this property.

Supported API: true

Parameters:

lowerLimit - The new lower limit.

getRequired

public boolean getRequired()

Returns whether or not this property is required.

Supported API: true

Returns:

true if required.

setRequired

public void setRequired(boolean required)

Sets whether or not this property is required.

Supported API: true

Parameters:

required - The new required value.

getDefaultValue

public String getDefaultValue()

Returns the default value of this property.

Supported API: true

Returns:

The default value.

setDefaultValue

public void setDefaultValue(String defaultValue)

Sets the default value of this property.

Supported API: true

Parameters:

defaultValue - The new default value.

getDefaultLocalizedValue

public String getDefaultLocalizedValue()

Returns the default localized value of this property.

Supported API: true

Returns:

The default localized value.

setDefaultLocalizedValue

public void setDefaultLocalizedValue(String defaultLocalizedValue)

Sets the default localized value of this property.

Supported API: true

Parameters:

defaultLocalizedValue - The new default localized value.

getValues

public String[] getValues()

Returns a list of enumerated values for this property if there are any.

Supported API: true

Returns:

The enumerated values.

setValues

public void setValues(String[] values)

Sets a list of enumerated values for this property.

Supported API: true

Parameters:

values - The new values.

getValues

public String getValues(int i)

Returns an enumerated value by index.

Supported API: true

Parameters:

i - The index.

Returns:

The value.

setValues

public void setValues(int i,
                      String value)

Sets an enumerated value by index.

Supported API: true

Parameters:

i - The index.

value - The new value.

getLocalizedValues

public String[] getLocalizedValues()

Returns a list of localized values corresponding to this property's enumerated values.

Supported API: true

Returns:

The localized values.

setLocalizedValues

public void setLocalizedValues(String[] localizedValues)

Sets a list of localized values corresponding to this property's enumerated values.

Supported API: true

Parameters:

localizedValues - The new localized values.

getLocalizedValues

public String getLocalizedValues(int i)

Returns a localized value by index.

Supported API: true

Parameters:

i - The index.

Returns:

The localized value.

setLocalizedValues

public void setLocalizedValues(int i,
                               String localizedValue)

Sets a localized value by index.

Supported API: true

Parameters:

i - The index.

localizedValue - The new localized value.

getStringValues

public String[] getStringValues()

Returns a list of string values corresponding to this property's enumerated values.

Supported API: true

Returns:

The string values.

setStringValues

public void setStringValues(String[] stringValues)

Sets a list of string values corresponding to this property's enumerated values.

Supported API: true

Parameters:

stringValues - The new string values.

getStringValues

public String getStringValues(int i)

Returns a string value by index.

Supported API: true

Parameters:

i - The index.

Returns:

The string value.

setStringValues

public void setStringValues(int i,
                            String stringValue)

Sets a string value by index.

Supported API: true

Parameters:

i - The index.

stringValue - The new string value.

getSelectable

public boolean[] getSelectable()

Returns an array of booleans corresponding to enumerated values that indicate whether or not a particular value is selectable.

Supported API: true

Returns:

A list of booleans indicating selectability of enumerated values.

setSelectable

public void setSelectable(boolean[] selectable)

Sets a list of boolean values corresponding to this property's enumerated values indicating selectability.

Supported API: true

Parameters:

selectable - The new selectability of this property's enumerated values.

getSelectable

public boolean getSelectable(int i)

Returns the selectability of a particular enumerated value by index.

Supported API: true

Parameters:

i - The index.

Returns:

true if selectable.

setSelectable

public void setSelectable(int i,
                          boolean selectable)

Sets the selectability of a particular enumerated value by index.

Supported API: true

Parameters:

i - The index.

selectable - The selectability of the corresponding enumerated value.

getShortLabels

public String[] getShortLabels()

Returns a list of short labels corresponding to this property's enumerated values.

Supported API: true

Returns:

The short labels.

setShortLabels

public void setShortLabels(String[] shortLabels)

Sets a list of short labels corresponding to this property's enumerated values.

Supported API: true

Parameters:

shortLabels - The new short labels.

getShortLabels

public String getShortLabels(int i)

Returns a short label by index.

Supported API: true

Parameters:

i - The index.

Returns:

The short label.

setShortLabels

public void setShortLabels(int i,
                           String shortLabel)

Sets a short label by index.

Supported API: true

Parameters:

i - The index.

shortLabel - The new short label.

getLongLabels

public String[] getLongLabels()

Returns a list of long labels corresponding to this property's enumerated values.

Supported API: true

Returns:

The long labels.

setLongLabels

public void setLongLabels(String[] longLabels)

Sets a list of long labels corresponding to this property's enumerated values.

Supported API: true

Parameters:

longLabels - The long labels.

getLongLabels

public String getLongLabels(int i)

Returns a long label by index.

Supported API: true

Parameters:

i - The index.

Returns:

The long label.

setLongLabels

public void setLongLabels(int i,
                          String longLabel)

Sets a long label by index.

Supported API: true

Parameters:

i - The index.

longLabel - The new long label.

getShortDescriptions

public String[] getShortDescriptions()

Returns a list of short descriptions corresponding to this property's enumerated values.

Supported API: true

Returns:

The short descriptions.

setShortDescriptions

public void setShortDescriptions(String[] shortDescriptions)

Sets a list of short descriptions corresponding to this property's enumerated values.

Supported API: true

Parameters:

shortDescriptions - The new short descriptions.

getShortDescriptions

public String getShortDescriptions(int i)

Returns a short description by index.

Supported API: true

Parameters:

i - The index.

Returns:

The short description.

setShortDescriptions

public void setShortDescriptions(int i,
                                 String shortDescription)

Sets a short description by index.

Supported API: true

Parameters:

i - The index.

shortDescription - The new short description.

getLongDescriptions

public String[] getLongDescriptions()

Returns a list of long descriptions corresponding to this property's enumerated values.

Supported API: true

Returns:

The long descriptions.

setLongDescriptions

public void setLongDescriptions(String[] longDescriptions)

Sets a list of long descriptions corresponding to this property's enumerated values.

Supported API: true

Parameters:

longDescriptions - The new long descriptions.

getLongDescriptions

public String getLongDescriptions(int i)

Returns a long description by index.

Supported API: true

Parameters:

i - The index.

Returns:

The long description.

setLongDescriptions

public void setLongDescriptions(int i,
                                String longDescription)

Sets a long description by index.

Supported API: true

Parameters:

i - The index.

longDescription - The new long description.