urn.icsy.venice.types.basic
Class PreferenceProperty

java.lang.Object
  extended by urn.icsy.venice.types.basic.PreferenceProperty
All Implemented Interfaces:
java.io.Serializable

public class PreferenceProperty
extends java.lang.Object
implements java.io.Serializable

A property representing some preferences of a service.

See Also:
Serialized Form

Constructor Summary
PreferenceProperty()
           
PreferenceProperty(PropertyType type, java.lang.String name, java.lang.String displayName, java.lang.String displayNameLocalization, java.lang.String value, java.lang.String defaultValue, java.lang.String[] options)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getDefaultValue()
          Gets the defaultValue value for this PreferenceProperty.
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Deserializer
 java.lang.String getDisplayName()
          Gets the displayName value for this PreferenceProperty.
 java.lang.String getDisplayNameLocalization()
          Gets the displayNameLocalization value for this PreferenceProperty.
 java.lang.String getName()
          Gets the name value for this PreferenceProperty.
 java.lang.String[] getOptions()
          Gets the options value for this PreferenceProperty.
 java.lang.String getOptions(int i)
           
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Serializer
 PropertyType getType()
          Gets the type value for this PreferenceProperty.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 java.lang.String getValue()
          Gets the value value for this PreferenceProperty.
 int hashCode()
           
 void setDefaultValue(java.lang.String defaultValue)
          Sets the defaultValue value for this PreferenceProperty.
 void setDisplayName(java.lang.String displayName)
          Sets the displayName value for this PreferenceProperty.
 void setDisplayNameLocalization(java.lang.String displayNameLocalization)
          Sets the displayNameLocalization value for this PreferenceProperty.
 void setName(java.lang.String name)
          Sets the name value for this PreferenceProperty.
 void setOptions(int i, java.lang.String _value)
           
 void setOptions(java.lang.String[] options)
          Sets the options value for this PreferenceProperty.
 void setType(PropertyType type)
          Sets the type value for this PreferenceProperty.
 void setValue(java.lang.String value)
          Sets the value value for this PreferenceProperty.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PreferenceProperty

public PreferenceProperty()

PreferenceProperty

public PreferenceProperty(PropertyType type,
                          java.lang.String name,
                          java.lang.String displayName,
                          java.lang.String displayNameLocalization,
                          java.lang.String value,
                          java.lang.String defaultValue,
                          java.lang.String[] options)
Method Detail

getType

public PropertyType getType()
Gets the type value for this PreferenceProperty.

Returns:
type * The type of this property, i.e. string, integer, password, boolean etc.

setType

public void setType(PropertyType type)
Sets the type value for this PreferenceProperty.

Parameters:
type - * The type of this property, i.e. string, integer, password, boolean etc.

getName

public java.lang.String getName()
Gets the name value for this PreferenceProperty.

Returns:
name * The internal name of the property. Should not be shown to end-users.

setName

public void setName(java.lang.String name)
Sets the name value for this PreferenceProperty.

Parameters:
name - * The internal name of the property. Should not be shown to end-users.

getDisplayName

public java.lang.String getDisplayName()
Gets the displayName value for this PreferenceProperty.

Returns:
displayName * The displayable name of the properties. This can be shown to end-users.

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the displayName value for this PreferenceProperty.

Parameters:
displayName - * The displayable name of the properties. This can be shown to end-users.

getDisplayNameLocalization

public java.lang.String getDisplayNameLocalization()
Gets the displayNameLocalization value for this PreferenceProperty.

Returns:
displayNameLocalization * The localized diaplay name of the property. This can be shown to end-users.

setDisplayNameLocalization

public void setDisplayNameLocalization(java.lang.String displayNameLocalization)
Sets the displayNameLocalization value for this PreferenceProperty.

Parameters:
displayNameLocalization - * The localized diaplay name of the property. This can be shown to end-users.

getValue

public java.lang.String getValue()
Gets the value value for this PreferenceProperty.

Returns:
value * The current value of the property, i.e. the value a user/admin has set before.

setValue

public void setValue(java.lang.String value)
Sets the value value for this PreferenceProperty.

Parameters:
value - * The current value of the property, i.e. the value a user/admin has set before.

getDefaultValue

public java.lang.String getDefaultValue()
Gets the defaultValue value for this PreferenceProperty.

Returns:
defaultValue * The default value of the property. Can be used to re-set the current value to a sound one.

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
Sets the defaultValue value for this PreferenceProperty.

Parameters:
defaultValue - * The default value of the property. Can be used to re-set the current value to a sound one.

getOptions

public java.lang.String[] getOptions()
Gets the options value for this PreferenceProperty.

Returns:
options * Additional data according to the type of the property, e.g. values to choose from for a choice type.

setOptions

public void setOptions(java.lang.String[] options)
Sets the options value for this PreferenceProperty.

Parameters:
options - * Additional data according to the type of the property, e.g. values to choose from for a choice type.

getOptions

public java.lang.String getOptions(int i)

setOptions

public void setOptions(int i,
                       java.lang.String _value)

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer