public interface DMSDocForm extends DMSForm
Modifier and Type | Field and Description |
---|---|
static int |
IN
status: the document is checked in.
|
static int |
LOCKED
status: the document is locked (i.e. may only be changed by the locker).
|
static int |
OUT
status: the document is checked out.
|
emptyKeys
Modifier and Type | Method and Description |
---|---|
void |
checkIn(User user,
byte[] bytes)
Checks the document in
|
void |
checkIn(User user,
java.io.InputStream is)
Checks the document in
|
void |
checkIn(User user,
java.io.InputStream is,
long length,
byte[] digest)
Checks the document in
|
java.lang.String |
checkOut(User user)
Checks the document out
|
byte[] |
getContent()
Returns the content of this document
|
java.io.InputStream |
getContentAsStream()
Returns an InputStream to the content of this document
|
java.lang.String |
getExtension()
Returns the extension of this document (e.g.
|
java.lang.String |
getFullName()
Returns the full name of the document which is the name followed by a dot and the extension (if the extension
is not empty)
|
byte[] |
getMessageDigest()
Returns the message digest of the content of this document (
Settings.getMessageDigest() will be used by the system
to calculate it). |
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
|
boolean |
isLocked()
Returns true if this document is locked, false otherwise
|
void |
lock(User user)
Locks this document.
|
void |
undoCheckOut()
Undoes the check out of the document
|
void |
unlock()
Unlocks this document.
|
getField, getFieldType, getFormType, hasField, setActivityContext, setActivityContext, setField
attachNote, getChangedAt, getChangedBy, getCreatedAt, getCreatedBy, getDefaultOrgUnit, getIcon, getName, getPermissionList, getTypeName, hasAttachedNotes, hasVersions, listAttachedNotes, listVersions, makeCopy, makeVersion, removeNote, setName, setPermissionList
afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, setStore, toListString
getVersionId, setVersionId
static final int IN
static final int OUT
static final int LOCKED
byte[] getContent()
java.io.InputStream getContentAsStream()
java.lang.String getExtension()
long getSize()
byte[] getMessageDigest()
Settings.getMessageDigest()
will be used by the system
to calculate it).int getStatus()
boolean hasAttributes()
void checkIn(User user, java.io.InputStream is)
user
- the user who performs this actionis
- an inputstream to the content of the documentvoid checkIn(User user, java.io.InputStream is, long length, byte[] digest)
user
- the user who performs this actionis
- an inputstream to the content of the documentlength
- the length of the new content in bytesdigest
- the message digest of the new contentvoid checkIn(User user, byte[] bytes)
user
- the user who performs this actionbytes
- a byte array holding the content of the documentjava.lang.String checkOut(User user)
user
- the user who performs this actionvoid undoCheckOut()
void lock(User user)
user
- the user who performs this actionvoid unlock()
boolean isLocked()
User getUsedBy()
java.lang.String getFullName()
@enterprise 9.0.33982 Copyright © 2001-2023 Groiss Informatics GmbH. All Rights Reserved.