com.groiss.dms
Interface DMSDocForm

All Superinterfaces:

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

public interface DMSDocForm
extends DMSForm

The base interface for all documents with meta data in @enterprise DMS

Field Summary

static int	IN status: the document is checked in.
static int	LOCKED status: the document is locked (i.e.
static int	OUT status: the document is checked out.

Method Summary

void	checkIn(User user, byte[] bytes) Checks the document in
void	checkIn(User user, java.io.InputStream is) Checks the document in
java.lang.String	checkOut(User user) Checks the document out
byte[]	getContent() Returns the content of this document
java.lang.String	getExtension() Returns the extension of this document (e.g.
long	getSize() Returns the size of the documents content (in bytes)
int	getStatus() Returns the status of this document
User	getUsedBy() Get the user who has locked or checked out the document.
boolean	hasAttributes() Returns if this object has any meta data
void	lock(User user) Locks this document.
void	undoCheckOut() Undoes the check out of the document
void	unlock() Unlocks this document.

Methods inherited from interface com.groiss.dms.DMSForm

getField, getFieldType, getFormType, hasField, setField

Methods inherited from interface com.groiss.dms.DMSObject

attachNote, getAcl, getChangedAt, getChangedBy, getCreatedAt, getCreatedBy, getDefaultOrgUnit, getIcon, getName, 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, getOid, getStore, getTableName, isFilled, onDelete, onInsert, onRead, onUpdate, setFilled, setOid, setStore

Methods inherited from interface com.groiss.org.HasLog

getVersionId, setVersionId

Field Detail

IN

static final int IN

status: the document is checked in.

See Also:

Constant Field Values

OUT

static final int OUT

status: the document is checked out.

See Also:

Constant Field Values

LOCKED

static final int LOCKED

status: the document is locked (i.e. may only be changed by the locker).

See Also:

Constant Field Values

Method Detail

getContent

byte[] getContent()

Returns the content of this document

getExtension

java.lang.String getExtension()

Returns the extension of this document (e.g. 'doc')

getSize

long getSize()

Returns the size of the documents content (in bytes)

getStatus

int getStatus()

Returns the status of this document

hasAttributes

boolean hasAttributes()

Returns if this object has any meta data

checkIn

void checkIn(User user,
             java.io.InputStream is)

Checks the document in

Parameters:

user - the user who performs this action

is - an inputstream to the content of the document

checkIn

void checkIn(User user,
             byte[] bytes)

Checks the document in

Parameters:

user - the user who performs this action

bytes - a byte array holding the content of the document

checkOut

java.lang.String checkOut(User user)

Checks the document out

Parameters:

user - the user who performs this action

Returns:

the path of the file to which the document was checked out

undoCheckOut

void undoCheckOut()

Undoes the check out of the document

lock

void lock(User user)

Locks this document.

Parameters:

user - the user who performs this action

unlock

void unlock()

Unlocks this document.

getUsedBy

User getUsedBy()

Get the user who has locked or checked out the document.

Returns:

the user or null if not locked or checked out