public class OwStandardPropertyClass extends Object implements OwPropertyClass
Standard Implementation for property class descriptions.
Class descriptions are defined by the ECM System, the contain information about
the property type.
To be implemented with the specific ECM system.
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
Type | Property and Description |
---|---|
boolean |
isName
check if property is identical the the OwObject.getName Property
|
boolean |
isSystem
check if property is a internal system property and contains no custom object information
|
Modifier and Type | Field and Description |
---|---|
static String |
EXACT_DATE_TEXT_FORMAT
date format with millisecond information for exact date representation
|
protected Object |
m_Default
object representing the default value
|
protected OwString |
m_description
the displayable description of the class
|
protected OwString |
m_DisplayName
the displayable name of the class
|
protected Object |
m_DMSType
the ECM system specific type of the property
|
protected OwEnumCollection |
m_Enums |
protected boolean |
m_fArray
flag indicating, if property is an array of values
|
protected boolean[] |
m_fHidden
flag indicating, that property should not be displayed
|
protected boolean |
m_fName
flag indicating, if property is the name property i.e.
|
protected boolean[] |
m_fReadOnly
flag indicating, if property is read only for each context
|
protected boolean |
m_fRequired
flag indicating, if property is required to be set, i.e.
|
protected boolean |
m_fSystem
flag indicating, if property is a internal system property and contains no custom object information
|
protected Object |
m_MaxValue
object representing the maximum value
|
protected Object |
m_MinValue
object representing the minimum value
|
protected Collection |
m_operators
a collection of possible filter / search operators for the field
|
protected String |
m_strClassName
the name of the class
|
protected String |
m_strJavaClassName
class name of the java object associated with this property
|
CONTEXT_MAX, CONTEXT_NORMAL, CONTEXT_ON_CHECKIN, CONTEXT_ON_CREATE
Constructor and Description |
---|
OwStandardPropertyClass() |
Modifier and Type | Method and Description |
---|---|
String |
getCategory()
get the property category, or an empty string of no category is set
|
String |
getClassName()
get the name of the class
|
static OwPropertyCollection |
getClonedProperties(OwObject object_p,
Collection propertyNames_p)
retrieve the specified properties from the object as a copy
NOTE: The returned collection contains exactly the requested
propertyNames_p, or all if
propertyNames_p == null
NOTE: if the properties where not already obtained from the archive (e.g. |
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 ECM 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 for the field or null if not defined
|
Object |
getMinValue()
get the min allowed value for the field 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
|
static Node |
getNodeFromValue(Object value_p,
Document doc_p,
String javaClassName_p) |
Collection |
getOperators()
get a collection of possible filter / search operators for the field
|
static Object |
getSkalarEmptyValue(String strJavaClassName_p)
get a default empty value for the given class
e.g.: 0 for Integer or "" for String
|
static Object |
getSkalarValueFromString(String strLiteral_p,
String strJavaClassName_p)
create a object from string literal
|
static String |
getStringFromValue(Object value_p,
String strJavaClassName_p)
get a standard string representation of the given value that can be used in getValueFromString
|
Object |
getValueFromNode(Node node_p)
create a value for the field described by this class with the given XML Node serialization
|
static Object |
getValueFromNode(Node node_p,
OwFieldDefinition definition_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
|
static Object |
getValueFromString(String text_p,
OwFieldDefinition definition_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 |
isHidden(int iContext_p)
check if property is visible to the user
|
boolean |
isNameProperty()
check if property is identical the the OwObject.getName Property
|
boolean |
isReadOnly(int iContext_p)
check if property is read only on the class level.
|
boolean |
isRequired()
check if property is required, i.e.
|
boolean |
isSystemProperty()
check if property is a internal system property and contains no custom object information
|
boolean |
isType(Class base_p)
check if given java class name is base type
|
static boolean |
isType(Class base_p,
String sSubJavaClassName_p)
check if given java class name is base type
|
void |
setJavaClassName(String strJavaClassName_p)
set the java classname parameter
|
isSystemProperty
in interface OwPropertyClass
Exception
isNameProperty
in interface OwPropertyClass
Exception
public static final String EXACT_DATE_TEXT_FORMAT
protected String m_strClassName
protected String m_strJavaClassName
protected OwString m_DisplayName
protected OwString m_description
protected boolean m_fSystem
protected boolean[] m_fReadOnly
protected boolean m_fName
protected OwEnumCollection m_Enums
protected boolean m_fRequired
protected boolean m_fArray
protected Object m_DMSType
protected Collection m_operators
protected Object m_MaxValue
protected Object m_MinValue
protected Object m_Default
protected boolean[] m_fHidden
public String getClassName()
getClassName
in interface OwFieldDefinition
public OwFormat getFormat()
getFormat
in interface OwFieldDefinition
public void setJavaClassName(String strJavaClassName_p)
strJavaClassName_p
- a String
public String getDisplayName(Locale locale_p)
getDisplayName
in interface OwFieldDefinition
locale_p
- Locale to usepublic String getDescription(Locale locale_p)
getDescription
in interface OwFieldDefinition
locale_p
- Locale to usepublic String getJavaClassName()
getJavaClassName
in interface OwFieldDefinition
public Object getNativeType() throws Exception
getNativeType
in interface OwFieldDefinition
Exception
public boolean isArray() throws Exception
isArray
in interface OwFieldDefinition
Exception
public boolean isEnum() throws Exception
isEnum
in interface OwFieldDefinition
Exception
public OwEnumCollection getEnums() throws Exception
getEnums
in interface OwFieldDefinition
Exception
public boolean isSystemProperty() throws Exception
isSystemProperty
in interface OwPropertyClass
Exception
public boolean isNameProperty() throws Exception
isNameProperty
in interface OwPropertyClass
Exception
public boolean isRequired() throws Exception
isRequired
in interface OwFieldDefinition
Exception
public boolean isReadOnly(int iContext_p) throws Exception
isReadOnly
in interface OwPropertyClass
iContext_p
- Context in which the property is read-only as defined by CONTEXT_...Exception
public Object getMaxValue() throws Exception
getMaxValue
in interface OwFieldDefinition
Exception
public Object getMinValue() throws Exception
getMinValue
in interface OwFieldDefinition
Exception
public Object getDefaultValue() throws Exception
getDefaultValue
in interface OwFieldDefinition
Exception
public boolean isHidden(int iContext_p) throws Exception
isHidden
in interface OwPropertyClass
iContext_p
- Context in which the property is read-only as defined by CONTEXT_...Exception
public Object getValueFromNode(Node node_p) throws Exception
getValueFromNode
in interface OwFieldDefinition
node_p
- the serialized value as a XML DOM NodeException
public static Object getValueFromNode(Node node_p, OwFieldDefinition definition_p) throws Exception
node_p
- the serialized value as a XML DOM NodeException
public Object getValueFromString(String text_p) throws Exception
getValueFromString
in interface OwFieldDefinition
text_p
- String the serialized valueException
public static Object getValueFromString(String text_p, OwFieldDefinition definition_p) throws Exception
text_p
- String the serialized valueException
public static Object getSkalarEmptyValue(String strJavaClassName_p) throws Exception
strJavaClassName_p
- Exception
public static Object getSkalarValueFromString(String strLiteral_p, String strJavaClassName_p) throws Exception
public Node getNodeFromValue(Object value_p, Document doc_p) throws Exception
getNodeFromValue
in interface OwFieldDefinition
value_p
- Object with field valuedoc_p
- DOM Document to add toException
public static Node getNodeFromValue(Object value_p, Document doc_p, String javaClassName_p) throws Exception
Exception
public static String getStringFromValue(Object value_p, String strJavaClassName_p)
value_p
- getValueFromString(String)
public String getCategory() throws Exception
getCategory
in interface OwPropertyClass
Exception
public Collection getOperators() throws Exception
getOperators
in interface OwFieldDefinition
Exception
public static boolean isType(Class base_p, String sSubJavaClassName_p) throws ClassNotFoundException
base_p
- sSubJavaClassName_p
- ClassNotFoundException
public boolean isType(Class base_p) throws ClassNotFoundException
base_p
- a Class
ClassNotFoundException
public static OwPropertyCollection getClonedProperties(OwObject object_p, Collection propertyNames_p) throws Exception
propertyNames_p == null
object_p
- OwObject to retrieve cloned properties frompropertyNames_p
- a collection of property names to retrieve, if null all properties are retrievedException
public boolean isComplex()
OwFieldDefinition
isComplex
in interface OwFieldDefinition
OwFieldDefinition.getComplexChildClasses()
public List getComplexChildClasses() throws Exception
OwFieldDefinition
getComplexChildClasses
in interface OwFieldDefinition
Exception
OwFieldDefinition.isComplex()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.