com.wewebu.ow.server.ecm

Class OwFileObject

java.lang.Object

com.wewebu.ow.server.ecm.OwFileObject

All Implemented Interfaces:

OwPageableObject<OwFileObject>, OwContentCollection, OwContentElement, OwObject, OwObjectReference, OwFieldProvider

public class OwFileObject
extends Object
implements OwObject, OwContentCollection, OwContentElement, OwPageableObject<OwFileObject>

Implements OwObject for files on the files system. A useful class when working with configuration XML-Files, which can not be stored on the 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OwFileObject.OwFileObjectClass File documents class definition for the OwFileDocument Object.
protected static class	OwFileObject.OwFilePropertyClass Property class definition for the OwStandardProperty properties.
protected static class	OwFileObject.OwObjectFileFilter a file filter that accepts only the given object types array

Field Summary

Fields

Modifier and Type	Field and Description
protected static OwFileObject.OwFileObjectClass	m_DirectoryClassDescription the one and only class description for the file objects
protected OwEventManager	m_eventmanager
protected File	m_File reference to the file the object is pointing to
protected static OwFileObject.OwFileObjectClass	m_FileClassDescription the one and only class description for the file objects
protected Locale	m_locale
protected OwPropertyCollection	m_PropertyMap map containing the properties of the file document object

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

CONTENT_REPRESENTATION_TYPE_NONE, CONTENT_REPRESENTATION_TYPE_OBJECT, CONTENT_REPRESENTATION_TYPE_STREAM, CONTENT_REPRESENTATION_TYPE_URL, CONTENT_REPRESENTATION_TYPE_USER_START, CONTENT_TYPE_ANNOTATION, CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_SECURITY, CONTENT_TYPE_USER_START

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

STANDARD_PATH_DELIMITER

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

OBJECT_TYPE_ALL_CONTAINER_OBJECTS, OBJECT_TYPE_ALL_CONTENT_OBJECTS, OBJECT_TYPE_ALL_TUPLE_OBJECTS, OBJECT_TYPE_ALL_WORKFLOW_OBJECTS, OBJECT_TYPE_BPM_ROOT_FOLDER, OBJECT_TYPE_CONTAINER_USER_START, OBJECT_TYPE_CONTENT_USER_START, OBJECT_TYPE_CROSS_QUEUE_FOLDER, OBJECT_TYPE_CUSTOM, OBJECT_TYPE_DOCUMENT, OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER, OBJECT_TYPE_ECM_ROOT_FOLDER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_HISTORY, OBJECT_TYPE_LINK, OBJECT_TYPE_PROXY_QUEUE_FOLDER, OBJECT_TYPE_PUBLIC_QUEUE_FOLDER, OBJECT_TYPE_ROSTER_FOLDER, OBJECT_TYPE_ROSTERITEM, OBJECT_TYPE_STORED_SEARCH, OBJECT_TYPE_SYS_QUEUE_FOLDER, OBJECT_TYPE_TRACKER_QUEUE_FOLDER, OBJECT_TYPE_TUPLE_USER_START, OBJECT_TYPE_UNDEFINED, OBJECT_TYPE_USER_QUEUE_FOLDER, OBJECT_TYPE_VIRTUAL_FOLDER, OBJECT_TYPE_WORKFLOW_USER_START, OBJECT_TYPE_WORKITEM, OBJECT_TYPE_WORKITEM_PROXY, OBJECT_TYPE_WORKITEM_TRACKER

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OwFileObject() default constructor for overriding classes
	OwFileObject(OwNetwork<?> network_p, File file_p) construct File Object
	OwFileObject(OwNetwork<?> network_p, File file_p, String fileName_p) FileObject where the file (name and extension) is encrypted for security reasons, and MIME type and file name can be defined separately.
	OwFileObject(OwNetwork network_p, File file_p, String fileName_p, String mimeType_p) FileObject where the file (name and extension) is encrypted for security reasons, and MIME type and file name can be defined separately.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(OwObject oObject_p) adds a object reference to this parent object / folder
boolean	canAdd(OwObject oObject_p, int iContext_p) checks if object supports add function
boolean	canChangeClass() check if object can change its class
boolean	canDelete(int iContext_p) check if object can be deleted
boolean	canFilterChilds() check if the FilterCriteria_p in getChilds is possible NOTE: The FilterCriteria_p parameter in getChilds is an additional filter to the internal SearchTemplate used in the getSearchTemplate(...) function The internal SearchTemplate used in the getSearchTemplate(...) is used for virtual folders, the FilterCriteria_p is used to refine the result of a node
boolean	canGetContent(int iContentType_p, int iContext_p) check if content retrieval is allowed
boolean	canGetPermissions() check if permissions are accessible
boolean	canGetProperties(int iContext_p) check if property retrieval is allowed
boolean	canLock() check if object supports lock mechanism
boolean	canMove(OwObject oObject_p, OwObject oldParent_p, int iContext_p) check if move operation is allowed
boolean	canRemoveReference(OwObject oObject_p, int iContext_p) checks if the reference can be removed this object needs to be parent of given object, and user needs to have sufficient access rights
boolean	canSetContent(int iContentType_p, int iContext_p) check if content can be set on this document with setContent
boolean	canSetPermissions() check if permissions can be set
boolean	canSetProperties(int iContext_p) check if object allows to set / change properties
void	changeClass(String strNewClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p) change the class of the object
protected OwFileObject	createFileObject(File file_p) overridable factory method
void	delete() delete object and all references from DB
boolean	exists()
int	getChildCount(int[] iObjectTypes_p, int iContext_p) get the number of children
OwIterable<OwFileObject>	getChildren(OwLoadContext filter)
OwObjectCollection	getChilds(int[] iObjectTypes_p, Collection propertyNames_p, OwSort sort_p, int iMaxSize_p, int iVersionSelection_p, OwSearchNode filterCriteria_p) get the children of the object, does NOT cache the returned object
String	getClassName() get the class name of the object, the class names are defined by the ECM System
OwPermissionCollection	getClonedPermissions() get the cloned permissions
OwPropertyCollection	getClonedProperties(Collection propertyNames_p) retrieve the specified properties from the object as a copy NOTE: The returned collection might contain more Properties than requested with PropertyNames_p NOTE: if the properties where not already obtained from the archive (e.g.
Collection	getColumnInfoList() get the column info list that describes the columns for the child list
OwContentCollection	getContentCollection() get the content of the object
OwContentElement	getContentElement(int iContentType_p, int iPage_p) get a content element for the given type and page
String	getContentFilePath() get the file path to the content (optional, only available if content is stored locally) NOTE: This function is only used for ECM Systems which can only download through files If a FilePath exists, a stream will also exist.
Object	getContentObject() get the content object The content representation is of type Object
int	getContentRepresentation() get the content representation, which can be either url, stream or object
InputStream	getContentStream(OutputStream out_p) get the content from the object.
Collection	getContentTypes() get a list of content types used in this object
String	getContentURL() get the content URL from the object.
String	getDMSID() get the ECM specific ID of the Object.
OwField	getField(String strFieldClassName_p) implementation of the OwFieldProvider interface get a field with the given field definition class name
String	getFieldProviderName() get a name that identifies the field provider, can be used to create IDs
Object	getFieldProviderSource() get the source object that originally provided the fields.
int	getFieldProviderType() get the type of field provider as defined with TYPE_...
Collection	getFields() get all the properties in the form
File	getFileObject() get the internal java file object
Collection	getFilterProperties(Collection propertynames_p) get a collection of OwFieldDefinition's for a given list of names
String	getID() get Object symbolic name of the object which is unique among its siblings used for path construction
OwObject	getInstance() get a instance from this reference
boolean	getLock(int iContext_p) get the lock state of the object
String	getLockUserID(int iContext_p) get the lock user of the object
String	getMIMEParameter() get the additional MIME Parameter of the Object
String	getMIMEType() get the MIME Type of the Object
boolean	getMyLock(int iContext_p) get the lock state of the object for the CURRENTLY logged on user
String	getName() get Object name property string
Object	getNativeObject() get the native object from the ECM system WARNING: The returned object is Opaque.
protected OwNetwork<?>	getNetwork() get reference to the network used internally by the objects
OwObjectClass	getObjectClass() get the class description of the object, the class descriptions are defined by the ECM System
int	getPageCount() retrieve the number of pages in the objects
int	getPageNumber(int lPageIndex_p) retrieve the page number for the given zero based index NOTE: the Page numbers might be arbitrary in the collection in order to submit specific page content
OwObjectCollection	getParents() get the containing parent of this object, does NOT cache returned objects
String	getPath() get the path to the object, which can be used in OwNetwork.getObjectFromPath to recreate the object The path is build with the name property.
OwPermissionCollection	getPermissions() get the permissions object
OwPropertyCollection	getProperties(Collection propertyNames_p) retrieve the specified properties from the object.
OwProperty	getProperty(String strPropertyName_p) retrieve the specified property from the object.
OwResource	getResource() get the resource the object belongs to in a multiple resource Network
String	getResourceID() get the ID / name identifying the resource the object belongs to
Object	getSafeFieldValue(String sName_p, Object defaultvalue_p) retrieve the value of a Field
OwSearchTemplate	getSearchTemplate() get a search template associated with this Object The search from the template can be used to refine the result in getChilds(...) ==> The search is automatically performed when calling getChilds(...) The ColumnInfoList from the template can be used to format the result list of the children NOTE: This function is especially used in virtual folders
int	getType() get Object type
OwVersion	getVersion() get the current version object
OwVersionSeries	getVersionSeries() get the version series object to this object, if the object is versionable
boolean	hasChilds(int[] iObjectTypes_p, int iContext_p) check if object has children
boolean	hasContent(int iContext_p) check if the object contains a content, which can be retrieved using getContentCollection
boolean	hasVersionSeries() check if a version series object is available, i.e.
boolean	isInputStreamNative() check if getContentStream is based on an native InputStream or OutputStream NOTE: getContentStream must implement for Input- and OutputStream.
protected void	loadProperties() load all properties of the file.
void	move(OwObject oObject_p, OwObject oldParent_p) moves a object reference to this parent object (folder)
void	refreshProperties() refresh the property cache
void	refreshProperties(Collection props_p) refresh the property cache
void	releaseResources() method is called e.g.
void	removeReference(OwObject oObject_p) removes the reference of the given object from this object (folder) this object needs to be parent of given object
void	setContentCollection(OwContentCollection content_p) set the content to the object
void	setField(String sName_p, Object value_p) modify a Field value, but does not save the value right away
boolean	setLock(boolean fLock_p) lock / unlock object, make it unaccessible for other users
void	setPermissions(OwPermissionCollection permissions_p) set the permissions object
void	setProperties(OwPropertyCollection properties_p) set the properties in the object
void	setProperties(OwPropertyCollection properties_p, Object mode_p) set the properties in the object

Methods inherited from class java.lang.Object

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

Field Detail

m_File

protected File m_File

reference to the file the object is pointing to

m_PropertyMap

protected OwPropertyCollection m_PropertyMap

map containing the properties of the file document object

m_FileClassDescription

protected static final OwFileObject.OwFileObjectClass m_FileClassDescription

the one and only class description for the file objects

m_DirectoryClassDescription

protected static final OwFileObject.OwFileObjectClass m_DirectoryClassDescription

the one and only class description for the file objects

m_eventmanager

protected OwEventManager m_eventmanager

m_locale

protected Locale m_locale

Constructor Detail

OwFileObject

protected OwFileObject()
                throws Exception

default constructor for overriding classes

Throws:

Exception

OwFileObject

public OwFileObject(OwNetwork<?> network_p,
            File file_p)
             throws Exception

construct File Object

Parameters:

network_p - reference to the network Adapter

file_p - reference to the file, the object is working on

Throws:

Exception

OwFileObject

public OwFileObject(OwNetwork<?> network_p,
            File file_p,
            String fileName_p)
             throws Exception

FileObject where the file (name and extension) is encrypted for security reasons, and MIME type and file name can be defined separately.

Parameters:

network_p - OwNetwork to use for localization

file_p - java.io.File location of the file

fileName_p - String file name

Throws:

Exception

Since:

4.0.0.0

OwFileObject

public OwFileObject(OwNetwork network_p,
            File file_p,
            String fileName_p,
            String mimeType_p)
             throws Exception

FileObject where the file (name and extension) is encrypted for security reasons, and MIME type and file name can be defined separately.

Parameters:

network_p - OwNetwork to use for localization

file_p - java.io.File location of the file

fileName_p - String file name

mimeType_p - String MIME type for this object

Throws:

Exception

Since:

2.5.2.0

Method Detail

getNetwork

protected OwNetwork<?> getNetwork()

get reference to the network used internally by the objects

getFileObject

public File getFileObject()

get the internal java file object

Returns:

File

exists

public boolean exists()

loadProperties

protected void loadProperties()
                       throws Exception

load all properties of the file. There are so little, we just load all at once

Throws:

Exception

getName

public String getName()

get Object name property string

Specified by:

getName in interface OwObjectReference

Returns:

the name property string of the object

getID

public String getID()

get Object symbolic name of the object which is unique among its siblings used for path construction

Specified by:

getID in interface OwObjectReference

Returns:

the symbolic name of the object which is unique among its siblings

getClassName

public String getClassName()

get the class name of the object, the class names are defined by the ECM System

Specified by:

getClassName in interface OwObject

Returns:

class name of object class

getObjectClass

public OwObjectClass getObjectClass()

get the class description of the object, the class descriptions are defined by the ECM System

Specified by:

getObjectClass in interface OwObject

Returns:

class description name of object class

setContentCollection

public void setContentCollection(OwContentCollection content_p)
                          throws Exception

set the content to the object

Specified by:

setContentCollection in interface OwObject

Parameters:

content_p - OwContentCollection to store in the object

Throws:

Exception

getContentURL

public String getContentURL()
                     throws Exception

get the content URL from the object.

Specified by:

getContentURL in interface OwContentElement

Returns:

String with URL to the resource where the content can be retrieved

Throws:

Exception

isInputStreamNative

public boolean isInputStreamNative()

check if getContentStream is based on an native InputStream or OutputStream NOTE: getContentStream must implement for Input- and OutputStream. However for optimization the ContentCollection will tell, whether it is based on an InputStream or an OutputStream.

Specified by:

isInputStreamNative in interface OwContentElement

Returns:

true = InputStream is native, false = OutputStream is native

getContentObject

public Object getContentObject()
                        throws Exception

get the content object The content representation is of type Object

Specified by:

getContentObject in interface OwContentElement

Returns:

Object to content access

Throws:

Exception

getContentRepresentation

public int getContentRepresentation()
                             throws Exception

get the content representation, which can be either url, stream or object

Specified by:

getContentRepresentation in interface OwContentElement

Returns:

int with content representation type

Throws:

Exception

getContentStream

public InputStream getContentStream(OutputStream out_p)
                             throws Exception

get the content from the object. If the document is a multipage document, the first page is retrieved unless otherwise set in setPage(...) NOTE: For performance and optimization reasons both the optional return of an InputStream and writing to the given OutputStream MUST be implemented

Specified by:

getContentStream in interface OwContentElement

Parameters:

out_p - optional OutputStream, if set the method writes the OutputStream and returns null, otherwise it returns an InputStream

Returns:

content from the object, or throws OwContentNotFoundException if no content is available

Throws:

Exception

canSetContent

public boolean canSetContent(int iContentType_p,
                    int iContext_p)
                      throws Exception

check if content can be set on this document with setContent

Specified by:

canSetContent in interface OwObject

Parameters:

iContentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)

iContext_p - OwStatusContextDefinitions

Returns:

true, if content can be set with setContent

Throws:

Exception

canGetContent

public boolean canGetContent(int iContentType_p,
                    int iContext_p)
                      throws Exception

check if content retrieval is allowed

Specified by:

canGetContent in interface OwObject

Parameters:

iContentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)

iContext_p - OwStatusContextDefinitions

Returns:

true if allowed

Throws:

Exception

getContentTypes

public Collection getContentTypes()
                           throws Exception

get a list of content types used in this object

Specified by:

getContentTypes in interface OwContentCollection

Returns:

List of int content types

Throws:

Exception

getType

public int getType()

get Object type

Specified by:

getType in interface OwObjectReference

Returns:

the type of the object

getParents

public OwObjectCollection getParents()
                              throws Exception

get the containing parent of this object, does NOT cache returned objects

Specified by:

getParents in interface OwObject

Returns:

Parent Object, or null if object does not have any parents

Throws:

Exception

getChilds

public OwObjectCollection getChilds(int[] iObjectTypes_p,
                           Collection propertyNames_p,
                           OwSort sort_p,
                           int iMaxSize_p,
                           int iVersionSelection_p,
                           OwSearchNode filterCriteria_p)
                             throws Exception

get the children of the object, does NOT cache the returned object

Specified by:

getChilds in interface OwObject

Parameters:

iObjectTypes_p - the requested object types (folder or document)

propertyNames_p - properties to fetch from ECM system along with the children, can be null.

sort_p - OwSort Sortcriteria list to sort return list

iMaxSize_p - int maximum number of objects to retrieve

iVersionSelection_p - int Selects the versions as defined in OwSearchTemplate.VERSION_SELECT_...

filterCriteria_p - optional OwSearchNode to filter the children, can be null NOTE: This parameter is an additional filter to the internal SearchTemplate used in the getSearchTemplate(...) function The internal SearchTemplate used in the getSearchTemplate(...) is used for virtual folders, the FilterCriteria_p is used to refine the result of a node

Returns:

list of child objects, or null

Throws:

Exception

createFileObject

protected OwFileObject createFileObject(File file_p)
                                 throws Exception

overridable factory method

Parameters:

file_p -

Returns:

an OwFileObject

Throws:

Exception

canFilterChilds

public boolean canFilterChilds()
                        throws Exception

check if the FilterCriteria_p in getChilds is possible NOTE: The FilterCriteria_p parameter in getChilds is an additional filter to the internal SearchTemplate used in the getSearchTemplate(...) function The internal SearchTemplate used in the getSearchTemplate(...) is used for virtual folders, the FilterCriteria_p is used to refine the result of a node

Specified by:

canFilterChilds in interface OwObject

Returns:

true = filter children with FilterCriteria_p is possible, false = filter is not possible / ignored

Throws:

Exception

getFilterProperties

public Collection getFilterProperties(Collection propertynames_p)
                               throws Exception

get a collection of OwFieldDefinition's for a given list of names

Specified by:

getFilterProperties in interface OwObject

Parameters:

propertynames_p - Collection of property names the client wants to use as filter properties or null to retrieve all possible filter properties

Returns:

Collection of OwFieldDefinition's that can actually be filtered, may be a subset of propertynames_p, or null if no filter properties are allowed

Throws:

Exception

getVersionSeries

public OwVersionSeries getVersionSeries()
                                 throws Exception

get the version series object to this object, if the object is versionable

Specified by:

getVersionSeries in interface OwObject

Returns:

a list of object versions

Throws:

Exception

hasVersionSeries

public boolean hasVersionSeries()
                         throws Exception

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

Specified by:

hasVersionSeries in interface OwObject

Returns:

true if object is versionable

Throws:

Exception

getVersion

public OwVersion getVersion()
                     throws Exception

get the current version object

Specified by:

getVersion in interface OwObject

Returns:

OwVersion Object identifying the currently set version, or null if versions not supported

Throws:

Exception

getMIMEType

public String getMIMEType()
                   throws Exception

get the MIME Type of the Object

Specified by:

getMIMEType in interface OwContentElement

Specified by:

getMIMEType in interface OwObjectReference

Returns:

MIME Type as String

Throws:

Exception

getMIMEParameter

public String getMIMEParameter()
                        throws Exception

get the additional MIME Parameter of the Object

Specified by:

getMIMEParameter in interface OwContentElement

Specified by:

getMIMEParameter in interface OwObjectReference

Returns:

MIME Parameter as String

Throws:

Exception

getDMSID

public String getDMSID()
                throws Exception

get the ECM specific ID of the Object. The DMSID is not interpreted by the Workdesk, nor does the Workdesk need to know the syntax. However, it must hold enough information, so that the ECM Adapter is able to reconstruct the Object. The reconstruction is done through OwNetwork.createObjectFromDMSID(...) The Workdesk uses the DMSID to store ObjectReferences as Strings. E.g.: in the task databases. The syntax of the ID is up to the ECM Adapter, but would usually be made up like the following:

Specified by:

getDMSID in interface OwObjectReference

Throws:

Exception

getProperty

public OwProperty getProperty(String strPropertyName_p)
                       throws Exception

retrieve the specified property from the object. NOTE: if the property was not already obtained from the archive (e.g. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...) ==> Alternatively you can use the getProperties Function to retrieve a whole bunch of properties in one step, making the ECM adaptor use only one new query.

Specified by:

getProperty in interface OwObject

Parameters:

strPropertyName_p - the name of the requested property

Returns:

a property object

Throws:

Exception

getProperties

public OwPropertyCollection getProperties(Collection propertyNames_p)
                                   throws Exception

retrieve the specified properties from the object. NOTE: The returned collection might contain more Properties than requested with PropertyNames_p

NOTE: if the properties where not already obtained from the archive (e.g. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...)

Specified by:

getProperties in interface OwObject

Parameters:

propertyNames_p - a collection of property names to retrieve, if null all properties are retrieved

Returns:

a property list

Throws:

Exception

getClonedProperties

public OwPropertyCollection getClonedProperties(Collection propertyNames_p)
                                         throws Exception

retrieve the specified properties from the object as a copy NOTE: The returned collection might contain more Properties than requested with PropertyNames_p

NOTE: if the properties where not already obtained from the archive (e.g. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...)

Specified by:

getClonedProperties in interface OwObject

Parameters:

propertyNames_p - a collection of property names to retrieve, if null all properties are retrieved

Returns:

a property list

Throws:

Exception

setProperties

public void setProperties(OwPropertyCollection properties_p)
                   throws Exception

set the properties in the object

Specified by:

setProperties in interface OwObject

Parameters:

properties_p - OwPropertyList list of OwProperties to set

Throws:

Exception

canSetProperties

public boolean canSetProperties(int iContext_p)
                         throws Exception

check if object allows to set / change properties

Specified by:

canSetProperties in interface OwObject

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

true if allowed

Throws:

Exception

canGetProperties

public boolean canGetProperties(int iContext_p)
                         throws Exception

check if property retrieval is allowed

Specified by:

canGetProperties in interface OwObject

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

true if allowed

Throws:

Exception

canLock

public boolean canLock()
                throws Exception

check if object supports lock mechanism

Specified by:

canLock in interface OwObject

Returns:

true, if object supports lock, i.e. the setLock function works

Throws:

Exception

setLock

public boolean setLock(boolean fLock_p)
                throws Exception

lock / unlock object, make it unaccessible for other users

Specified by:

setLock in interface OwObject

Parameters:

fLock_p - true to lock it, false to unlock it.

Returns:

the new lock state of the object

Throws:

Exception

getLock

public boolean getLock(int iContext_p)
                throws Exception

get the lock state of the object

Specified by:

getLock in interface OwObject

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

the lock state of the object

Throws:

Exception

getMyLock

public boolean getMyLock(int iContext_p)
                  throws Exception

get the lock state of the object for the CURRENTLY logged on user

Specified by:

getMyLock in interface OwObject

Parameters:

iContext_p - as defined in OwStatusContextDefinitions

Returns:

the lock state of the object

Throws:

Exception

getLockUserID

public String getLockUserID(int iContext_p)
                     throws Exception

get the lock user of the object

Specified by:

getLockUserID in interface OwObject

Parameters:

iContext_p - as defined in OwStatusContextDefinitions

Returns:

the User ID of the user who locked the item, or null if it is not locked

Throws:

Exception

delete

public void delete()
            throws Exception

delete object and all references from DB

Specified by:

delete in interface OwObject

Throws:

Exception

canDelete

public boolean canDelete(int iContext_p)
                  throws Exception

check if object can be deleted

Specified by:

canDelete in interface OwObject

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

true, if delete operation works on object

Throws:

Exception

removeReference

public void removeReference(OwObject oObject_p)
                     throws Exception

removes the reference of the given object from this object (folder) this object needs to be parent of given object

Specified by:

removeReference in interface OwObject

Parameters:

oObject_p - OwObject reference to be removed from this object (folder)

Throws:

Exception

canRemoveReference

public boolean canRemoveReference(OwObject oObject_p,
                         int iContext_p)
                           throws Exception

checks if the reference can be removed this object needs to be parent of given object, and user needs to have sufficient access rights

Specified by:

canRemoveReference in interface OwObject

Parameters:

oObject_p - OwObject reference to be checked upon

iContext_p - OwStatusContextDefinitions

Returns:

true, if given OwObject reference can be removed from this object (folder)

Throws:

Exception

add

public void add(OwObject oObject_p)
         throws Exception

adds a object reference to this parent object / folder

Specified by:

add in interface OwObject

Parameters:

oObject_p - OwObject reference to add to

Throws:

Exception

canAdd

public boolean canAdd(OwObject oObject_p,
             int iContext_p)
               throws Exception

checks if object supports add function

Specified by:

canAdd in interface OwObject

Parameters:

oObject_p - OwObject reference to be added

iContext_p - OwStatusContextDefinitions

Returns:

true if object supports add function

Throws:

Exception

move

public void move(OwObject oObject_p,
        OwObject oldParent_p)
          throws Exception

moves a object reference to this parent object (folder)

Specified by:

move in interface OwObject

Parameters:

oObject_p - OwObject reference to add to

oldParent_p - OwObject Old Parent to remove from, used for move operation, can be null

Throws:

Exception

canMove

public boolean canMove(OwObject oObject_p,
              OwObject oldParent_p,
              int iContext_p)
                throws Exception

check if move operation is allowed

Specified by:

canMove in interface OwObject

Parameters:

oObject_p - OwObject reference to add to

oldParent_p - OwObject Old Parent to remove from, used for move operation, can be null

iContext_p - OwStatusContextDefinitions

Throws:

Exception

getSearchTemplate

public OwSearchTemplate getSearchTemplate()
                                   throws Exception

get a search template associated with this Object The search from the template can be used to refine the result in getChilds(...) ==> The search is automatically performed when calling getChilds(...) The ColumnInfoList from the template can be used to format the result list of the children NOTE: This function is especially used in virtual folders

Specified by:

getSearchTemplate in interface OwObject

Returns:

OwSearchTemplate or null if not defined for the object

Throws:

Exception

getColumnInfoList

public Collection getColumnInfoList()
                             throws Exception

get the column info list that describes the columns for the child list

Specified by:

getColumnInfoList in interface OwObject

Returns:

List of OwSearchTemplate.OwObjectColumnInfos, or null if not defined

Throws:

Exception

getPageNumber

public int getPageNumber(int lPageIndex_p)
                  throws Exception

retrieve the page number for the given zero based index NOTE: the Page numbers might be arbitrary in the collection in order to submit specific page content

Specified by:

getPageNumber in interface OwContentElement

Parameters:

lPageIndex_p - zero based page index for the pages in the collection

Returns:

long actual page number

Throws:

Exception

getPageCount

public int getPageCount()
                 throws Exception

retrieve the number of pages in the objects

Specified by:

getPageCount in interface OwContentCollection

Specified by:

getPageCount in interface OwObjectReference

Returns:

number of pages

Throws:

Exception

getResource

public OwResource getResource()
                       throws Exception

get the resource the object belongs to in a multiple resource Network

Specified by:

getResource in interface OwObject

Returns:

OwResource to identify the resource, or null for the default resource

Throws:

Exception

getPermissions

public OwPermissionCollection getPermissions()
                                      throws Exception

get the permissions object

Specified by:

getPermissions in interface OwObject

Returns:

OwPermissionCollection of the object

Throws:

Exception

getClonedPermissions

public OwPermissionCollection getClonedPermissions()
                                            throws Exception

get the cloned permissions

Specified by:

getClonedPermissions in interface OwObject

Returns:

OwPermissionCollection clone of the object

Throws:

Exception

canGetPermissions

public boolean canGetPermissions()
                          throws Exception

check if permissions are accessible

Specified by:

canGetPermissions in interface OwObject

Returns:

true = permissions can be retrieved

Throws:

Exception

canSetPermissions

public boolean canSetPermissions()
                          throws Exception

check if permissions can be set

Specified by:

canSetPermissions in interface OwObject

Returns:

true = permissions can be set

Throws:

Exception

setPermissions

public void setPermissions(OwPermissionCollection permissions_p)
                    throws Exception

set the permissions object

Specified by:

setPermissions in interface OwObject

Parameters:

permissions_p - OwPermissionCollection to set

Throws:

Exception

getContentCollection

public OwContentCollection getContentCollection()
                                         throws Exception

get the content of the object

Specified by:

getContentCollection in interface OwObject

Returns:

OwContentCollection

Throws:

Exception

refreshProperties

public void refreshProperties()
                       throws Exception

refresh the property cache

Specified by:

refreshProperties in interface OwObject

Throws:

Exception

refreshProperties

public void refreshProperties(Collection props_p)
                       throws Exception

refresh the property cache

Specified by:

refreshProperties in interface OwObject

Parameters:

props_p - Collection of property names to update

Throws:

Exception

getNativeObject

public Object getNativeObject()
                       throws Exception

get the native object from the ECM system WARNING: The returned object is Opaque. Using the native object makes the client dependent on the ECM System

Specified by:

getNativeObject in interface OwObject

Returns:

File

Throws:

Exception

getField

public OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException

implementation of the OwFieldProvider interface get a field with the given field definition class name

Specified by:

getField in interface OwFieldProvider

Parameters:

strFieldClassName_p - String class name of requested fields

Returns:

OwField or throws OwObjectNotFoundException

Throws:

Exception

OwObjectNotFoundException

getFieldProviderSource

public Object getFieldProviderSource()

get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject

Specified by:

getFieldProviderSource in interface OwFieldProvider

Returns:

Object the original source object where the fields have been taken, can be a this pointer

getFieldProviderType

public int getFieldProviderType()

get the type of field provider as defined with TYPE_...

Specified by:

getFieldProviderType in interface OwFieldProvider

hasContent

public boolean hasContent(int iContext_p)
                   throws Exception

check if the object contains a content, which can be retrieved using getContentCollection

Specified by:

hasContent in interface OwObjectReference

Parameters:

iContext_p - as defined in OwStatusContextDefinitions

Returns:

boolean true = object contains content, false = object has no content

Throws:

Exception

getContentFilePath

public String getContentFilePath()
                          throws Exception

get the file path to the content (optional, only available if content is stored locally) NOTE: This function is only used for ECM Systems which can only download through files If a FilePath exists, a stream will also exist. The FilePath is optional, it can not be guranteed to exist.

Specified by:

getContentFilePath in interface OwContentElement

Returns:

String with path to a file where the content can be found or null if file is not available

Throws:

Exception

hasChilds

public boolean hasChilds(int[] iObjectTypes_p,
                int iContext_p)
                  throws Exception

check if object has children

Specified by:

hasChilds in interface OwObject

Parameters:

iContext_p - as defined in OwStatusContextDefinitions

iObjectTypes_p - the requested object types (folder or document)

Returns:

true, object has children

Throws:

Exception

getPath

public String getPath()
               throws Exception

get the path to the object, which can be used in OwNetwork.getObjectFromPath to recreate the object The path is build with the name property. Unlike the symbol name and the DMSID, the path is not necessarily unique, but provides a readable information of the objects location.

Specified by:

getPath in interface OwObject

Throws:

Exception

releaseResources

public void releaseResources()

Description copied from interface: OwContentElement

method is called e.g. by GetContent servlet after the content is consumed. Can be used to release resources e.g. streams, Interactions, Connections etc. AFTER content is fetched.

Specified by:

releaseResources in interface OwContentElement

See Also:

OwContentElement.releaseResources()

getChildCount

public int getChildCount(int[] iObjectTypes_p,
                int iContext_p)
                  throws Exception

get the number of children

Specified by:

getChildCount in interface OwObject

Parameters:

iObjectTypes_p - the requested object types (folder or document)

iContext_p - as defined in OwStatusContextDefinitions

Returns:

int number of children or throws OwStatusContextException

Throws:

Exception

changeClass

public void changeClass(String strNewClassName_p,
               OwPropertyCollection properties_p,
               OwPermissionCollection permissions_p)
                 throws Exception

change the class of the object

Specified by:

changeClass in interface OwObject

Parameters:

strNewClassName_p - String

properties_p - OwPropertyCollection (optional, can be null to set previous properties)

permissions_p - OwPermissionCollection (optional, can be null to set previous permissions)

Throws:

Exception

canChangeClass

public boolean canChangeClass()
                       throws Exception

check if object can change its class

Specified by:

canChangeClass in interface OwObject

Throws:

Exception

getFieldProviderName

public String getFieldProviderName()

get a name that identifies the field provider, can be used to create IDs

Specified by:

getFieldProviderName in interface OwFieldProvider

Returns:

String unique ID / Name of fieldprovider

setField

public void setField(String sName_p,
            Object value_p)
              throws Exception,
                     OwObjectNotFoundException

modify a Field value, but does not save the value right away

Specified by:

setField in interface OwFieldProvider

Parameters:

sName_p -

value_p -

Throws:

Exception

OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                       Object defaultvalue_p)

retrieve the value of a Field

Specified by:

getSafeFieldValue in interface OwFieldProvider

Parameters:

sName_p -

defaultvalue_p -

Returns:

Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception

get all the properties in the form

Specified by:

getFields in interface OwFieldProvider

Returns:

Collection of OwField

Throws:

Exception

getContentElement

public OwContentElement getContentElement(int iContentType_p,
                                 int iPage_p)
                                   throws Exception

get a content element for the given type and page

Specified by:

getContentElement in interface OwContentCollection

Parameters:

iContentType_p - int

iPage_p - int

Returns:

OwContentElement

Throws:

Exception

getInstance

public OwObject getInstance()
                     throws Exception

get a instance from this reference

Specified by:

getInstance in interface OwObjectReference

Returns:

OwObject or throws OwObjectNotFoundException

Throws:

Exception, - OwObjectNotFoundException

Exception

getResourceID

public String getResourceID()
                     throws Exception

get the ID / name identifying the resource the object belongs to

Specified by:

getResourceID in interface OwObjectReference

Returns:

String ID of resource or throws OwObjectNotFoundException

Throws:

Exception, - OwObjectNotFoundException

Exception

See Also:

OwResource

setProperties

public void setProperties(OwPropertyCollection properties_p,
                 Object mode_p)
                   throws Exception

Description copied from interface: OwObject

set the properties in the object

Specified by:

setProperties in interface OwObject

Parameters:

properties_p - OwPropertyList list of OwProperties to set

mode_p - mode to use or null to use default mode, @see OwObjectClass.getModes(int)

Throws:

Exception

getChildren

public OwIterable<OwFileObject> getChildren(OwLoadContext filter)
                                     throws OwException

Specified by:

getChildren in interface OwPageableObject<OwFileObject>

Throws:

OwException