public interface OwObjectClass
Base interface for object class descriptions.
Class descriptions are defined by the ECM System, they contain information about
the object type and properties.
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 |
---|---|
static int |
OPERATION_TYPE_CHECKIN
operation mode @see
getModes(int) |
static int |
OPERATION_TYPE_CHECKOUT
operation mode @see
getModes(int) |
static int |
OPERATION_TYPE_CREATE_NEW_OBJECT
operation mode @see
getModes(int) |
static int |
OPERATION_TYPE_SET_PROPERTIES
operation mode @see
getModes(int) |
static int |
OPERATION_TYPE_UNDEF
operation mode @see
getModes(int) |
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateNewObject()
check, if new object instances can be created for this class
|
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 symbolic 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
|
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 type of associated object
|
boolean |
hasChilds(OwNetwork network_p,
boolean fExcludeHiddenAndNonInstantiable_p,
int context_p)
check if children are available
|
boolean |
hasVersionSeries()
check if a version series object class is available, i.e.
|
boolean |
isHidden()
check if class is visible to the user
|
static final int OPERATION_TYPE_UNDEF
getModes(int)
static final int OPERATION_TYPE_SET_PROPERTIES
getModes(int)
static final int OPERATION_TYPE_CHECKIN
getModes(int)
static final int OPERATION_TYPE_CHECKOUT
getModes(int)
static final int OPERATION_TYPE_CREATE_NEW_OBJECT
getModes(int)
int getType()
OwObjectReference
List getChilds(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p) throws Exception
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
Map getChildNames(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p) throws Exception
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
boolean hasChilds(OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p, int context_p) throws Exception
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
- OwStatusContextDefinitionsException
String getClassName()
String getDisplayName(Locale locale_p)
locale_p
- Local to useOwPropertyClass getPropertyClass(String strClassName_p) throws Exception
strClassName_p
- Name of classException
Collection getPropertyClassNames() throws Exception
Exception
String getNamePropertyName() throws Exception
Exception
boolean canCreateNewObject() throws Exception
Exception
boolean hasVersionSeries() throws Exception
Exception
List getModes(int operation_p) throws Exception
operation_p
- int as defined with OPERATION_TYPE_...Exception
String getDescription(Locale locale_p)
locale_p
- Local to useboolean isHidden() throws Exception
Exception
OwObjectClass getParent() throws Exception
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.