com.groiss.dms
Interface DMSFolder

All Superinterfaces:

DMSObject, com.dec.avw.core.OwnedObject, Persistent

All Known Implementing Classes:

FolderForm

public interface DMSFolder
extends DMSObject

This interface represents a folder containing DMSObjects.

Field Summary

static java.lang.String

PATH_SEPARATOR Determines the character which is used to separate folders within a path string.

Method Summary

DMSObject	add(DMSObject o) Adds the passed object to its content
java.util.Collection	addAll(java.util.Collection v) Adds all the objects of the passed collection to its content
boolean	bequestACL() Returns true if objects which are added to this folder should inherit the folders ACL, otherwise false is returned
void	bequestACL(boolean bequest) Sets if objects which are added to this folder should inherit the folders ACL.
void	clear() Removes the whole content of this folder
boolean	contains(DMSObject o) Returns true if the passed object is an element of this folder, false otherwise.
OrgUnit	getOrgUnit() Returns the organizational unit to which this folder belongs to
DMSFolder	getParentFolder() Returns the parent of this folder.
java.lang.String	getPathToRoot() Returns the path to the root as a string
ProcessInstance	getProcessContext() Returns the process to which this folder may belong to (directly or indirectly)
java.lang.String	getTableModel() Returns the full qualified name of the class which is used for displaying the content of this folder.
boolean	isEmpty() Returns true if this folder is empty, false otherwise
java.util.List	listContents() Returns a list holding the whole content of this folder.
void	remove(DMSObject o) Removes the passed object from this folder
void	removeAll(java.util.Collection v) Removes all the objects in the collection from the folder
void	setOrgUnit(OrgUnit ou) Sets the organizational unit to which this folder belongs to
void	setProcessContext(ProcessInstance process) Sets the process to which this folder may belong to (directly or indirectly)
int	size() Returns the number of elements in this folder.

Methods inherited from interface com.groiss.dms.DMSObject

attachNote, getAcl, getChangedAt, getChangedBy, getCreatedAt, getCreatedBy, getDefaultOrgUnit, getIcon, getName, getOid, getTypeName, hasAttachedNotes, hasVersions, listAttachedNotes, listVersions, makeCopy, makeVersion, removeNote, setAcl, setName

Methods inherited from interface com.dec.avw.core.OwnedObject

getOwner, ignoreSubstitution

Methods inherited from interface com.groiss.store.Persistent

dbFields, getStore, getTableName, isFilled, onDelete, onInsert, onRead, onUpdate, setFilled, setOid, setStore

Field Detail

PATH_SEPARATOR

static final java.lang.String PATH_SEPARATOR

Determines the character which is used to separate folders within a path string.

See Also:

Constant Field Values

Method Detail

add

DMSObject add(DMSObject o)
              throws java.lang.Exception

Adds the passed object to its content

Parameters:

o - the object to be added

Returns:

the added object

Throws:

java.lang.Exception

addAll

java.util.Collection addAll(java.util.Collection v)
                            throws java.lang.Exception

Adds all the objects of the passed collection to its content

Parameters:

v - the collection holding the objects to be added

Returns:

the collection of added objects

Throws:

java.lang.Exception

clear

void clear()
           throws java.lang.Exception

Removes the whole content of this folder

Throws:

java.lang.Exception

contains

boolean contains(DMSObject o)

Returns true if the passed object is an element of this folder, false otherwise.

listContents

java.util.List listContents()

Returns a list holding the whole content of this folder.

isEmpty

boolean isEmpty()

Returns true if this folder is empty, false otherwise

remove

void remove(DMSObject o)
            throws java.lang.Exception

Removes the passed object from this folder

Throws:

java.lang.Exception

removeAll

void removeAll(java.util.Collection v)
               throws java.lang.Exception

Removes all the objects in the collection from the folder

Throws:

java.lang.Exception

size

int size()

Returns the number of elements in this folder.

getOrgUnit

OrgUnit getOrgUnit()

Returns the organizational unit to which this folder belongs to

setOrgUnit

void setOrgUnit(OrgUnit ou)
                throws java.lang.Exception

Sets the organizational unit to which this folder belongs to

Throws:

java.lang.Exception

getProcessContext

ProcessInstance getProcessContext()

Returns the process to which this folder may belong to (directly or indirectly)

setProcessContext

void setProcessContext(ProcessInstance process)

Sets the process to which this folder may belong to (directly or indirectly)

getPathToRoot

java.lang.String getPathToRoot()

Returns the path to the root as a string

getParentFolder

DMSFolder getParentFolder()

Returns the parent of this folder.

getTableModel

java.lang.String getTableModel()

Returns the full qualified name of the class which is used for displaying the content of this folder. The returned class must extend class DMSObjectTable

bequestACL

boolean bequestACL()

Returns true if objects which are added to this folder should inherit the folders ACL, otherwise false is returned

bequestACL

void bequestACL(boolean bequest)

Sets if objects which are added to this folder should inherit the folders ACL.