com.wewebu.ow.server.ecm

Class OwFileObject.OwFileObjectClass

java.lang.Object

com.wewebu.ow.server.ecm.OwFileObject.OwFileObjectClass

All Implemented Interfaces:

OwObjectClass

Enclosing class:

OwFileObject

public static class OwFileObject.OwFileObjectClass
extends Object
implements OwObjectClass

File documents class definition for the OwFileDocument Object.

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

Fields

Modifier and Type	Field and Description
static String	ID_PROPERTY class name of the ID property, which is also the getID property of the Object
static String	LAST_MODIFIED_PROPERTY class name of the date created property
protected HashMap	m_PropertyClassesMap map containing the property class descriptions of the class
static String	MIME_PROPERTY class name of the size property
static String	NAME_PROPERTY class name of the filename property, which is also the getName property of the Object
static String	SIZE_PROPERTY class name of the size property

Fields inherited from interface com.wewebu.ow.server.ecm.OwObjectClass

OPERATION_TYPE_CHECKIN, OPERATION_TYPE_CHECKOUT, OPERATION_TYPE_CREATE_NEW_OBJECT, OPERATION_TYPE_SET_PROPERTIES, OPERATION_TYPE_UNDEF

Constructor Summary

Constructors

Constructor and Description
OwFileObject.OwFileObjectClass(boolean fDirectory_p) construct PropertyClass Object and set Property classes

Method Summary

Methods

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 fExcludeHidden_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 if we deal with a class tree
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 object class is available, i.e.
boolean	isHidden() check if class is visible to the user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_PROPERTY

public static final String NAME_PROPERTY

class name of the filename property, which is also the getName property of the Object

See Also:

Constant Field Values

ID_PROPERTY

public static final String ID_PROPERTY

class name of the ID property, which is also the getID property of the Object

See Also:

Constant Field Values

LAST_MODIFIED_PROPERTY

public static final String LAST_MODIFIED_PROPERTY

class name of the date created property

See Also:

Constant Field Values

SIZE_PROPERTY

public static final String SIZE_PROPERTY

class name of the size property

See Also:

Constant Field Values

MIME_PROPERTY

public static final String MIME_PROPERTY

class name of the size property

See Also:

Constant Field Values

m_PropertyClassesMap

protected HashMap m_PropertyClassesMap

map containing the property class descriptions of the class

Constructor Detail

OwFileObject.OwFileObjectClass

public OwFileObject.OwFileObjectClass(boolean fDirectory_p)

construct PropertyClass Object and set Property classes

Parameters:

fDirectory_p - true = directory, false = file

Method Detail

getType

public int getType()

get Object type

Specified by:

getType in interface OwObjectClass

Returns:

the type of the object

See Also:

OwObjectReference

getParent

public OwObjectClass getParent()
                        throws Exception

get the parent class of this class if we deal with a class tree

Specified by:

getParent in interface OwObjectClass

Returns:

OwObjectClass Parent or null if no parent is available

Throws:

Exception

getChilds

public List getChilds(OwNetwork network_p,
             boolean fExcludeHidden_p)
               throws Exception

get the child classes of this class if we deal with a class tree

Specified by:

getChilds in interface OwObjectClass

Parameters:

network_p - OwNetwork, in case the class description is static for all users, we can still dynamically load the class members

fExcludeHidden_p - boolean true = exclude all hidden and non instantiable class descriptions

Returns:

List of child classes or null if no children are available

Throws:

Exception

hasChilds

public boolean hasChilds(OwNetwork network_p,
                boolean fExcludeHiddenAndNonInstantiable_p,
                int context_p)

check if children are available

Specified by:

hasChilds in interface OwObjectClass

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

getChildNames

public Map getChildNames(OwNetwork network_p,
                boolean fExcludeHiddenAndNonInstantiable_p)

get the child classes of this class if we deal with a class tree

Specified by:

getChildNames in interface OwObjectClass

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 names, mapped to display names, or null if no class tree is supported

getClassName

public String getClassName()

get the name of the class

Specified by:

getClassName in interface OwObjectClass

Returns:

class name

getID

public String getID()

get the unique ID of the class

Returns:

class ID

getDisplayName

public String getDisplayName(Locale locale_p)

get the displayable name of the type as defined by the ECM System

Specified by:

getDisplayName in interface OwObjectClass

Parameters:

locale_p - Local to use

Returns:

type displayable name of property

getPropertyClass

public OwPropertyClass getPropertyClass(String strClassName_p)
                                 throws Exception

get a map of the available property class descriptions

Specified by:

getPropertyClass in interface OwObjectClass

Parameters:

strClassName_p - Name of class

Returns:

OwPropertyClass instance

Throws:

Exception

getPropertyClassNames

public Collection getPropertyClassNames()
                                 throws Exception

get a list of the available property class descriptions names

Specified by:

getPropertyClassNames in interface OwObjectClass

Returns:

string array of OwPropertyClass Names

Throws:

Exception

getNamePropertyName

public String getNamePropertyName()
                           throws Exception

get the name of the name property

Specified by:

getNamePropertyName in interface OwObjectClass

Returns:

String name of the name property

Throws:

Exception

canCreateNewObject

public boolean canCreateNewObject()
                           throws Exception

check, if new object instances can be created for this class

Specified by:

canCreateNewObject in interface OwObjectClass

Returns:

true, if object can be created

Throws:

Exception

hasVersionSeries

public boolean hasVersionSeries()
                         throws Exception

check if a version series object class is available, i.e. the object is versionable

Specified by:

hasVersionSeries in interface OwObjectClass

Returns:

true if object class is versionable

Throws:

Exception

getDescription

public String getDescription(Locale locale_p)

retrieve a description of the object class

Specified by:

getDescription in interface OwObjectClass

Parameters:

locale_p - Local to use

Returns:

String Description of the object class

isHidden

public boolean isHidden()
                 throws Exception

check if class is visible to the user

Specified by:

isHidden in interface OwObjectClass

Returns:

true if property is visible to the user

Throws:

Exception

getModes

public List getModes(int operation_p)
              throws Exception

Description copied from interface: OwObjectClass

get the available modes for operations like checkin, createNewObject, setProperties

Specified by:

getModes in interface OwObjectClass

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