public abstract class OwStandardDecoratorFieldDefinition extends Object implements OwFieldDefinition
OwFieldDefinition wrapper to implement a decorator pattern.
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
Constructor and Description |
---|
OwStandardDecoratorFieldDefinition() |
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
|
abstract OwFieldDefinition |
getWrappedFieldDefinition()
get the decorated object, to be implemented be overridden classes
|
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.
|
public abstract OwFieldDefinition getWrappedFieldDefinition()
public String getClassName()
OwFieldDefinition
getClassName
in interface OwFieldDefinition
public List getComplexChildClasses() throws Exception
OwFieldDefinition
getComplexChildClasses
in interface OwFieldDefinition
Exception
OwFieldDefinition.isComplex()
public Object getDefaultValue() throws Exception
OwFieldDefinition
getDefaultValue
in interface OwFieldDefinition
Exception
public String getDescription(Locale locale_p)
OwFieldDefinition
getDescription
in interface OwFieldDefinition
locale_p
- Locale to usepublic String getDisplayName(Locale locale_p)
OwFieldDefinition
getDisplayName
in interface OwFieldDefinition
locale_p
- Locale to usepublic OwEnumCollection getEnums() throws Exception
OwFieldDefinition
getEnums
in interface OwFieldDefinition
Exception
public OwFormat getFormat()
OwFieldDefinition
getFormat
in interface OwFieldDefinition
public String getJavaClassName()
OwFieldDefinition
getJavaClassName
in interface OwFieldDefinition
public Object getMaxValue() throws Exception
OwFieldDefinition
getMaxValue
in interface OwFieldDefinition
Exception
public Object getMinValue() throws Exception
OwFieldDefinition
getMinValue
in interface OwFieldDefinition
Exception
public Object getNativeType() throws Exception
OwFieldDefinition
getNativeType
in interface OwFieldDefinition
Exception
public Node getNodeFromValue(Object value_p, Document doc_p) throws Exception
OwFieldDefinition
getNodeFromValue
in interface OwFieldDefinition
value_p
- Object with field valuedoc_p
- DOM Document to add toException
public Collection getOperators() throws Exception
OwFieldDefinition
getOperators
in interface OwFieldDefinition
Exception
public Object getValueFromNode(Node node_p) throws Exception
OwFieldDefinition
getValueFromNode
in interface OwFieldDefinition
node_p
- the serialized value as a XML DOM NodeException
public Object getValueFromString(String text_p) throws Exception
OwFieldDefinition
getValueFromString
in interface OwFieldDefinition
text_p
- String the serialized valueException
public boolean isArray() throws Exception
OwFieldDefinition
isArray
in interface OwFieldDefinition
Exception
public boolean isComplex()
OwFieldDefinition
isComplex
in interface OwFieldDefinition
OwFieldDefinition.getComplexChildClasses()
public boolean isEnum() throws Exception
OwFieldDefinition
isEnum
in interface OwFieldDefinition
Exception
public boolean isRequired() throws Exception
OwFieldDefinition
isRequired
in interface OwFieldDefinition
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.