Package com.groiss.dms

Interface RemoteDMS

All Superinterfaces:
Remote
All Known Subinterfaces:
DMS
@Deprecated(since="11.0", forRemoval=true) public interface RemoteDMS extends Remote
Deprecated, for removal: This API element is subject to removal in a future version.
Utility class for DMS related operations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    COPY
    Deprecated, for removal: This API element is subject to removal in a future version.
    use DMS.COPY instead
    static final char[]
    invalidChars
    Deprecated, for removal: This API element is subject to removal in a future version.
    use DMS.invalidChars instead
    static final short
    LINK
    Deprecated, for removal: This API element is subject to removal in a future version.
    use DMS.LINK instead
    static final short
    MOVE
    Deprecated, for removal: This API element is subject to removal in a future version.
    use DMS.MOVE instead

  • Method Summary

    Modifier and Type
    Method
    Description
    <P extends DMSObject>
    P
    add(DMSFolder f, P o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds an Object to a folder.
    <P extends DMSObject>
    P
    add(DMSFolder f, P o, DMS.AddOption ao)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds an Object to a folder.
    void
    addKeyword(DMSObject obj, Keyword keyword)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds the passed keyword to the passed DMSObject
    void
    addSubform(DMSForm main, DMSForm sub, int id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds the passed subform to the mainform into the set of subforms identified by the passed id.
    void
    attachNote(DMSObject target, DMSNote note)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Attaches the passed note to the passed object.
    void
    backupToVersion(DMSForm form, PersistentVersion version)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Makes the content of the passed version to the current content of the passed form.
    <P extends DMSForm>
    P
    changeType(DMSForm obj, FormType newType, DMSFolder folder)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method changes the type of the passed DMSObject to the passed FormType.
    void
    checkDelete(User user, DMSObject obj)
    Deprecated.
    Use OrgData.checkRight(Right, Persistent) instead
    void
    checkDuplicateNames(DMSFolder targetFolder, DMSObject targetObject, String name, String extension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if the passed folder does not already contain an element with the same name as the passed one.
    void
    checkEdit(User user, DMSObject obj)
    Deprecated.
    Use OrgData.checkRight(Right, Persistent) instead
    void
    checkValidName(DMSObject target, String name, String extension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Checks if the name and extension do not contain any forbidden characters
    void
    checkView(User user, DMSObject obj)
    Deprecated.
    Use OrgData.checkRight(Right, Persistent) instead
    int
    countSubforms(DMSForm f, int id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Counts the number of subforms in the subform-relation where f is the main form.
    <P extends DMSDocForm>
    P
    createDocForm(FormType ft, String name, String extension, P template, PermissionList acl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new document of the specified formtype.
    <P extends DMSDocForm>
    P
    createDocForm(String name, String extension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new standard document.
    <P extends DMSFolder>
    P
    createFolder(FormType ft, String name, P template, PermissionList acl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new folder of a given type.
    <P extends DMSFolder>
    P
    createFolder(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new standard folder.
    <P extends DMSForm>
    P
    createForm(FormType ft, P template, PermissionList acl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new form of the specified formtype.
    Keyword
    createKeyword(String word)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new Keyword for the passed word and returns this instance.
    <P extends DMSNote>
    P
    createNote(String subject, String content, PermissionList acl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new note
    <P extends DMSWebLink>
    P
    createWebLink(String name, String url, String description, PermissionList acl)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new link to an URL
    List<DMSObject>
    delete(DMSFolder f, DMSObject o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Deletes the object o which resides in folder f.
    void
    deleteVersion(PersistentVersion version)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Deletes the passed version of an object.
    void
    deleteVersions(DMSForm form)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Deletes all versions of the passed form.
    void
    disableRightChecks()
    Deprecated.
    Use PersistentAspect.add(PersistentAspect...) with PersistentAspect.ALL_PERMISSIONS as parameter instead to disable any permission check.
    List<DMSObject>
    emptyRecycleBin()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Empties the Recycle Bin of the current user - i.e. all its content will now be deleted irrevocably
    void
    enableRightChecks()
    Deprecated.
    Use PersistentAspect.remove(PersistentAspect...) with PersistentAspect.ALL_PERMISSIONS as parameter instead to enable permission check again.
    Map<DMSForm,DMSForm>
    fetchMainForms(Collection<? extends DMSForm> subForms)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Construct a mapping from sub form instances to (filled) main form instances
    MultiMap<DMSForm,DMSForm>
    fetchSubForms(Collection<? extends DMSForm> mainForms, int subformid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Construct a mapping from mainform instances to (filled) subform instances.
    byte[]
    getContent(DMSDocForm document)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the content of a document.
    byte[]
    getContent(PersistentVersion version)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the content of a document's version.
    <P extends DMSObject>
    P
    getDMSObject(long oid)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get a DMSObject by oid.
    <P extends DMSObject>
    P
    getDMSObject(String path)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get a DMSObject by path.
    <P extends DMSFolder>
    P
    getFolder(DMSObject obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the folder containing the passed object.
    FormType
    getFormType(String id, int version)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the formtype with the given id and version number
    <P extends DMSForm>
    P
    getMainForm(DMSForm f)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the main form of the passed form (or null if there is none)
    <P extends DMSFolder>
    P
    getPublicRootFolder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the public root folder in the DMS.
    <P extends DMSFolder>
    P
    getRecentlyUsedFolder(User user)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the recently-used folder for a user
    <P extends DMSFolder>
    P
    getRecycleBin(User user)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the recycle bin for a user.
    <P extends DMSFolder>
    P
    getRootFolder(User user)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the root DMS folder (i.e. it has no parent) for a user.
    <P extends DMSForm>
    List<P>
    getTemplates(FormType ft)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the templates for the passed form type.
    boolean
    isDuplicateName(DMSFolder targetFolder, DMSObject targetObject, String name, String extension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns true if already an item of the passed folder has the passed name
    boolean
    isInRecycleBin(DMSObject target)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns true, if the object in the recylce bin
    <P extends DMSObject>
    List<P>
    listContents(DMSFolder folder, FormType ft, boolean recursive, String cond, String order, Object... vals)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of dms objects which match the passed condition
    <P extends DMSObject>
    List<P>
    listContents(DMSFolder folder, FormType ft, String cond, String order, Object[] vals, boolean recursive)
    Deprecated.
    Use listContents(DMSFolder,FormType,boolean,String,String,Object...) instead
    List<FormType>
    listCreateableFormTypes(String searchCond, String order)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the formtypes which meet the search condition and from which the passed user may create form objects.
    <P extends Keyword>
    List<P>
    listKeywords(DMSObject obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of all keywords attached to the passed DMSObject
    List<DMSNote>
    listNotes(DMSObject target)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns all the notes which are attached to target and which the user may view or edit No System notes are returned
    List<DMSNote>
    listNotes(DMSObject target, boolean includeSystemNotes)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns all the notes which are attached to target and which the user may view or edit
    <P extends DMSFolder>
    List<P>
    listSubfolders(DMSFolder startFolder)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of all folders which are subfolders of the given folder.
    <P extends DMSForm>
    List<P>
    listSubforms(DMSForm f, int id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of subforms of the passed form (which is empty if there are none)
    <P extends DMSForm>
    List<P>
    listSubforms(DMSForm f, int id, String cond, String order, Object... vals)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a list of subforms of the passed form (which is empty if there are none)
    List<PersistentVersion>
    listVersions(DMSObject obj)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the versions of the specified object in descending order of their creation date.
    List<PersistentVersion>
    listVersions(DMSObject obj, String condition, String order, Object... bindVars)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the versions of the specified object matching the specified condition.
    void
    lock(DMSDocForm document)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Locks the document.
    PersistentVersion
    makeVersion(DMSObject obj, String description)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Makes a version of the passed object.
    boolean
    mayDelete(User user, DMSObject obj)
    Deprecated.
    Use OrgData.mayDelete(User, Persistent) instead
    boolean
    mayEdit(User user, DMSObject obj)
    Deprecated.
    Use OrgData.mayUpdate(User, Persistent) instead
    boolean
    mayView(User user, DMSObject obj)
    Deprecated.
    Use OrgData.mayView(User, Persistent) instead
    <P extends DMSObject>
    P
    move(DMSFolder src, DMSFolder dest, P doc, short type)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Moves an object from one folder to another.
    List<DMSObject>
    moveToRecycleBin(DMSFolder f, DMSObject o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Moves the object o which resides in folder f to the Recycle Bin.
    boolean
    remove(DMSFolder f, DMSObject o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes an Object from a folder.
    void
    removeKeyword(DMSObject obj, Keyword keyword)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes the passed keyword from the passed DMSObject
    void
    removeNote(DMSObject target, DMSNote note)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes the passed note from the passed document.
    void
    removeSubform(DMSForm main, DMSForm sub)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes the passed subform from the passed mainform.
    void
    removeSubform(DMSForm main, DMSForm sub, int id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes the passed subform from the subform-relation identified by the passed id in the passed mainform.
    <P extends DMSObject>
    P
    renameDocument(DMSFolder folder, P obj, String newName, String newExtension)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the name and extension of the passed object to newName.
    List<DMSObject>
    restoreFromRecycleBin(DMSObject o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Restores the passed object from recycle bin, i.e. moves it to it original folder if that folder still exists - otherwise an exception is thrown.
    void
    setContent(DMSDocForm document, byte[] barr)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the content of a document.
    void
    signDocuments(List<? extends DMSDocForm> documents, Agent agent, char[] password)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Digital Signing of a list of DMS documents.
    void
    signVersions(List<? extends PersistentVersion> versions, Agent agent, char[] password)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Digital Signing of a list of DMS document version.
    void
    unlock(DMSDocForm document)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Unlocks the document.
    void
    update(DMSObject o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Updates the passed object

  • Field Details

    • MOVE

      @Deprecated(since="11.0", forRemoval=true) static final short MOVE
      Deprecated, for removal: This API element is subject to removal in a future version.
      use DMS.MOVE instead
      Determines that a DMSObject should be moved from one folder to another
      See Also:

    • COPY

      @Deprecated(since="11.0", forRemoval=true) static final short COPY
      Deprecated, for removal: This API element is subject to removal in a future version.
      use DMS.COPY instead
      Determines that a DMSObject should be copied from one folder to another
      See Also:

    • invalidChars

      @Deprecated(since="11.0", forRemoval=true) static final char[] invalidChars
      Deprecated, for removal: This API element is subject to removal in a future version.
      use DMS.invalidChars instead
      holds the characters which are not allowed within the name of a DMSObject

  • Method Details

    • createFolder

      <P extends DMSFolder> P createFolder(String name) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new standard folder.
      Parameters:
      name - the name for the folder
      Returns:
      the new folder
      Throws:
      RemoteException

    • createFolder

      <P extends DMSFolder> P createFolder(FormType ft, String name, P template, PermissionList acl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new folder of a given type.
      Parameters:
      ft - the folder's formtype
      name - the name for the folder
      template - specifies the template which should be used for creating the folder (may be null)
      acl - the acl attached to the new folder (may be null)
      Returns:
      the new folder
      Throws:
      RemoteException

    • createDocForm

      <P extends DMSDocForm> P createDocForm(String name, String extension) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new standard document.
      Parameters:
      name - the name of the new DocForm
      extension - the file extension of the new document
      Returns:
      the new document
      Throws:
      RemoteException

    • createDocForm

      <P extends DMSDocForm> P createDocForm(FormType ft, String name, String extension, P template, PermissionList acl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new document of the specified formtype.
      Parameters:
      ft - the document's formtype
      name - the name of the new DocForm
      extension - the file extension of the new document (this parameter is ignored if a template is passed because then the template determines the extension)
      template - specifies the template which should be used for creating the folder (may be null)
      acl - the acl if one should be set (otherwise pass null)
      Returns:
      the new document
      Throws:
      RemoteException

    • createForm

      <P extends DMSForm> P createForm(FormType ft, P template, PermissionList acl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new form of the specified formtype. The form will be inserted to the database and therefore contain an oid.
      Parameters:
      ft - the form's formtype
      template - specifies the template which should be used for creating the folder (may be null)
      acl - the acl if one should be set (otherwise pass null)
      Returns:
      the new form
      Throws:
      RemoteException

    • createNote

      <P extends DMSNote> P createNote(String subject, String content, PermissionList acl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new note
      Parameters:
      subject - the subject of the note
      content - the content of the note
      acl - the acl if one should be set (otherwise pass null)
      Returns:
      the new form
      Throws:
      RemoteException

    • createWebLink

      <P extends DMSWebLink> P createWebLink(String name, String url, String description, PermissionList acl) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new link to an URL
      Parameters:
      name - the name of the weblink
      url - the url of the weblink
      description - a description text of the the weblink
      acl - the acl if one should be set (otherwise pass null)
      Returns:
      the new weblink
      Throws:
      RemoteException

    • getFormType

      FormType getFormType(String id, int version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the formtype with the given id and version number
      Throws:
      RemoteException

    • getTemplates

      <P extends DMSForm> List<P> getTemplates(FormType ft) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the templates for the passed form type.
      Parameters:
      ft - the form type of which the templates are wanted
      Returns:
      a list of form objects
      Throws:
      RemoteException

    • listCreateableFormTypes

      List<FormType> listCreateableFormTypes(String searchCond, String order) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the formtypes which meet the search condition and from which the passed user may create form objects.
      Parameters:
      searchCond - a sql where-clause
      order - sql order attributes
      Throws:
      RemoteException

    • move

      <P extends DMSObject> P move(DMSFolder src, DMSFolder dest, P doc, short type) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Moves an object from one folder to another.
      Parameters:
      src - the folder currently holding the object
      dest - the folder to which the objects should be moved
      doc - the object which should be moved
      type - the type of move operation:
      • DMS.MOVE: the object should be moved (i.e. removed from src and added to dest)
      • DMS.COPY: the object should be copied (i.e. stays in src and a copy is added to dest)
      • DMS.LINK: the object should be linked (i.e. stays in src and a link to the object is added to dest)
      Throws:
      RemoteException

    • add

      <P extends DMSObject> P add(DMSFolder f, P o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds an Object to a folder. Use this method after creation of the object.
      Parameters:
      f - the folder to which the object should be added
      o - the object which should be added to the folder
      Throws:
      RemoteException

    • add

      <P extends DMSObject> P add(DMSFolder f, P o, DMS.AddOption ao) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds an Object to a folder. Use this method after creation of the object.
      Parameters:
      f - the folder to which the object should be added
      o - the object which should be added to the folder
      ao - define the behaviour for name conflicts.
      Throws:
      RemoteException

    • remove

      boolean remove(DMSFolder f, DMSObject o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes an Object from a folder. NOTE: this will not delete the passed object but only remove it from the folders contents
      Parameters:
      f - the folder from which the object should be removed
      o - the object which should be removed from the folder
      Returns:
      true if this collection changed as a result of the call
      Throws:
      RemoteException

    • delete

      List<DMSObject> delete(DMSFolder f, DMSObject o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deletes the object o which resides in folder f. This will also remove the object from the folder. If o is a folder all its content will also be deleted.
      Parameters:
      f - the folder holding the object which should be deleted
      o - the object which should be deleted
      Returns:
      a list of all objects deleted by this request
      Throws:
      RemoteException

    • attachNote

      void attachNote(DMSObject target, DMSNote note) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Attaches the passed note to the passed object.
      Parameters:
      target - the object to which the note should be attached
      note - the note which should be attached
      Throws:
      RemoteException

    • removeNote

      void removeNote(DMSObject target, DMSNote note) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the passed note from the passed document.
      Parameters:
      target - the object form which the note should be removed
      note - the note which should be removed
      Throws:
      RemoteException

    • listNotes

      List<DMSNote> listNotes(DMSObject target) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns all the notes which are attached to target and which the user may view or edit No System notes are returned
      Parameters:
      target - the object which notes are wanted
      Throws:
      RemoteException

    • listNotes

      List<DMSNote> listNotes(DMSObject target, boolean includeSystemNotes) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns all the notes which are attached to target and which the user may view or edit
      Parameters:
      target - the object which notes are wanted
      includeSystemNotes - determines if system notes should be returned. true if system notes should be found.
      Returns:
      Throws:
      RemoteException
      Exception

    • makeVersion

      PersistentVersion makeVersion(DMSObject obj, String description) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Makes a version of the passed object.
      Parameters:
      obj - the object which should be versioned
      description - the version description text
      Throws:
      RemoteException

    • deleteVersion

      void deleteVersion(PersistentVersion version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deletes the passed version of an object.
      Parameters:
      version - the version to be deleted
      Throws:
      RemoteException

    • listVersions

      List<PersistentVersion> listVersions(DMSObject obj) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the versions of the specified object in descending order of their creation date.
      Parameters:
      obj - the object which versions are requested
      Throws:
      RemoteException

    • listVersions

      List<PersistentVersion> listVersions(DMSObject obj, String condition, String order, Object... bindVars) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the versions of the specified object matching the specified condition.
      Parameters:
      obj - the object which versions are requested
      condition - the condition the versions must match (columns of avw_log can be used to filter version records)
      order - a comma separated list of column names of avw_log.
      bindVars - values for the parameters in condition
      Throws:
      RemoteException

    • backupToVersion

      void backupToVersion(DMSForm form, PersistentVersion version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Makes the content of the passed version to the current content of the passed form.
      Parameters:
      form - the object which should be reset to the passed the version
      version - the version which content should be used (it must be a version of the passed form)
      Throws:
      RemoteException

    • deleteVersions

      void deleteVersions(DMSForm form) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Deletes all versions of the passed form.
      Parameters:
      form - the object which versions should be deleted
      Throws:
      RemoteException

    • getContent

      byte[] getContent(PersistentVersion version) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the content of a document's version.
      Parameters:
      version - the version
      Returns:
      a byte array
      Throws:
      RemoteException

    • getRootFolder

      <P extends DMSFolder> P getRootFolder(User user) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the root DMS folder (i.e. it has no parent) for a user.
      Parameters:
      user - the user who's root folder is requested.
      Throws:
      RemoteException

    • getPublicRootFolder

      <P extends DMSFolder> P getPublicRootFolder() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the public root folder in the DMS.
      Throws:
      RemoteException

    • getRecycleBin

      <P extends DMSFolder> P getRecycleBin(User user) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the recycle bin for a user.
      Parameters:
      user - the user who's recycle bin is requested.
      Throws:
      RemoteException

    • getRecentlyUsedFolder

      <P extends DMSFolder> P getRecentlyUsedFolder(User user) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the recently-used folder for a user
      Parameters:
      user - the user who's recently-used folder is requested
      Returns:
      Throws:
      RemoteException

    • getDMSObject

      <P extends DMSObject> P getDMSObject(long oid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a DMSObject by oid. This method will only find DMSObjects which are elements of a DMSFolder.
      Parameters:
      oid - the oid of the requested object
      Throws:
      RemoteException

    • getDMSObject

      <P extends DMSObject> P getDMSObject(String path) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get a DMSObject by path. The path is a string of DMSObject names separated with '/' whereas each element in the path must be a folder's name except the last one (e.g. 'Common/my_directory/my_file.txt'). For the DMS top-level folders the following place holders may be used: 'COMMON' for public root 'USER' for DMS root folder of the current user 'RECYCLEBIN' for the recycle bin of the current user So the above example may also be specified as 'COMMON/my_directory/my_file.txt' in which case the actual name of the public root is not relevant anymore. Note: This method will only find DMSObjects which are elements of a DMSFolder.
      Parameters:
      path - the path leading to the wanted DMSObject
      Throws:
      RemoteException

    • getFolder

      <P extends DMSFolder> P getFolder(DMSObject obj) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the folder containing the passed object.
      Parameters:
      obj - the object which folder is wanted
      Throws:
      RemoteException

    • listSubfolders

      <P extends DMSFolder> List<P> listSubfolders(DMSFolder startFolder) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of all folders which are subfolders of the given folder. ATTENTION: the found folders are not filled, only their oids are set
      Parameters:
      startFolder - the folder which subfolders are requested
      Throws:
      RemoteException

    • getMainForm

      <P extends DMSForm> P getMainForm(DMSForm f) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the main form of the passed form (or null if there is none)
      Parameters:
      f - the form for which the mainform is needed
      Throws:
      RemoteException

    • listSubforms

      <P extends DMSForm> List<P> listSubforms(DMSForm f, int id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of subforms of the passed form (which is empty if there are none)
      Parameters:
      f - the form of which the subforms are needed
      id - the id of the wanted subforms
      Throws:
      RemoteException

    • listSubforms

      <P extends DMSForm> List<P> listSubforms(DMSForm f, int id, String cond, String order, Object... vals) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of subforms of the passed form (which is empty if there are none)
      Parameters:
      f - the form of which the subforms are needed
      id - the id of the wanted subforms
      cond - the condition which must match. This allows additional filtering within the subform table, e.g. 'amount > 10000' where 'amount' is a column in the database table of the subform class determined by the passed id.
      order - the sorting order
      vals - values for the parameters in condition of a prepared statement
      Throws:
      RemoteException

    • countSubforms

      int countSubforms(DMSForm f, int id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Counts the number of subforms in the subform-relation where f is the main form.
      Parameters:
      f - the form of which the subforms will be counted
      id - the id of the subform relation
      Throws:
      RemoteException

    • removeSubform

      void removeSubform(DMSForm main, DMSForm sub) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the passed subform from the passed mainform. NOTE: only the relation between the main- and the subform is removed, the subform will not be deleted by this method. Also the mainform will not be updated - so it may be the case that users can still see the removed subform in the browser if the mainform is gotten from the browser cache.
      Parameters:
      main - the mainform. If null is passed all main-subform-relations in which the passed subform is referenced as subform will be removed.
      sub - the subform to remove
      Throws:
      RemoteException

    • removeSubform

      void removeSubform(DMSForm main, DMSForm sub, int id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the passed subform from the subform-relation identified by the passed id in the passed mainform. NOTE: only the relation between the main- and the subform is removed, the subform will not be deleted by this method. Also the mainform will not be updated - so it may be the case that users can still see the removed subform in the browser if the mainform is gotten from the browser cache.
      Parameters:
      main - the mainform. If null is passed all main-subform-relations in which the passed subform is referenced as subform will be removed.
      sub - the subform to remove
      id - the id of the subform-relation from which the subform should be removed
      Throws:
      RemoteException

    • addSubform

      void addSubform(DMSForm main, DMSForm sub, int id) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds the passed subform to the mainform into the set of subforms identified by the passed id. NOTE: the mainform will not be updated - so it may be the case that users can't see the added subform in the browser if the mainform is gotten from the browser cache.
      Parameters:
      main - the mainform
      sub - the subform to add
      id - the id of the set of subform to which the passed subform should be added
      Throws:
      RemoteException

    • fetchSubForms

      MultiMap<DMSForm,DMSForm> fetchSubForms(Collection<? extends DMSForm> mainForms, int subformid) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Construct a mapping from mainform instances to (filled) subform instances.
      Parameters:
      mainForms - the referencing mainforms
      subformid - the id of the subform (tablefield) to get
      Returns:
      the mapping from mainforms to subforms
      Throws:
      RemoteException

    • fetchMainForms

      Map<DMSForm,DMSForm> fetchMainForms(Collection<? extends DMSForm> subForms) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Construct a mapping from sub form instances to (filled) main form instances
      Parameters:
      subForms - the referencing subforms
      Returns:
      the mapping from subforms to mainforms
      Throws:
      RemoteException

    • listContents

      @Deprecated <P extends DMSObject> List<P> listContents(DMSFolder folder, FormType ft, String cond, String order, Object[] vals, boolean recursive) throws RemoteException
      Deprecated.
      Use listContents(DMSFolder,FormType,boolean,String,String,Object...) instead
      Returns a list of dms objects which match the passed condition
      Parameters:
      folder - the folder whose content is wanted
      ft - the formtype of the desired objects
      cond - the condition which must match. The following columns are available for parameter cond and order:
      • if the passed formtype is null:
        • t0.form the oid of the content element
        • t0.docname the name of the content element
        • t0.dept the oid of the department
        • t0.owner the oid of the owner (= creator)
        • t0.createdat the creation date
        • t0.changedat the date of the last change
      • if the passed formtype is not null you can use all columns of the specified form type's table. For those columns you must also use the table alias t0 as described in the listing above
      order - the sorting order (for available columns see parameter cond)
      vals - the values of the parameters in cond
      recursive - determines if the search should also include all subfolders
      Throws:
      RemoteException

    • listContents

      <P extends DMSObject> List<P> listContents(DMSFolder folder, FormType ft, boolean recursive, String cond, String order, Object... vals) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of dms objects which match the passed condition
      Parameters:
      folder - the folder whose content is wanted
      ft - the formtype of the desired objects
      recursive - determines if the search should also include all subfolders
      cond - the condition which must match. The following columns are available for parameter cond and order:
      • if the passed formtype is null:
        • t0.form the oid of the content element
        • t0.docname the name of the content element
        • t0.dept the oid of the department
        • t0.owner the oid of the owner (= creator)
        • t0.createdat the creation date
        • t0.changedat the date of the last change
      • if the passed formtype is not null you can use all columns of the specified form type's table. For those columns you must also use the table alias t0 as described in the listing above
      order - the sorting order (for available columns see parameter cond)
      vals - the values of the parameters in cond of a prepared statement
      Throws:
      RemoteException

    • renameDocument

      <P extends DMSObject> P renameDocument(DMSFolder folder, P obj, String newName, String newExtension) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the name and extension of the passed object to newName.
      Parameters:
      folder - the folder the document belongs to
      obj - the object which should be renamed
      newName - the new name for the document
      newExtension - the new extension for the document. This parameter is ignored if the passed object is not a DMSDocForm.
      Throws:
      RemoteException

    • setContent

      void setContent(DMSDocForm document, byte[] barr) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the content of a document.
      Parameters:
      document - the document
      barr - a byte array
      Throws:
      RemoteException

    • getContent

      byte[] getContent(DMSDocForm document) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the content of a document.
      Parameters:
      document - the document
      Returns:
      a byte array
      Throws:
      RemoteException

    • lock

      void lock(DMSDocForm document) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Locks the document.
      Parameters:
      document - the document
      Throws:
      RemoteException

    • unlock

      void unlock(DMSDocForm document) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Unlocks the document.
      Parameters:
      document - the document
      Throws:
      RemoteException

    • changeType

      <P extends DMSForm> P changeType(DMSForm obj, FormType newType, DMSFolder folder) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method changes the type of the passed DMSObject to the passed FormType. All system definied metadata will be copied, all type specific metadata will not (except the name attribute). Only DMSFolders and DMSDocForms may change their types. Note: because the @enterprise persistence mechanism needs the oid and class name of instances of interfaces and abstract classes there are some changes to be done in other tables to correct the class name (the oid will stay the same when changing the type). If you have your own tables where you hold references to such objects you have to handle the change in these tables by yourself.
      Parameters:
      obj - the objects which type should be changed
      newType - the new type for the passed object
      folder - the folder of which the object is a content member
      Throws:
      RemoteException

    • update

      void update(DMSObject o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Updates the passed object
      Parameters:
      o - the object to be updated
      Throws:
      RemoteException

    • moveToRecycleBin

      List<DMSObject> moveToRecycleBin(DMSFolder f, DMSObject o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Moves the object o which resides in folder f to the Recycle Bin. If o is a folder also its content will be moved to the Bin (recursively).
      Parameters:
      f - the folder holding the object which should be deleted
      o - the object which should be deleted
      Returns:
      all object moved to the Recycle Bin by this call
      Throws:
      RemoteException

    • restoreFromRecycleBin

      List<DMSObject> restoreFromRecycleBin(DMSObject o) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Restores the passed object from recycle bin, i.e. moves it to it original folder if that folder still exists - otherwise an exception is thrown. If o is a folder also its content will be restored
      Parameters:
      o - the object to restore
      Returns:
      the restored objects
      Throws:
      RemoteException

    • emptyRecycleBin

      List<DMSObject> emptyRecycleBin() throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Empties the Recycle Bin of the current user - i.e. all its content will now be deleted irrevocably
      Returns:
      the deleted objects
      Throws:
      RemoteException

    • createKeyword

      Keyword createKeyword(String word) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new Keyword for the passed word and returns this instance.
      Parameters:
      word - the string representing the wanted keyword
      Returns:
      the new keyword
      Throws:
      RemoteException

    • addKeyword

      void addKeyword(DMSObject obj, Keyword keyword) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds the passed keyword to the passed DMSObject
      Parameters:
      obj - the object to which the keyword should be added
      keyword - the keyword which should be added
      Throws:
      RemoteException

    • removeKeyword

      void removeKeyword(DMSObject obj, Keyword keyword) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the passed keyword from the passed DMSObject
      Parameters:
      obj - the object from which the keyword should be removed
      keyword - the keyword which should be removed
      Throws:
      RemoteException

    • listKeywords

      <P extends Keyword> List<P> listKeywords(DMSObject obj) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a list of all keywords attached to the passed DMSObject
      Parameters:
      obj - the object which the keywords should be returned
      Returns:
      a list of all keywords of a given DMSObject
      Throws:
      RemoteException

    • disableRightChecks

      @Deprecated void disableRightChecks() throws RemoteException
      Deprecated.
      Use PersistentAspect.add(PersistentAspect...) with PersistentAspect.ALL_PERMISSIONS as parameter instead to disable any permission check. If you use the following code pattern you do not need to care about removing the added aspect on your own: 
      
 try (SilentCloseable sc = PersistentAspect.add(PersistentAspect.ALL_PERMISSIONS)) {
    //do your DMS related unchecked stuff
 }
      If this method is called all right checks done using methods checkEdit(User, DMSObject), checkView(User, DMSObject), mayEdit(User, DMSObject) and mayView(User, DMSObject) are deactivated in the current thread. But be aware to enable the right check at the end of your actions because threads are reused in our system.
      Throws:
      RemoteException

    • enableRightChecks

      @Deprecated void enableRightChecks() throws RemoteException
      Deprecated.
      Use PersistentAspect.remove(PersistentAspect...) with PersistentAspect.ALL_PERMISSIONS as parameter instead to enable permission check again. When you're using the code pattern described in disableRightChecks() you will not need to call PersistentAspect.remove(PersistentAspect...) on your own.
      enables the right checks if they were previously disabled using method disableRightChecks().
      Throws:
      RemoteException

    • checkEdit

      @Deprecated void checkEdit(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.checkRight(Right, Persistent) instead
      Throws ApplicationException Nr. 27 if the passed user may NOT edit the passed object
      Parameters:
      user - the user who wants to edit the object
      obj - the object which should be edited
      Throws:
      RemoteException

    • checkView

      @Deprecated void checkView(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.checkRight(Right, Persistent) instead
      Throws ApplicationException Nr. 27 if the passed user may NOT view the passed object
      Parameters:
      user - the user who wants to view the object
      obj - the object which should be viewed
      Throws:
      RemoteException

    • checkDelete

      @Deprecated void checkDelete(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.checkRight(Right, Persistent) instead
      Throws ApplicationException Nr. 27 if the passed user may NOT delete the passed object
      Parameters:
      user - the user who wants to delete the object
      obj - the object which should be deleted
      Throws:
      RemoteException

    • mayEdit

      @Deprecated boolean mayEdit(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.mayUpdate(User, Persistent) instead
      Returns true if the passed user may edit the passed object or if the right check is deactivated. Otherwise false is returned.
      Parameters:
      user - the user who wants to edit the object
      obj - the object which should be edited
      Throws:
      RemoteException

    • mayView

      @Deprecated boolean mayView(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.mayView(User, Persistent) instead
      Returns true if the passed user may view the passed object or if the right check is deactivated. Otherwise false is returned.
      Parameters:
      user - the user who wants to view the object
      obj - the object which should be viewed
      Throws:
      RemoteException

    • mayDelete

      @Deprecated boolean mayDelete(User user, DMSObject obj) throws RemoteException
      Deprecated.
      Use OrgData.mayDelete(User, Persistent) instead
      Returns true if the passed user may delete the passed object or if the right check is deactivated. Otherwise false is returned.
      Parameters:
      user - the user who wants to delete the object
      obj - the object which should be deleted
      Throws:
      RemoteException

    • checkValidName

      void checkValidName(DMSObject target, String name, String extension) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the name and extension do not contain any forbidden characters
      Parameters:
      target - the object to which the name belongs to (or will belong to)
      name - the name which should be checked
      extension - the extension which should be checked
      Throws:
      RemoteException

    • checkDuplicateNames

      void checkDuplicateNames(DMSFolder targetFolder, DMSObject targetObject, String name, String extension) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Checks if the passed folder does not already contain an element with the same name as the passed one.
      Parameters:
      targetFolder - the folder in which should be checked
      targetObject - the object the name belongs to (or will belong to)
      name - the name which should be checked
      extension - the extension which should be checked
      Throws:
      RemoteException

    • isDuplicateName

      boolean isDuplicateName(DMSFolder targetFolder, DMSObject targetObject, String name, String extension) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if already an item of the passed folder has the passed name
      Parameters:
      targetFolder - the folder in which should be checked
      targetObject - the object the name belongs to (or will belong to)
      name - the name which should be checked
      extension - the extension which should be checked
      Throws:
      RemoteException

    • isInRecycleBin

      boolean isInRecycleBin(DMSObject target) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true, if the object in the recylce bin
      Parameters:
      target - the object, which should be checked
      Throws:
      RemoteException

    • signDocuments

      void signDocuments(List<? extends DMSDocForm> documents, Agent agent, char[] password) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Digital Signing of a list of DMS documents. Implemented only for PDF documents.
      Parameters:
      documents - a List of documents to sign
      agent - the agent (role or user) which is signing the document
      password - the password of the private key used to sign document
      Throws:
      RemoteException

    • signVersions

      void signVersions(List<? extends PersistentVersion> versions, Agent agent, char[] password) throws RemoteException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Digital Signing of a list of DMS document version. Implemented only for PDF documents.
      Parameters:
      versions - a List of versions to sign
      agent - the agent (role or user) which is signing the document
      password - the password of the private key used to sign document
      Throws:
      RemoteException