Package com.groiss.dms

Interface DMSFolder

All Superinterfaces:

DMSObject, HasOwner, HasPermissionList, KeyValuePair<String,String>, OptimisticLocking, Persistent, Serializable

All Known Subinterfaces:

DMSFolderForm

public interface DMSFolder
extends DMSObject

This interface represents a folder containing DMSObjects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_SEPARATOR	Determines the character which is used to separate folders within a path string.

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method	Description
DMSObject	add(DMSObject o)	Adds the passed object to its content
Collection<DMSObject>	addAll(Collection<? extends DMSObject> 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.
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)
boolean	isEmpty()	Returns true if this folder is empty, false otherwise
List<DMSObject>	listContents()	Returns a list holding the whole content of this folder.
boolean	remove(DMSObject o)	Removes the passed object from this folder
boolean	removeAll(Collection<DMSObject> 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, getChangedAt, getChangedBy, getCreatedAt, getCreatedBy, getName, getTypeName, hasAttachedNotes, hasVersions, listAttachedNotes, listVersions, makeCopy, makeVersion, removeNote, setName

Methods inherited from interface com.groiss.org.HasOwner

getOwner

Methods inherited from interface com.groiss.org.HasPermissionList

getDefaultOrgUnit, getPermissionList, setPermissionList

Methods inherited from interface com.groiss.store.OptimisticLocking

getTransactionId, increaseTransactionId, setTransactionId

Methods inherited from interface com.groiss.store.Persistent

afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, toListString

Field Details

PATH_SEPARATOR

static final String PATH_SEPARATOR

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

See Also:

• Constant Field Values

Method Details

add

DMSObject add(DMSObject o)

Adds the passed object to its content

Parameters:

o - the object to be added

Returns:

the added object

addAll

Collection<DMSObject> addAll(Collection<? extends DMSObject> v)

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

clear

void clear()

Removes the whole content of this folder

contains

boolean contains(DMSObject o)

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

listContents

List<DMSObject> listContents()

Returns a list holding the whole content of this folder.

isEmpty

boolean isEmpty()

Returns true if this folder is empty, false otherwise

remove

boolean remove(DMSObject o)

Removes the passed object from this folder

Returns:

true if this collection changed as a result of the call

removeAll

boolean removeAll(Collection<DMSObject> v)

Removes all the objects in the collection from the folder

Returns:

true if this collection changed as a result of the call

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)

Sets the organizational unit to which this folder belongs to

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

String getPathToRoot()

Returns the path to the root as a string

getParentFolder

DMSFolder getParentFolder()

Returns the parent of this folder. If the folder has no parent null is returned.

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.