com.funambol.syncml.protocol
Class Property

java.lang.Object
  extended by com.funambol.syncml.protocol.Property

public class Property
extends java.lang.Object

This class represents a supported property of a given content type. The parameters to specify a property are name, data type, maximum number of occurences of a property, maximum size in UTF-8 characters, truncation, enumerated value, display name and supported parameter.


Constructor Summary
Property()
          In order to expose the server configuration like WS this constructor must be public
Property(java.lang.String propName, java.lang.String dataType, int maxOccur, int maxSize, boolean noTruncate, java.lang.String[] valEnums, java.lang.String displayName, PropParam[] propParams)
          Creates a new Propety object
 
Method Summary
 void addParamName(java.lang.String paramName)
           
 void addPropParam(PropParam propParam)
           
 void addValEnum(java.lang.String val)
           
 java.lang.String getDataType()
          Gets the data type of the property
 java.lang.String getDisplayName()
          Gets the display name
 int getMaxOccur()
          Gets the maximum number of occurrences of the property of the same type supported within a single object
 int getMaxSize()
          Gets the maximum size for a given datastore (in bytes)
 java.lang.Boolean getNoTruncate()
          Gets the value of NoTruncate property
 java.lang.String getPropName()
          Gets the property name
 java.util.Vector getPropParams()
          Gets the array of supported parameters of the property
 java.util.Vector getValEnums()
          Gets the array of supported enumerated value of the CTType property
 boolean isNoTruncate()
          Gets the value of NoTruncate property
 void setDataType(java.lang.String dataType)
          Sets the data type of the property
 void setDisplayName(java.lang.String displayName)
          Sets the display name of the property
 void setMaxOccur(int maxOccur)
          Sets the maximum number of occurrences of the property of the same type supported within a single object
 void setMaxSize(int maxSize)
          Sets the maximum size for a given datastore (in bytes)
 void setNoTruncate(java.lang.Boolean noTruncate)
          Specify if the property value can exceed the maximum size as specified by the MaxSize
 void setPropName(java.lang.String propName)
          Sets the property name
 void setPropParams(PropParam[] propParams)
          Sets an array of supported parameters of the property
 void setPropParams(java.util.Vector propParams)
          Sets an array of supported parameters of the property
 void setValEnums(java.lang.String[] valEnums)
          Sets the array of supported enumerated value of the CTType property
 void setValEnums(java.util.Vector valEnums)
          Sets the array of supported enumerated value of the CTType property
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Property

public Property()
In order to expose the server configuration like WS this constructor must be public


Property

public Property(java.lang.String propName,
                java.lang.String dataType,
                int maxOccur,
                int maxSize,
                boolean noTruncate,
                java.lang.String[] valEnums,
                java.lang.String displayName,
                PropParam[] propParams)
Creates a new Propety object

Parameters:
propName - The name of a supported property - NOT NULL
dataType - The datatype of a supported property
maxOccur - The maximum number of occurrences of a property of the same type supported within a single object
maxSize - The maximum size for a given datastore (in bytes)
noTruncate - Specify if the property value can exceed the maximum size as specified by the MaxSize tag
valEnums - The supported enumerated value of a given CTType property
displayName - The display name of a property
propParams - The array of supported parameters of a given property
Method Detail

getPropName

public java.lang.String getPropName()
Gets the property name

Returns:
the property name

setPropName

public void setPropName(java.lang.String propName)
Sets the property name

Parameters:
propName - the property name

getDataType

public java.lang.String getDataType()
Gets the data type of the property

Returns:
the data type of the property

setDataType

public void setDataType(java.lang.String dataType)
Sets the data type of the property

Parameters:
dataType - the data type of the property

getMaxOccur

public int getMaxOccur()
Gets the maximum number of occurrences of the property of the same type supported within a single object

Returns:
the maximum number of occurrences

setMaxOccur

public void setMaxOccur(int maxOccur)
Sets the maximum number of occurrences of the property of the same type supported within a single object

Parameters:
maxOccur - the maximum number of occurrences of the property

getMaxSize

public int getMaxSize()
Gets the maximum size for a given datastore (in bytes)

Returns:
the maximum size for a given datastore (in bytes)

setMaxSize

public void setMaxSize(int maxSize)
Sets the maximum size for a given datastore (in bytes)

Parameters:
size - the maximum size

setNoTruncate

public void setNoTruncate(java.lang.Boolean noTruncate)
Specify if the property value can exceed the maximum size as specified by the MaxSize

Parameters:
noTruncate - the Boolean value of NoTruncate property

isNoTruncate

public boolean isNoTruncate()
Gets the value of NoTruncate property

Returns:
true if the property value can exceed the maximum size as specified by the MaxSize

getNoTruncate

public java.lang.Boolean getNoTruncate()
Gets the value of NoTruncate property

Returns:
true if the property value can exceed the maximum size as specified by the MaxSize

getValEnums

public java.util.Vector getValEnums()
Gets the array of supported enumerated value of the CTType property

Returns:
the array of supported enumerated value of the CTType property

setValEnums

public void setValEnums(java.lang.String[] valEnums)
Sets the array of supported enumerated value of the CTType property

Parameters:
valEnums - the array of supported enumerated value

setValEnums

public void setValEnums(java.util.Vector valEnums)
Sets the array of supported enumerated value of the CTType property

Parameters:
valEnums - the array of supported enumerated value

addValEnum

public void addValEnum(java.lang.String val)

getDisplayName

public java.lang.String getDisplayName()
Gets the display name

Returns:
the display name

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the display name of the property

Parameters:
displayName - the display name of the property

getPropParams

public java.util.Vector getPropParams()
Gets the array of supported parameters of the property

Returns:
the array of supported parameters of the property

setPropParams

public void setPropParams(PropParam[] propParams)
Sets an array of supported parameters of the property

Parameters:
propParams - the array of supported parameters of the property

setPropParams

public void setPropParams(java.util.Vector propParams)
Sets an array of supported parameters of the property

Parameters:
propParams - the array of supported parameters of the property

addPropParam

public void addPropParam(PropParam propParam)

addParamName

public void addParamName(java.lang.String paramName)
Parameters:
paramName - ParamName's value


Copyright © 2001-2009 Funambol.