Package com.groiss.dms

Interface DMSObject

All Superinterfaces:
HasOwner, HasPermissionList, KeyValuePair<String,String>, OptimisticLocking, Persistent, Serializable
All Known Subinterfaces:
DMSDocForm, DMSFolder, DMSFolderForm, DMSForm, DMSLink, DMSNote, DMSWebLink
public interface DMSObject extends HasOwner, HasPermissionList, Persistent, OptimisticLocking

  • Method Details

    • getName

      String getName()
      Returns the name of this object.

    • setName

      void setName(String name)
      Sets the name of this object to passed string.
      Parameters:
      name - the new name

    • getCreatedAt

      Date getCreatedAt()
      Returns the date when this object was created

    • getCreatedBy

      User getCreatedBy()
      Returns the user who created this object

    • getChangedAt

      Date getChangedAt()
      Returns the date of the last modification of this object.

    • getChangedBy

      User getChangedBy()
      Returns the user who made the last modification of this object.

    • getTypeName

      String getTypeName()
      Returns a string representing the type of this object.

    • makeCopy

      DMSObject makeCopy(User user)
      Returns a copy of this object.
      Parameters:
      user - the user who wants to make the copy.

    • makeVersion

      PersistentVersion makeVersion(User user, String description)
      Makes a version of this object with the passed string as version description
      Parameters:
      user - the user who wants to make the version
      description - the description text for this version

    • listVersions

      List<PersistentVersion> listVersions()
      Returns the versions of this form in descending order of their creation date
      Returns:
      a list of PersistentVersion objects.

    • hasVersions

      boolean hasVersions()
      Returns if this form has at least one version.

    • attachNote

      void attachNote(DMSNote note, User user)
      Attaches the passed note to this object
      Parameters:
      note - the note to be attached
      user - the user who wants to attach the note

    • removeNote

      void removeNote(DMSNote note, User user)
      Removes the passed note from this object
      Parameters:
      note - the note to be removed
      user - the user who wants to remove the note

    • listAttachedNotes

      List<DMSNote> listAttachedNotes(User user)
      Returns a list of the attached notes of this object on which the passed user has the right to view them. If user is null all notes are returned
      Parameters:
      user - the user who requests the attached notes

    • hasAttachedNotes

      boolean hasAttachedNotes(User user)
      Returns if there are any notes attached to this document which are visible to the passed user. If user is null it returns true if at least one note is attached (false otherwise).
      Parameters:
      user - the user for whom this request is performed