public interface OwFieldDefinition
Base interface for property class and Search Fields. Used in the PropertyFieldManager to display and edit fields.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Method and Description |
---|---|
String |
getClassName()
get the name of the class
|
List |
getComplexChildClasses()
get child properties classes of a complex property class
|
Object |
getDefaultValue()
get the default value
|
String |
getDescription(Locale locale_p)
get the description defined by the DMS System
|
String |
getDisplayName(Locale locale_p)
get the displayable name of the type as defined by the DMS System
can be identical to getClassName
|
OwEnumCollection |
getEnums()
get a list of enum objects for the enum type (see isEnum)
|
OwFormat |
getFormat()
get the formatter object for string representation
|
String |
getJavaClassName()
get the java class name of java object associated with this property
|
Object |
getMaxValue()
get the max allowed value, or Integer len for String or null if not defined
|
Object |
getMinValue()
get the min allowed value, or Integer len for String or null if not defined
|
Object |
getNativeType()
get the native type which is defined by the underlying system
WARNING: The returned object is opaque.
|
Node |
getNodeFromValue(Object value_p,
Document doc_p)
create a XML serialization of the given field value
|
Collection |
getOperators()
get a collection of possible filter / search operators for the field
|
Object |
getValueFromNode(Node node_p)
create a value for the field described by this class with the given XML Node serialization
|
Object |
getValueFromString(String text_p)
create a value for the field described by this class with the given String serialization
|
boolean |
isArray()
check if property contains a list of values
|
boolean |
isComplex()
check if the property is a component that contains another child properties
|
boolean |
isEnum()
check if property is a enum type (see getEnums)
|
boolean |
isRequired()
check if property is required, i.e.
|
String getClassName()
String getDisplayName(Locale locale_p)
locale_p
- Locale to useString getDescription(Locale locale_p)
locale_p
- Locale to useString getJavaClassName()
Object getNativeType() throws Exception
Exception
boolean isEnum() throws Exception
Exception
OwEnumCollection getEnums() throws Exception
Exception
boolean isRequired() throws Exception
Exception
Object getMaxValue() throws Exception
Exception
Object getMinValue() throws Exception
Exception
boolean isArray() throws Exception
Exception
Object getValueFromNode(Node node_p) throws Exception
node_p
- the serialized value as a XML DOM NodeException
Object getValueFromString(String text_p) throws Exception
text_p
- String the serialized valueException
Node getNodeFromValue(Object value_p, Document doc_p) throws Exception
value_p
- Object with field valuedoc_p
- DOM Document to add toException
OwFormat getFormat()
Collection getOperators() throws Exception
Exception
List getComplexChildClasses() throws Exception
Exception
isComplex()
boolean isComplex()
getComplexChildClasses()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.