Property (IBM WebSphere Application Server, Release 8.5)

java.lang.Object
- com.ibm.uddi.v3.management.Property

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ConfigurationProperty, Entitlement, Limit, Policy, TierProperty, UddiUserProperty, UserEntitlementProperty, ValueSetProperty
```
public abstract class Property
extends java.lang.Object
implements java.io.Serializable
```
Base class for UDDI property objects.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Property()` Constructor taking no arguments
`Property(java.lang.String id, java.lang.String type, java.lang.Object value, java.lang.String nameKey)` Convenience constructor taking an id, type, value and name key only.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanValue()` Convenience method for getting a boolean value.
`java.util.List`	`getConstraints()` Returns validation constraints (if any).
`java.lang.String`	`getDescriptionKey()` Returns the message key for the description of this property.
`int`	`getDisplayOrder()` Returns the display weighting which is typically used by user interfaces to determine display order for multiple property views.
`java.lang.String`	`getId()` Returns the identifier for this property.
`int`	`getIntegerValue()` Convenience method for getting an integer value.
`java.lang.String`	`getNameKey()` Returns the message key for the name of this property.
`java.lang.String`	`getStringValue()` Convenience method for getting an integer value.
`java.lang.String`	`getType()` Returns the `String` representing the type of this property.
`java.lang.String`	`getUnitsKey()`
`java.util.List`	`getValidValues()` Returns the collection of valid values that this property's value can be.
`java.lang.Object`	`getValue()` Returns the property value as an `Object`, which should be cast according to the type attribute.
`boolean`	`isInternal()` Indicates if this property is only for UDDI registry use and not to be controlled by clients.
`boolean`	`isReadOnly()` Indicates if the property is read only.
`boolean`	`isRequired()` Indicates if the property is a required field.
`boolean`	`isUsingMessageKeys()`
`void`	`setBooleanValue(boolean booleanValue)` Convenience method for setting value of type Boolean.
`void`	`setConstraints(java.util.List constraints)` Sets validation constraints.
`void`	`setDescriptionKey(java.lang.String descriptionKey)` Sets the description message key of the property.
`void`	`setDisplayOrder(int displayOrder)` Sets the display weighting.
`void`	`setId(java.lang.String id)` Sets the ID of the property.
`void`	`setIntegerValue(int integerValue)` Convenience method for setting value of type Integer.
`void`	`setInternal(boolean internal)` Sets the internal flag, indicating if this property is only for UDDI registry use and not to be controlled by clients.
`void`	`setNameKey(java.lang.String nameKey)` Sets the name message key of the property.
`void`	`setReadOnly(boolean readOnly)` Indicates if property is read only.
`void`	`setRequired(boolean required)` Indicates if the property is required.
`void`	`setStringValue(java.lang.String stringValue)` Convenience method for setting value of type String.
`void`	`setType(java.lang.String type)` Sets the type of the property value.
`void`	`setUnitsKey(java.lang.String unitsKey)` Message key for looking up locale specific text for units.
`void`	`setUsingMessageKeys(boolean usingMessageKeys)` Indicates if the value contains message keys.
`void`	`setValidValues(java.util.List validValues)` Sets valid values a property can have if it supports multiple possible values.
`void`	`setValue(java.lang.Object value)` Sets the value of the property.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Property
```
public Property()
```
    Constructor taking no arguments
  - Property
```
public Property(java.lang.String id,
        java.lang.String type,
        java.lang.Object value,
        java.lang.String nameKey)
```
    Convenience constructor taking an id, type, value and name key only. All other parameters are defaulted.
    
    Parameters:
    id -
    type -
    value -
    nameKey -
- Method Detail
  - getDescriptionKey
```
public java.lang.String getDescriptionKey()
```
    Returns the message key for the description of this property.
    
    Returns:
    - the message key for the description.
  - getId
```
public java.lang.String getId()
```
    Returns the identifier for this property.
    
    Returns:
    - the property identifier.
  - getNameKey
```
public java.lang.String getNameKey()
```
    Returns the message key for the name of this property.
    
    Returns:
    - the message key for the name.
  - getType
```
public java.lang.String getType()
```
    Returns the String representing the type of this property.
    
    Returns:
    - the fully qualified class name of the type of the property.
  - getValidValues
```
public java.util.List getValidValues()
```
    Returns the collection of valid values that this property's value can be.
    
    Returns:
    List of valid values (need to cast to type).
  - setDescriptionKey
```
public void setDescriptionKey(java.lang.String descriptionKey)
```
    Sets the description message key of the property.
    
    Parameters:
    descriptionKey -
  - setId
```
public void setId(java.lang.String id)
```
    Sets the ID of the property.
    
    Parameters:
    id -
  - setNameKey
```
public void setNameKey(java.lang.String nameKey)
```
    Sets the name message key of the property.
    
    Parameters:
    nameKey -
  - setType
```
public void setType(java.lang.String type)
```
    Sets the type of the property value.
    
    Parameters:
    type -
  - getValue
```
public java.lang.Object getValue()
```
    Returns the property value as an Object, which should be cast according to the type attribute.
    
    Returns:
    the value of the property.
  - setValue
```
public void setValue(java.lang.Object value)
```
    Sets the value of the property.
    
    Parameters:
    Object -
  - isReadOnly
```
public boolean isReadOnly()
```
    Indicates if the property is read only.
    
    Returns:
  - isRequired
```
public boolean isRequired()
```
    Indicates if the property is a required field.
    
    Returns:
  - getUnitsKey
```
public java.lang.String getUnitsKey()
```
    Returns:
  - isUsingMessageKeys
```
public boolean isUsingMessageKeys()
```
    Returns:
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Indicates if property is read only.
    
    Parameters:
    readOnly -
  - setRequired
```
public void setRequired(boolean required)
```
    Indicates if the property is required.
    
    Parameters:
    required - true if the property is required.
  - setUnitsKey
```
public void setUnitsKey(java.lang.String unitsKey)
```
    Message key for looking up locale specific text for units.
    
    Parameters:
    unitsKey -
  - setUsingMessageKeys
```
public void setUsingMessageKeys(boolean usingMessageKeys)
```
    Indicates if the value contains message keys.
    
    Parameters:
    usingMessageKeys -
  - setValidValues
```
public void setValidValues(java.util.List validValues)
```
    Sets valid values a property can have if it supports multiple possible values.
    
    Parameters:
    validValues -
  - setBooleanValue
```
public void setBooleanValue(boolean booleanValue)
```
    Convenience method for setting value of type Boolean.
    
    Parameters:
    booleanValue -
  - getBooleanValue
```
public boolean getBooleanValue()
```
    Convenience method for getting a boolean value.
    
    Returns:
    true if value is true, false
  - setIntegerValue
```
public void setIntegerValue(int integerValue)
```
    Convenience method for setting value of type Integer.
    
    Parameters:
    integerValue -
  - getIntegerValue
```
public int getIntegerValue()
```
    Convenience method for getting an integer value.
    
    Returns:
    integer value
  - setStringValue
```
public void setStringValue(java.lang.String stringValue)
```
    Convenience method for setting value of type String.
    
    Parameters:
    stringValue -
  - getStringValue
```
public java.lang.String getStringValue()
```
    Convenience method for getting an integer value.
    
    Returns:
    String value
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isInternal
```
public boolean isInternal()
```
    Indicates if this property is only for UDDI registry use and not to be controlled by clients. Client applications will only ever receive Property objects that have internal set to false.
    
    Returns:
    true if the property is used internally only.
  - setInternal
```
public void setInternal(boolean internal)
```
    Sets the internal flag, indicating if this property is only for UDDI registry use and not to be controlled by clients.
    
    Parameters:
    internal - - true indicates the property is used internally.
  - getDisplayOrder
```
public int getDisplayOrder()
```
    Returns the display weighting which is typically used by user interfaces to determine display order for multiple property views.
    
    Returns:
    display weighting value, relative to values of other properties in same collection.
  - setDisplayOrder
```
public void setDisplayOrder(int displayOrder)
```
    Sets the display weighting. Useful for client applications to sort property views.
    
    Parameters:
    displayOrder - - display weighting value, relative to values of other properties in same collection.
  - getConstraints
```
public java.util.List getConstraints()
```
    Returns validation constraints (if any). When a Property is returned to a client, only constraints that can be executed outside of the UDDI application are populated.
    
    Returns:
    collection of Constraint objects.
  - setConstraints
```
public void setConstraints(java.util.List constraints)
```
    Sets validation constraints.
    
    Parameters:
    constraints - collection of Constraint objects.

Methods inherited from class java.lang.Object

Property

Property

getDescriptionKey

getId

getNameKey

getType

getValidValues

setDescriptionKey

setId

setNameKey

setType

getValue

setValue

isReadOnly

isRequired

getUnitsKey

isUsingMessageKeys

setReadOnly

setRequired

setUnitsKey

setUsingMessageKeys

setValidValues

setBooleanValue

getBooleanValue

setIntegerValue

getIntegerValue

setStringValue

getStringValue

toString

isInternal

setInternal

getDisplayOrder

setDisplayOrder

getConstraints

setConstraints