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 Detail

      • getId

        long getId()
        Document identifier
        Returns:
        document identifier
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getName

        String getName()
        Name of the document
        Returns:
        name of the document
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getPath

        Path getPath()
        Path of the document
        Returns:
        path of the document
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • 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 IvyScript and Java. It has the visibility NOVICE.

      • 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 IvyScript and Java. It has the visibility NOVICE.

      • 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 IvyScript and Java. It has the visibility NOVICE.
        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 IvyScript and Java. It has the visibility NOVICE.

      • 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 IvyScript and Java. It has the visibility NOVICE.