com.wewebu.ow.server.field
Interface OwFieldDefinition

All Known Subinterfaces:
OwPropertyClass
All Known Implementing Classes:
OwFieldPropertyClassWrapper, OwFileObject.OwFilePropertyClass, OwResource.OwClassDescriptionPropertyClass, OwResource.OwObjectNamePropertyClass, OwResource.OwObjectPathPropertyClass, OwResource.OwResourcePropertyClass, OwResource.OwSpecialPropertyClass, OwResource.OwVersionSeriesPropertyClass, OwSearchCriteria, OwSearchCriteriaFieldDefOverride, OwSearchPathField.OwSearchPathFieldClass, OwStandardClassSelectObject.OwStandardClassSelectObjectClass, OwStandardContentBasedRetrivalObject.OwStandardContentBasedRetrivalObjectClass, OwStandardCrossMappings.OwCrossDecoratorSearchNode.OwWrappedSearchCriteria, OwStandardDecoratorFieldDefinition, OwStandardDecoratorSearchCriteria, OwStandardHistoryEntry.OwStandardHistoryEntryPropertyClass, OwStandardPropertyClass, OwStandardSearchTemplate.OwFieldDefinitionEnumExchangeWrapper, OwStandardSearchTemplate.OwOnTheFlySearchFieldDescription, OwVirtualLinkPropertyClasses.OwLinkFilterPropertyClass, OwVirtualLinkPropertyClasses.OwLinkRelationPropertyClass, OwVirtualLinkPropertyClasses.OwLinkSourcePropertyClass, OwVirtualLinkPropertyClasses.OwLinkTargetPropertyClass

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


Method Summary
 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.
 

Method Detail

getClassName

String getClassName()
get the name of the class

Returns:
class name

getDisplayName

String getDisplayName(Locale locale_p)
get the displayable name of the type as defined by the DMS System can be identical to getClassName

Parameters:
locale_p - Locale to use
Returns:
type displayable name of property

getDescription

String getDescription(Locale locale_p)
get the description defined by the DMS System

Parameters:
locale_p - Locale to use
Returns:
type description of property

getJavaClassName

String getJavaClassName()
get the java class name of java object associated with this property

Returns:
java class name

getNativeType

Object getNativeType()
                     throws Exception
get the native type which is defined by the underlying system WARNING: The returned object is opaque. Using this object makes the client dependent on the underlying system

Returns:
Object native Type Object
Throws:
Exception

isEnum

boolean isEnum()
               throws Exception
check if property is a enum type (see getEnums)

Returns:
true if property is a enum type
Throws:
Exception

getEnums

OwEnumCollection getEnums()
                          throws Exception
get a list of enum objects for the enum type (see isEnum)

Returns:
OwEnumCollection of OwEnum objects, which can be used in a select box.
Throws:
Exception

isRequired

boolean isRequired()
                   throws Exception
check if property is required, i.e. must be set by the user

Returns:
true if property is required
Throws:
Exception

getMaxValue

Object getMaxValue()
                   throws Exception
get the max allowed value, or Integer len for String or null if not defined

Throws:
Exception

getMinValue

Object getMinValue()
                   throws Exception
get the min allowed value, or Integer len for String or null if not defined

Throws:
Exception

getDefaultValue

Object getDefaultValue()
                       throws Exception
get the default value

Throws:
Exception

isArray

boolean isArray()
                throws Exception
check if property contains a list of values

Returns:
true if property is array, false if property is scalar
Throws:
Exception

getValueFromNode

Object getValueFromNode(Node node_p)
                        throws Exception
create a value for the field described by this class with the given XML Node serialization

Parameters:
node_p - the serialized value as a XML DOM Node
Returns:
Object the value of the field
Throws:
Exception

getValueFromString

Object getValueFromString(String text_p)
                          throws Exception
create a value for the field described by this class with the given String serialization

Parameters:
text_p - String the serialized value
Returns:
Object the value of the field
Throws:
Exception

getNodeFromValue

Node getNodeFromValue(Object value_p,
                      Document doc_p)
                      throws Exception
create a XML serialization of the given field value

Parameters:
value_p - Object with field value
doc_p - DOM Document to add to
Returns:
DOM Node
Throws:
Exception

getFormat

OwFormat getFormat()
get the formatter object for string representation

Returns:
OwFormat, can be null to use the default format

getOperators

Collection getOperators()
                        throws Exception
get a collection of possible filter / search operators for the field

Returns:
Collection of operators as defined with OwSearchOperator.CRIT_OP_..., or null if no operators are defined
Throws:
Exception

getComplexChildClasses

List getComplexChildClasses()
                            throws Exception
get child properties classes of a complex property class

Returns:
Collection of OwFieldDefinition or null if isComplex is false
Throws:
Exception
See Also:
isComplex()

isComplex

boolean isComplex()
check if the property is a component that contains another child properties

Returns:
true if the property can contains child properties
See Also:
getComplexChildClasses()


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.