Interface ResultAccessData

  • All Known Implementing Classes:
    ResultAccessDataImpl

    public interface ResultAccessData
    Interface for document access data information.
    • Method Detail

      • isVisible

        boolean isVisible()
        Returns:
        true if the document is visible
      • canRead

        boolean canRead()
        Returns:
        true if read operations are allowed
      • canWrite

        boolean canWrite()
        Returns:
        true if write operations are allowed
      • canDelete

        boolean canDelete()
        Returns:
        true if the document can be deleted
      • canModifyAccess

        boolean canModifyAccess()
        Returns:
        true if access rights can be modified
      • canAnnotate

        boolean canAnnotate()
        Returns:
        true if annotations can be added
      • canModifyIndex

        boolean canModifyIndex()
        Returns:
        true if the document's index data can be modified
      • canExpandIndex

        boolean canExpandIndex()
        Returns:
        true if the document's index data can be expanded
      • canModifyDocument

        boolean canModifyDocument()
        Returns:
        true if the document's content can be modified
      • canUseBlackmarker

        boolean canUseBlackmarker()
        Returns:
        true if blackmarkers can be added
      • canRestoreBlackmarkers

        boolean canRestoreBlackmarkers()
        Returns:
        true if blackmarkers can be removed
      • canSeeRevisionHistory

        boolean canSeeRevisionHistory()
        Returns:
        true if the version history is allowed to be seen
      • canRelease

        boolean canRelease()
        Returns:
        true if the user has the right to release a document
      • canExport

        boolean canExport()
        Returns:
        true if the user has the right to export a document
      • mergeFlags

        void mergeFlags​(ResultAccessData other)
        Merge flags.
        Parameters:
        other - Other access data
      • mergeElementCount

        void mergeElementCount​(ResultAccessData other)
        Merge element count.
        Parameters:
        other - Other access data
      • setCorrectStructure

        void setCorrectStructure​(boolean value)
        Parameters:
        value - True for correct structure.
      • hasCorrectStructure

        boolean hasCorrectStructure()
        Returns:
        Has correct structure.
      • setHasStructure

        void setHasStructure​(boolean value)
        Parameters:
        value - True if document is structured.
      • hasStructure

        boolean hasStructure()
        Returns:
        true if document is structured.
      • setScanned

        void setScanned​(boolean value)
        Parameters:
        value - Is scanned type.
      • isScanned

        boolean isScanned()
        Returns:
        Is scanned
      • getElementCount

        int getElementCount()
        Returns:
        Element count
      • setElementCount

        void setElementCount​(int value)
        Parameters:
        value - Element count
      • canProlongRetention

        boolean canProlongRetention()
        Returns:
        true when user is allowed to prolong documents retention
      • canReduceDisposition

        boolean canReduceDisposition()
        Returns:
        true when user is allowed to reduce documents disposition time
      • canSetLitigationHold

        boolean canSetLitigationHold()
        Returns:
        true when user is allowed to set litigation hold for this document