public class OwStandardObjectClass extends Object implements OwObjectClass
Class descriptions are defined by the ECM System, the contain information about
the object 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
Modifier and Type | Field and Description |
---|---|
protected OwString |
m_Description
a description of the object class
|
protected OwString |
m_DisplayName |
protected boolean |
m_fCanCreateNewObject |
protected boolean |
m_fHidden |
protected boolean |
m_fVersionable
flag indicating if a version series objectclass is available, i.e.
|
protected int |
m_iType |
protected OwObjectClass |
m_parent
the parent class of this class
|
protected Map |
m_PropertyClassesMap
map containing the property class descriptions of the class
|
protected Collection |
m_propertyKeyList
optional backup list for predictable order of keys (ClassNames)
|
protected String |
m_strClassName |
protected String |
m_strNamePropertyName |
OPERATION_TYPE_CHECKIN, OPERATION_TYPE_CHECKOUT, OPERATION_TYPE_CREATE_NEW_OBJECT, OPERATION_TYPE_SET_PROPERTIES, OPERATION_TYPE_UNDEF
Constructor and Description |
---|
OwStandardObjectClass()
default constructor, override with subclass
|
OwStandardObjectClass(String classname_p,
int iType_p)
simple constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateNewObject()
check, if new object instances can be created for this class
|
static Object |
createInitialNullValue(OwFieldDefinition fieldDefinition_p,
boolean fArrayInit_p)
create a null value for the given field definition
in case of a complex value, returns an array of null's for the complex properties
|
static int |
getBaseObjectType(int iObjectType_p)
get the base defining type for the given object type.
|
Map |
getChildNames(OwNetwork network_p,
boolean fExcludeHiddenAndNonInstantiable_p)
get the child classes of this class if we deal with a class tree
|
List |
getChilds(OwNetwork network_p,
boolean fExcludeHiddenAndNonInstantiable_p)
get the child classes of this class if we deal with a class tree
|
String |
getClassName()
get the name of the class
|
String |
getDescription(Locale locale_p)
retrieve a description of the object class
|
String |
getDisplayName(Locale locale_p)
get the displayable name of the type as defined by the ECM System
|
String |
getID()
get the unique ID of the class
|
List |
getModes(int operation_p)
get the available modes for operations like checkin, createNewObject, setProperties
|
String |
getNamePropertyName()
get the name of the name property
|
OwObjectClass |
getParent()
get the parent class of this class
|
OwPropertyClass |
getPropertyClass(String strClassName_p)
get a map of the available property class descriptions
|
Collection |
getPropertyClassNames()
get a list of the available property class descriptions names
|
int |
getType()
get Object type
|
boolean |
hasChilds(OwNetwork network_p,
boolean fExcludeHiddenAndNonInstantiable_p,
int context_p)
check if children are available
|
boolean |
hasVersionSeries()
check if a version series objectclass is available, i.e.
|
static boolean |
isContainerType(int iObjectType_p)
check if a given type is a container type like a folder
|
static boolean |
isContentType(int iObjectType_p)
check if a given type is a Content type, like a document
|
boolean |
isHidden()
check if class is visible to the user
|
static boolean |
isTupleType(int iObjectType_p)
check if a given type is a Tuple type, like a custom object
|
static boolean |
isWorkflowObjectType(int iObjectType_p)
check if a given type is a Tuple type, like a custom object
|
String |
toString() |
protected Map m_PropertyClassesMap
protected Collection m_propertyKeyList
protected boolean m_fCanCreateNewObject
protected String m_strClassName
protected String m_strNamePropertyName
protected OwObjectClass m_parent
protected OwString m_DisplayName
protected boolean m_fHidden
protected int m_iType
protected boolean m_fVersionable
protected OwString m_Description
public OwStandardObjectClass()
public OwStandardObjectClass(String classname_p, int iType_p)
classname_p
- public static int getBaseObjectType(int iObjectType_p)
iObjectType_p
- object type as defined in OwObjectReference OBJECT_TYPE_...public static boolean isContainerType(int iObjectType_p)
iObjectType_p
- int object typepublic static boolean isContentType(int iObjectType_p)
iObjectType_p
- int object typepublic static boolean isTupleType(int iObjectType_p)
iObjectType_p
- int object typepublic static boolean isWorkflowObjectType(int iObjectType_p)
iObjectType_p
- int object typepublic int getType()
getType
in interface OwObjectClass
OwObjectReference
public Map getChildNames(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p) throws Exception
getChildNames
in interface OwObjectClass
network_p
- OwNetwork, in case the class description is static for all users, we can still dynamically load the class membersfExcludeHiddenAndNonInstantiable_p
- boolean true = exclude all hidden and non instantiable class descriptionsException
public boolean hasChilds(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p, int context_p)
hasChilds
in interface OwObjectClass
network_p
- OwNetwork, in case the class description is static for all users, we can still dynamically load the class membersfExcludeHiddenAndNonInstantiable_p
- boolean true = exclude all hidden and non instantiable class descriptionscontext_p
- OwStatusContextDefinitionspublic List getChilds(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p) throws Exception
getChilds
in interface OwObjectClass
network_p
- OwNetwork, in case the class description is static for all users, we can still dynamically load the class membersfExcludeHiddenAndNonInstantiable_p
- boolean true = exclude all hidden and non instantiable class descriptionsException
public String getClassName()
getClassName
in interface OwObjectClass
public String getID()
public String getDisplayName(Locale locale_p)
getDisplayName
in interface OwObjectClass
locale_p
- Local to usepublic OwPropertyClass getPropertyClass(String strClassName_p) throws Exception
getPropertyClass
in interface OwObjectClass
strClassName_p
- Name of classException
public Collection getPropertyClassNames() throws Exception
getPropertyClassNames
in interface OwObjectClass
Exception
public String getNamePropertyName() throws Exception
getNamePropertyName
in interface OwObjectClass
Exception
public boolean canCreateNewObject() throws Exception
canCreateNewObject
in interface OwObjectClass
Exception
public boolean hasVersionSeries() throws Exception
hasVersionSeries
in interface OwObjectClass
Exception
public String getDescription(Locale locale_p)
getDescription
in interface OwObjectClass
locale_p
- Local to usepublic boolean isHidden() throws Exception
isHidden
in interface OwObjectClass
Exception
public OwObjectClass getParent() throws Exception
getParent
in interface OwObjectClass
Exception
public List getModes(int operation_p) throws Exception
OwObjectClass
getModes
in interface OwObjectClass
operation_p
- int as defined with OPERATION_TYPE_...Exception
public static Object createInitialNullValue(OwFieldDefinition fieldDefinition_p, boolean fArrayInit_p) throws Exception
fieldDefinition_p
- fArrayInit_p
- true = create a initial value for an array element, false = create initial value for the whole arrayException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.