Package com.saperion.rmi

Interface SaACLRights

All Superinterfaces:
Serializable
All Known Implementing Classes:
SaACLRightsImpl
public interface SaACLRights extends Serializable
This interface collects the permissions a user can have on a Saperion object e.g. a document. An instance of SaACLRight defines the rights a user or group has on a given object.
Author:
rbo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FLGANNOTATE
    internal - do not use
    static final int
    FLGBLACKMARKER
    internal - do not use
    static final int
    FLGCOMPLETE
    internal - do not use
    static final int
    FLGDELETE
    internal - do not use
    static final int
    FLGEXPANDINDEX
    internal - do not use
    static final int
    FLGEXPORT
    internal - do not use
    static final int
    FLGINDEX
    internal - do not use
    static final int
    FLGMODIFYDOC
    internal - do not use
    static final int
    FLGPERMISSIONS
    internal - do not use
    static final int
    FLGREAD
    internal - do not use
    static final int
    FLGRECORDSMANAGEMENT
    internal - do not use
    static final int
    FLGRELEASE
    internal - do not use
    static final int
    FLGRESTOREREVISION
    internal - do not use
    static final int
    FLGREVISIONHISTORIE
    internal - do not use
    static final int
    FLGRIGHTEXTENSION
    internal - do not use
    static final int
    FLGSAVEBLACKMARKERS
    internal - do not use
    static final int
    FLGVISIBLE
    internal - do not use
    static final int
    FLGWRITE
    internal - do not use

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canAnnotate()
    This right defines whether the user may edit annotations on the object.
    boolean
    canBlackMarker()
     
    boolean
    canComplete()
     
    boolean
    canDelete()
    This right defines whether the user may delete the object.
    boolean
    canExpandIndex()
    This right defines whether the user may add new index data to the object.
    boolean
    canExport()
    This right defines whether the user may export the object.
    boolean
    canIndex()
    This right defines whether the user may change index data of the object.
    boolean
    canModifyDoc()
    This right defines whether the user may change content of the object.
    boolean
    canPermissions()
    This right defines whether the user may change which ACLs secure the object.
    boolean
    canRead()
    This right defines whether the user may read or view data of the object.
    boolean
    canRecordsManagement()
     
    boolean
    canRelease()
     
    boolean
    canRestoreRevision()
    This right defines whether the user may undo changes on the object.
    boolean
    canRevisionHistorie()
    This right defines whether the user may read the revision history of the object.
    boolean
    canRightExtension()
    internal - do not use.
    boolean
    canSaveBlackMarkers()
     
    boolean
    canVisible()
    This right defines whether the user may see the object.
    boolean
    canWrite()
    This right defines whether the user may change data of the object.

  • Field Details

  • Method Details

    • canRead

      boolean canRead()
      This right defines whether the user may read or view data of the object.
      Returns:
      whether the user may read the object

    • canWrite

      boolean canWrite()
      This right defines whether the user may change data of the object.
      Returns:
      whether the user may change data of the object

    • canDelete

      boolean canDelete()
      This right defines whether the user may delete the object.
      Returns:
      whether the user may delete the object

    • canPermissions

      boolean canPermissions()
      This right defines whether the user may change which ACLs secure the object.
      Returns:
      whether the user may change which ACLs secure the object

    • canVisible

      boolean canVisible()
      This right defines whether the user may see the object. It is implied by any other right.
      Returns:
      whether the user may see the object

    • canAnnotate

      boolean canAnnotate()
      This right defines whether the user may edit annotations on the object. This right is only valid on documents and it is implied by canWrite().
      Returns:
      whether the user may edit annotations on the object

    • canIndex

      boolean canIndex()
      This right defines whether the user may change index data of the object. This right is only valid on documents and lookup entries. It is implied by canWrite().
      Returns:
      whether the user may change index data of the object

    • canExpandIndex

      boolean canExpandIndex()
      This right defines whether the user may add new index data to the object. This right is only valid on documents and lookup entries. It is implied by canWrite().

      Note that this right is only listed here for legacy reasons. The Saperion Java Core Server does not distinct between canIndex() and canExpandIndex().
      Returns:
      whether the user may new index data to the object

    • canModifyDoc

      boolean canModifyDoc()
      This right defines whether the user may change content of the object. This right is only valid on documents. It is implied by canWrite().
      Returns:
      whether the user may change content of the object

    • canBlackMarker

      boolean canBlackMarker()
      Returns:
      Can black marker.

    • canSaveBlackMarkers

      boolean canSaveBlackMarkers()
      Returns:
      Can save black marker.

    • canRelease

      boolean canRelease()
      Returns:
      Can release.

    • canRevisionHistorie

      boolean canRevisionHistorie()
      This right defines whether the user may read the revision history of the object.
      Returns:
      whether the user may read the revision history of the object

    • canRestoreRevision

      boolean canRestoreRevision()
      This right defines whether the user may undo changes on the object. More specifically a user that has this right may create a new revision that is equal to one of the earlier revisions of the object.
      Returns:
      whether the user may undo changes on the object

    • canExport

      boolean canExport()
      This right defines whether the user may export the object.

      Note that this right is only listed here for legacy reasons. The Saperion Java Core Server does not distinct between canRead() and canExport().
      Returns:
      whether the user may export the object

    • canRightExtension

      boolean canRightExtension()
      internal - do not use.

    • canRecordsManagement

      boolean canRecordsManagement()
      Returns:
      Can records management.

    • canComplete

      boolean canComplete()
      Returns:
      whether every existing right is set