Home | Trees | Indices | Help |
---|
|
object --+ | PropertyDescription
Wrapper around the internal property representation giving restricted access to the relevant parameters. All instance variables are read-only.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
unicode
|
identifier This is the logical identifier of the property. |
||
unicode
|
displayName A readable name that can be presented in a user interface. |
||
unicode , for possible values see: constants
|
category This holds the category of the property, i.e. |
||
unicode
|
description Describes the purpose of the property. |
||
The type of the default value depends on the property definition. |
defaultValue A default value for the property that is used for creation of the property on a resource. |
||
bool
|
notNull Flag indicating if None is a allowed property value or
not.
|
||
unicode
|
namespace Name space in which the property is valid, e.g. |
||
dict
|
restrictions This parameter holds the defined property restrictions that are represented by parameters. |
|
|||
type Returns the propertyType. |
|||
Inherited from |
|
Constructor.
|
Returns a readable representation.
|
|
identifierThis is the logical identifier of the property.
|
displayNameA readable name that can be presented in a user interface.
|
categoryThis holds the category of the property, i.e. if the property is system, data model or user specific. System specific: property can NOT be deleted from resource, values are read-only Data model specific: property can NOT be deleted from resource, values changeable User specific: property can be deleted from resource, values changeable
|
descriptionDescribes the purpose of the property.
|
defaultValueA default value for the property that is used for creation of the property on a resource.
|
notNullFlag indicating ifNone is a allowed property value or not.
|
namespaceName space in which the property is valid, e.g. used to distinguish differentname properties of different data types.
|
restrictionsThis parameter holds the defined property restrictions that are represented by parameters. The returned mapping can contain the following keys: minimumValue: Defining the lower boundary of a value range. maximumValue: Defining the upper boundary of a value range. minimumLength: Defining the lower boundary of a length range. maximumLength: Defining the upper boundary of a length range. minimumNumberOfDecimalPlaces: Defining the minimum number of decimal places. maximumNumberOfDecimalPlaces: Defining the maximum number of decimal places. pattern: Regular expression pattern that restricts a string value. options: A list of options the value can be chosen from. optionsMandatory: Boolean indicating whether the value MUST be from the list of options. subTypes: List of strings identifying supported types. The possible restrictions depend on the type.
|
|
typeReturns the propertyType.
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Fri Jun 24 11:09:29 2011 | http://epydoc.sourceforge.net |