com.ibm.uddi.v3.management

Class Property

  1. java.lang.Object
  2. extended bycom.ibm.uddi.v3.management.Property
All implemented interfaces:
java.io.Serializable
Direct known subclasses:
ConfigurationProperty, Entitlement, Limit, Policy, TierProperty, UddiUserProperty, UserEntitlementProperty, ValueSetProperty

  1. public abstract class Property
  2. extends java.lang.Object
  3. implements java.io.Serializable
Base class for UDDI property objects.
See Also:
Serialized Form

Constructor Summary

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

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

Constructor Detail

Property

  1. public Property()
Constructor taking no arguments

Property

  1. public Property(java.lang.String id,
  2. java.lang.String type,
  3. java.lang.Object value,
  4. 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

  1. public java.lang.String getDescriptionKey( )
Returns the message key for the description of this property.
Returns:
- the message key for the description.

getId

  1. public java.lang.String getId()
Returns the identifier for this property.
Returns:
- the property identifier.

getNameKey

  1. public java.lang.String getNameKey( )
Returns the message key for the name of this property.
Returns:
- the message key for the name.

getType

  1. 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

  1. 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

  1. public void setDescriptionKey(java.lang.String descriptionKey)
Sets the description message key of the property.
Parameters:
descriptionKey -

setId

  1. public void setId(java.lang.String id)
Sets the ID of the property.
Parameters:
id -

setNameKey

  1. public void setNameKey(java.lang.String nameKey)
Sets the name message key of the property.
Parameters:
nameKey -

setType

  1. public void setType(java.lang.String type)
Sets the type of the property value.
Parameters:
type -

getValue

  1. 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

  1. public void setValue(java.lang.Object value)
Sets the value of the property.

isReadOnly

  1. public boolean isReadOnly()
Indicates if the property is read only.
Returns:

isRequired

  1. public boolean isRequired()
Indicates if the property is a required field.
Returns:

getUnitsKey

  1. public java.lang.String getUnitsKey( )
Returns:

isUsingMessageKeys

  1. public boolean isUsingMessageKeys( )
Returns:

setReadOnly

  1. public void setReadOnly(boolean readOnly)
Indicates if property is read only.
Parameters:
readOnly -

setRequired

  1. public void setRequired(boolean required)
Indicates if the property is required.
Parameters:
required - true if the property is required.

setUnitsKey

  1. public void setUnitsKey(java.lang.String unitsKey)
Message key for looking up locale specific text for units.
Parameters:
unitsKey -

setUsingMessageKeys

  1. public void setUsingMessageKeys( boolean usingMessageKeys)
Indicates if the value contains message keys.
Parameters:
usingMessageKeys -

setValidValues

  1. public void setValidValues(java.util.List validValues)
Sets valid values a property can have if it supports multiple possible values.
Parameters:
validValues -

setBooleanValue

  1. public void setBooleanValue(boolean booleanValue)
Convenience method for setting value of type Boolean.
Parameters:
booleanValue -

getBooleanValue

  1. public boolean getBooleanValue( )
Convenience method for getting a boolean value.
Returns:
true if value is true, false

setIntegerValue

  1. public void setIntegerValue(int integerValue)
Convenience method for setting value of type Integer.
Parameters:
integerValue -

getIntegerValue

  1. public int getIntegerValue()
Convenience method for getting an integer value.
Returns:
integer value

setStringValue

  1. public void setStringValue(java.lang.String stringValue)
Convenience method for setting value of type String.
Parameters:
stringValue -

getStringValue

  1. public java.lang.String getStringValue( )
Convenience method for getting an integer value.
Returns:
String value

toString

  1. public java.lang.String toString( )
Overrides:
toString in class java.lang.Object

isInternal

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. public void setConstraints(java.util.List constraints)
Sets validation constraints.
Parameters:
constraints - collection of Constraint objects.