Package com.groiss.dms

Interface DMSDocForm

All Superinterfaces:

DMSForm, DMSObject, HasLog, HasOwner, HasPermissionList, HasVersionId, KeyValuePair<String,String>, OptimisticLocking, Persistent, Serializable

public interface DMSDocForm
extends DMSForm

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	IN	Deprecated, for removal: This API element is subject to removal in a future version. since ep10
static final int	LOCKED	Deprecated, for removal: This API element is subject to removal in a future version. since ep10

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method	Description
void	checkIn(User user, byte[] bytes)	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use DMS.setContent(DMSDocForm, byte[]) instead
void	checkIn(User user, InputStream is)	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use DMS.setContent(DMSDocForm, InputStream) instead
void	checkIn(User user, InputStream is, long length, byte[] digest)	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use DMS.setContent(DMSDocForm, InputStream, long, byte[]) instead
String	getAlgorithm()	Returns the hashing algorithm, for example 'SHA-256'.
byte[]	getContent()	Returns the content of this document
InputStream	getContentAsStream()	Returns an InputStream to the content of this document
String	getExtension()	Returns the extension of this document (e.g.
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).
String	getMessageDigestAsString()	Returns the message digest of the content of this document as hexadecimal String (Settings.getMessageDigest() will be used by the system to calculate it)
long	getSize()	Returns the size of the documents content (in bytes)
int	getStatus()	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use isLocked() instead, all other states are not supported anymore
User	getUsedBy()	Get the user who has locked 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)	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use DMS.lock(DMSDocForm) instead
void	setExtension(String extension)	Set the extension of this document.
void	unlock()	Deprecated, for removal: This API element is subject to removal in a future version. since ep10, use DMS.unlock(DMSDocForm) instead

Methods inherited from interface com.groiss.dms.DMSForm

getField, getFieldType, getFormType, getSubforms, hasField, setActivityContext, setActivityContext, setField

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.org.HasVersionId

getVersionId, setVersionId

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

IN

@Deprecated(since="10.0",
            forRemoval=true)
static final int IN

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10

status: the document is checked in.

See Also:

• Constant Field Values

LOCKED

@Deprecated(since="10.0",
            forRemoval=true)
static final int LOCKED

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10

status: the document is locked (i.e. its content may only be changed by the user holding the lock).

See Also:

• Constant Field Values

Method Details

getContent

byte[] getContent()

Returns the content of this document

getContentAsStream

InputStream getContentAsStream()

Returns an InputStream to the content of this document

getExtension

String getExtension()

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

setExtension

void setExtension(String extension)

Set the extension of this document.

getSize

long getSize()

Returns the size of the documents content (in bytes)

getMessageDigest

byte[] getMessageDigest()

Returns the message digest of the content of this document (Settings.getMessageDigest() will be used by the system to calculate it).

getMessageDigestAsString

String getMessageDigestAsString()

Returns the message digest of the content of this document as hexadecimal String (Settings.getMessageDigest() will be used by the system to calculate it)

getAlgorithm

String getAlgorithm()

Returns the hashing algorithm, for example 'SHA-256'.

getStatus

@Deprecated(since="10.0",
            forRemoval=true)
int getStatus()

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use isLocked() instead, all other states are not supported anymore

Returns the status of this document

hasAttributes

boolean hasAttributes()

Returns if this object has any meta data

checkIn

@Deprecated(since="10.0",
            forRemoval=true)
void checkIn(User user,
 InputStream is)

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use DMS.setContent(DMSDocForm, InputStream) instead

Checks the document in

Parameters:

user - the user who performs this action

is - an InputStream to the content of the document

checkIn

@Deprecated(since="10.0",
            forRemoval=true)
void checkIn(User user,
 InputStream is,
 long length,
 byte[] digest)

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use DMS.setContent(DMSDocForm, InputStream, long, byte[]) instead

Checks the document in

Parameters:

user - the user who performs this action

is - an InputStream to the content of the document

length - the length of the new content in bytes

digest - the message digest of the new content

checkIn

@Deprecated(since="10.0",
            forRemoval=true)
void checkIn(User user,
 byte[] bytes)

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use DMS.setContent(DMSDocForm, byte[]) instead

Checks the document in

Parameters:

user - the user who performs this action

bytes - a byte array holding the content of the document

lock

@Deprecated(since="10.0",
            forRemoval=true)
void lock(User user)

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use DMS.lock(DMSDocForm) instead

Locks this document.

Parameters:

user - the user who performs this action

unlock

@Deprecated(since="10.0",
            forRemoval=true)
void unlock()

Deprecated, for removal: This API element is subject to removal in a future version.

since ep10, use DMS.unlock(DMSDocForm) instead

Unlocks this document.

isLocked

boolean isLocked()

Returns true if this document is locked, false otherwise

getUsedBy

User getUsedBy()

Get the user who has locked the document.

Returns:

the user or null if not locked

getFullName

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)