com.groiss.dms

Interface DMSObject

All Superinterfaces:

KeyValuePair<String,String>, OptimisticLocking, com.dec.avw.core.OwnedObject, Persistent, Serializable

All Known Subinterfaces:

DMSDocForm, DMSFolder, DMSFolderForm, DMSForm, DMSLink, DMSNote, DMSWebLink

public interface DMSObject
extends com.dec.avw.core.OwnedObject, Persistent, OptimisticLocking

Field Summary

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method and Description
void	attachNote(DMSNote note, User user) Attaches the passed note to this object
Date	getChangedAt() Returns the date of the last modification of this object.
User	getChangedBy() Returns the user who made the last modification of this object.
Date	getCreatedAt() Returns the date when this object was created
User	getCreatedBy() Returns the user who created this object
OrgUnit	getDefaultOrgUnit() Returns the default organizational unit of this object.
String	getName() Returns the name of this object.
PermissionList	getPermissionList() Returns the acl of this object.
String	getTypeName() Returns a string representing the type of this object.
boolean	hasAttachedNotes(User user) Returns if there are any notes attached to this document which are visible to the passed user.
boolean	hasVersions() Returns if this form has at least one version.
List<DMSNote>	listAttachedNotes(User user) Returns a list of the attached notes of this object on which the passed user has the right to view them.
List<PersistentVersion>	listVersions() Returns the versions of this form in descending order of their creation date
DMSObject	makeCopy(User user) Returns a copy of this object.
PersistentVersion	makeVersion(User user, String description) Makes a version of this object with the passed string as version description
void	removeNote(DMSNote note, User user) Removes the passed note from this object
void	setName(String name) Sets the name of this object to passed string.
void	setPermissionList(PermissionList acl) Sets the acl for this object.

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

getOwner, ignoreSubstitution

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, setStore, toListString

Methods inherited from interface com.groiss.store.OptimisticLocking

getTransactionId, increaseTransactionId, setTransactionId

Method Detail

getName

String getName()

Returns the name of this object.

setName

void setName(String name)

Sets the name of this object to passed string.

Parameters:

name - the new name

getCreatedAt

Date getCreatedAt()

Returns the date when this object was created

getCreatedBy

User getCreatedBy()

Returns the user who created this object

getChangedAt

Date getChangedAt()

Returns the date of the last modification of this object.

getChangedBy

User getChangedBy()

Returns the user who made the last modification of this object.

getTypeName

String getTypeName()

Returns a string representing the type of this object.

makeCopy

DMSObject makeCopy(User user)

Returns a copy of this object.

Parameters:

user - the user who wants to make the copy.

setPermissionList

void setPermissionList(PermissionList acl)

Sets the acl for this object.

Parameters:

acl - the acl to be set

getPermissionList

PermissionList getPermissionList()

Returns the acl of this object.

getDefaultOrgUnit

OrgUnit getDefaultOrgUnit()

Returns the default organizational unit of this object.

makeVersion

PersistentVersion makeVersion(User user,
                              String description)

Makes a version of this object with the passed string as version description

Parameters:

user - the user who wants to make the version

description - the description text for this version

listVersions

List<PersistentVersion> listVersions()

Returns the versions of this form in descending order of their creation date

Returns:

a list of PersistentVersion objects.

hasVersions

boolean hasVersions()

Returns if this form has at least one version.

attachNote

void attachNote(DMSNote note,
                User user)

Attaches the passed note to this object

Parameters:

note - the note to be attached

user - the user who wants to attach the note

removeNote

void removeNote(DMSNote note,
                User user)

Removes the passed note from this object

Parameters:

note - the note to be removed

user - the user who wants to remove the note

listAttachedNotes

List<DMSNote> listAttachedNotes(User user)

Returns a list of the attached notes of this object on which the passed user has the right to view them. If user is null all notes are returned

Parameters:

user - the user who requests the attached notes

hasAttachedNotes

boolean hasAttachedNotes(User user)

Returns if there are any notes attached to this document which are visible to the passed user. If user is null it returns true if at least one note is attached (false otherwise).

Parameters:

user - the user for whom this request is performed