Package ch.ivyteam.ivy.workflow.document
Interface IDocument
public interface IDocument
A document that can be attached to a
case
or is managed by a workflow context
.- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionThe creator user and the creation timestamplong
getId()
Document identifierThe last user who has modified the document and the modification timestampgetName()
Name of the documentgetPath()
Path of the documentlong
getSize()
Content size of the document in bytesread()
Provides methods to read the content of the document.write()
Provides methods to write the content of the document.
-
Method Details
-
getId
long getId()Document identifier- Returns:
- document identifier
- API:
- This public API is available in Java.
-
getName
String getName()Name of the document- Returns:
- name of the document
- API:
- This public API is available in Java.
-
getPath
Path getPath()Path of the document- Returns:
- path of the document
- API:
- This public API is available in Java.
-
getSize
long getSize()Content size of the document in bytes- Returns:
- content size of the document in bytes
- API:
- This public API is available in Java.
-
read
IDocumentContentReader read()Provides methods to read the content of the document.
Example:
String content = document.read().asString();
- Returns:
- document content reader
- API:
- This public API is available in Java.
-
write
IDocumentContentWriter write()Provides methods to write the content of the document.
Example:
document.write().withContentFrom("Hello World");
- Returns:
- document content writer
- API:
- This public API is available in Java.
- Security:
- SESSION OWNS DocumentWrite PERMISSION OR MATCHES THIS.BelongsToInvolvedCase AND OWNS DocumentOfInvolvedCaseWrite PERMISSION OR OWNS DocumentWrite@SYSTEM PERMISSION
-
getCreation
ModificationInfo getCreation()The creator user and the creation timestamp- Returns:
- the creator user and the creation timestamp
- API:
- This public API is available in Java.
-
getLastModification
ModificationInfo getLastModification()The last user who has modified the document and the modification timestamp- Returns:
- the last user who has modified the document and the modification timestamp
- API:
- This public API is available in Java.
-