Package datafinder :: Package script_api :: Package properties :: Module property_description :: Class PropertyDescription
[hide private]
[frames] | no frames]

Class PropertyDescription

object --+
         |
        PropertyDescription

Wrapper around the internal property representation giving restricted access to the relevant parameters. All instance variables are read-only.

Instance Methods [hide private]
 
__init__(self, propertyDefinition)
Constructor.
 
__getIdentifier(self)
Returns the identifier of the property.
 
__getType(self)
Returns the propertyType.
 
__getDisplayName(self)
Returns the display name of the property.
 
__getCategory(self)
Returns the property category.
 
__getDescription(self)
Returns the property description.
 
__getDefaultValue(self)
Returns the specific default value.
 
__getNotNull(self)
Returns whether the value can be None or not.
 
__getNamespace(self)
Returns the namespace.
 
__getRestrictions(self)
Returns the defined restrictions of the property.
 
__repr__(self)
Returns a readable representation.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Instance Variables [hide private]
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.
Properties [hide private]
  type
Returns the propertyType.

Inherited from object: __class__

Method Details [hide private]

__init__(self, propertyDefinition)
(Constructor)

 

Constructor.

Parameters:
  • propertyRepresentation (PropertyTemplate) - The property definition.
Overrides: object.__init__

__repr__(self)
(Representation operator)

 

Returns a readable representation.

Overrides: object.__repr__

Instance Variable Details [hide private]

identifier

This is the logical identifier of the property.
Get Method:
__getIdentifier(self) - Returns the identifier of the property.

displayName

A readable name that can be presented in a user interface.
Get Method:
__getDisplayName(self) - Returns the display name of the property.

category

This 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
Get Method:
__getCategory(self) - Returns the property category.

description

Describes the purpose of the property.
Get Method:
__getDescription(self) - Returns the property description.

defaultValue

A default value for the property that is used for creation of the property on a resource.
Get Method:
__getDefaultValue(self) - Returns the specific default value.

notNull

Flag indicating if None is a allowed property value or not.
Get Method:
__getNotNull(self) - Returns whether the value can be None or not.

namespace

Name space in which the property is valid, e.g. used to distinguish different name properties of different data types.
Get Method:
__getNamespace(self) - Returns the namespace.

restrictions

This 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.
Get Method:
__getRestrictions(self) - Returns the defined restrictions of the property.

Property Details [hide private]

type

Returns the propertyType.

Get Method:
__getType(self) - Returns the propertyType.