com.wewebu.ow.server.ecm
Interface OwObjectClass

All Known Implementing Classes:
OwFileObject.OwFileObjectClass, OwSessionHistoryEntry.OwSessionHistoryEntryObjectClass, OwStandardHistoryEntry.OwStandardHistoryEntryObjectClass, OwStandardObjectClass, OwStandardVirtualFolderObjectFactory.OwVirtualFolderObjectClass

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


Field Summary
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)
 
Method Summary
 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
 

Field Detail

OPERATION_TYPE_UNDEF

static final int OPERATION_TYPE_UNDEF
operation mode @see getModes(int)

See Also:
Constant Field Values

OPERATION_TYPE_SET_PROPERTIES

static final int OPERATION_TYPE_SET_PROPERTIES
operation mode @see getModes(int)

See Also:
Constant Field Values

OPERATION_TYPE_CHECKIN

static final int OPERATION_TYPE_CHECKIN
operation mode @see getModes(int)

See Also:
Constant Field Values

OPERATION_TYPE_CHECKOUT

static final int OPERATION_TYPE_CHECKOUT
operation mode @see getModes(int)

See Also:
Constant Field Values

OPERATION_TYPE_CREATE_NEW_OBJECT

static final int OPERATION_TYPE_CREATE_NEW_OBJECT
operation mode @see getModes(int)

See Also:
Constant Field Values
Method Detail

getType

int getType()
get type of associated object

Returns:
the type of the object
See Also:
OwObjectReference

getChilds

List getChilds(OwNetwork network_p,
               boolean fExcludeHiddenAndNonInstantiable_p)
               throws Exception
get the child classes of this class if we deal with a class tree

Parameters:
network_p - OwNetwork, in case the class description is static for all users, we can still dynamically load the class members
fExcludeHiddenAndNonInstantiable_p - boolean true = exclude all hidden and non instantiable class descriptions
Returns:
List of child classes, or null if no class tree is supported
Throws:
Exception

getChildNames

Map getChildNames(OwNetwork network_p,
                  boolean fExcludeHiddenAndNonInstantiable_p)
                  throws Exception
get the child classes of this class if we deal with a class tree

Parameters:
network_p - OwNetwork, in case the class description is static for all users, we can still dynamically load the class members
fExcludeHiddenAndNonInstantiable_p - boolean true = exclude all hidden and non instantiable class descriptions
Returns:
Map of child class symbolic name keys, mapped to display names, or null if no class tree is supported
Throws:
Exception

hasChilds

boolean hasChilds(OwNetwork network_p,
                  boolean fExcludeHiddenAndNonInstantiable_p,
                  int context_p)
                  throws Exception
check if children are available

Parameters:
network_p - OwNetwork, in case the class description is static for all users, we can still dynamically load the class members
fExcludeHiddenAndNonInstantiable_p - boolean true = exclude all hidden and non instantiable class descriptions
context_p - OwStatusContextDefinitions
Returns:
Map of child class symbolic names, mapped to display names, or null if no class tree is supported
Throws:
Exception

getClassName

String getClassName()
get the symbolic name of the class

Returns:
class name

getDisplayName

String getDisplayName(Locale locale_p)
get the displayable name of the type as defined by the ECM System

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

getPropertyClass

OwPropertyClass getPropertyClass(String strClassName_p)
                                 throws Exception
get a map of the available property class descriptions

Parameters:
strClassName_p - Name of class
Returns:
OwPropertyClass instance
Throws:
Exception

getPropertyClassNames

Collection getPropertyClassNames()
                                 throws Exception
get a list of the available property class descriptions names

Returns:
string Collection of String Names
Throws:
Exception

getNamePropertyName

String getNamePropertyName()
                           throws Exception
get the name of the name property

Returns:
String name of the name property
Throws:
Exception

canCreateNewObject

boolean canCreateNewObject()
                           throws Exception
check, if new object instances can be created for this class

Returns:
true, if object can be created
Throws:
Exception

hasVersionSeries

boolean hasVersionSeries()
                         throws Exception
check if a version series object class is available, i.e. the object is versionable

Returns:
true if object class is versionable
Throws:
Exception

getModes

List getModes(int operation_p)
              throws Exception
get the available modes for operations like checkin, createNewObject, setProperties

Parameters:
operation_p - int as defined with OPERATION_TYPE_...
Returns:
List of OwEnum objects, or null if no modes are defined for the given operation
Throws:
Exception

getDescription

String getDescription(Locale locale_p)
retrieve a description of the object class

Parameters:
locale_p - Local to use
Returns:
String Description of the object class

isHidden

boolean isHidden()
                 throws Exception
check if class is visible to the user

Returns:
true if property is visible to the user
Throws:
Exception

getParent

OwObjectClass getParent()
                        throws Exception
get the parent class of this class

Returns:
OwObjectClass parent or null if topmost class
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.