com.groiss.dms
Interface DMSObject

All Superinterfaces:

com.dec.avw.core.OwnedObject, Persistent

All Known Subinterfaces:

DMSDocForm, DMSFolder, DMSForm, DMSLink, DMSNote, DMSWebLink

All Known Implementing Classes:

DocForm, FolderForm, com.dec.avw.core.Form

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

Method Summary

void	attachNote(DMSNote note, User user) Attaches the passed note to this object
com.dec.avw.acl.ACL	getAcl() Returns the acl of this object.
java.util.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.
java.util.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.
java.lang.String	getIcon() Returns the path and name of the icon representing this object.
java.lang.String	getName() Returns the name of this object.
long	getOid() Returns the oid of this object.
java.lang.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.
java.util.List	listAttachedNotes(User user) Returns a list of the attached notes of this object on which the passed user has the right to view them.
java.util.List	listVersions() Returns the versions of this form in descending order of their creation date
DMSObject	makeCopy(User user) Returns a copy of this object.
DocumentVersion	makeVersion(User user, java.lang.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	setAcl(com.dec.avw.acl.ACL acl) Sets the acl for this object.
void	setName(java.lang.String name) Sets the name of this object to passed string.

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

Method Detail

getOid

long getOid()

Returns the oid of this object.

Specified by:

getOid in interface Persistent

Returns:

The OID of the persistent object.

getName

java.lang.String getName()

Returns the name of this object.

setName

void setName(java.lang.String name)
             throws java.lang.Exception

Sets the name of this object to passed string.

Parameters:

name - the new name

Throws:

java.lang.Exception

getIcon

java.lang.String getIcon()

Returns the path and name of the icon representing this object.

getCreatedAt

java.util.Date getCreatedAt()

Returns the date when this object was created

getCreatedBy

User getCreatedBy()

Returns the user who created this object

getChangedAt

java.util.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

java.lang.String getTypeName()

Returns a string representing the type of this object.

makeCopy

DMSObject makeCopy(User user)
                   throws java.lang.Exception

Returns a copy of this object.

Parameters:

user - the user who wants to make the copy.

Throws:

java.lang.Exception

setAcl

void setAcl(com.dec.avw.acl.ACL acl)

Sets the acl for this object.

Parameters:

acl - the acl to be set

getAcl

com.dec.avw.acl.ACL getAcl()

Returns the acl of this object.

getDefaultOrgUnit

OrgUnit getDefaultOrgUnit()

Returns the default organizational unit of this object.

makeVersion

DocumentVersion makeVersion(User user,
                            java.lang.String description)
                            throws java.lang.Exception

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

Throws:

java.lang.Exception

listVersions

java.util.List listVersions()

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

Returns:

a list of DocumentVersion objects.

hasVersions

boolean hasVersions()

Returns if this form has at least one version.

attachNote

void attachNote(DMSNote note,
                User user)
                throws java.lang.Exception

Attaches the passed note to this object

Parameters:

note - the note to be attached

user - the user who wants to attach the note

Throws:

java.lang.Exception

removeNote

void removeNote(DMSNote note,
                User user)
                throws java.lang.Exception

Removes the passed note from this object

Parameters:

note - the note to be removed

user - the user who wants to remove the note

Throws:

java.lang.Exception

listAttachedNotes

java.util.List 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