COPY, invalidChars, LINK, MOVE
Modifier and Type | Method and Description |
---|---|
<P extends DMSObject> |
add(DMSFolder f,
P o)
Adds an Object to a folder.
|
<P extends DMSObject> |
add(DMSFolder f,
P o,
User u)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
add(DMSFolder, DMSObject) instead. |
void |
addKeyword(DMSObject obj,
Keyword keyword)
Adds the passed keyword to the passed DMSObject
|
void |
addKeyword(DMSObject obj,
Keyword keyword,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
addKeyword(DMSObject, Keyword) instead. |
void |
addSubform(DMSForm main,
DMSForm sub,
int id)
Adds the passed subform to the mainform into the set of subforms identified by the passed id.
|
void |
attachNote(DMSObject target,
DMSNote note)
Attaches the passed note to the passed object.
|
void |
attachNote(DMSObject target,
DMSNote note,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
attachNote(DMSObject, DMSNote) instead. |
void |
backupToVersion(DMSForm form,
PersistentVersion version)
Makes the content of the passed version to the current content of the passed form.
|
void |
backupToVersion(DMSForm form,
PersistentVersion version,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
backupToVersion(DMSForm, PersistentVersion) instead. |
<P extends DMSForm> |
changeType(DMSForm obj,
FormType newType,
DMSFolder folder)
This method changes the type of the passed DMSObject to the passed FormType.
|
<P extends DMSForm> |
changeType(DMSForm obj,
FormType newType,
DMSFolder folder,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
changeType(DMSForm, FormType, DMSFolder) instead. |
void |
checkDelete(User user,
DMSObject obj)
Throws
ApplicationException Nr. 27 if the passed user may NOT delete the passed object |
void |
checkDuplicateNames(DMSFolder targetFolder,
DMSObject targetObject,
java.lang.String name,
java.lang.String extension)
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)
Throws
ApplicationException Nr. 27 if the passed user may NOT edit the passed object |
void |
checkValidName(DMSObject target,
java.lang.String name,
java.lang.String extension)
Checks if the name and extension do not contain any forbidden characters
|
void |
checkView(User user,
DMSObject obj)
Throws
ApplicationException Nr. 27 if the passed user may NOT view the passed object |
int |
countSubforms(DMSForm f,
int id)
Counts the number of subforms in the subform-relation where
f is
the main form. |
<P extends DMSDocForm> |
createDocForm(FormType ft,
java.lang.String name,
java.lang.String extension,
P template,
PermissionList acl)
Creates a new document of the specified formtype.
|
<P extends DMSDocForm> |
createDocForm(FormType ft,
java.lang.String name,
java.lang.String extension,
P template,
User u,
PermissionList acl)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createDocForm(FormType, String, String, DMSDocForm, PermissionList) instead. |
<P extends DMSDocForm> |
createDocForm(java.lang.String name,
java.lang.String extension)
Creates a new standard document.
|
<P extends DMSFolder> |
createFolder(FormType ft,
java.lang.String name,
P template,
PermissionList acl)
Creates a new folder of a given type.
|
<P extends DMSFolder> |
createFolder(FormType ft,
java.lang.String name,
P template,
User u,
PermissionList acl)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createFolder(FormType, String, DMSFolder, PermissionList) instead. |
<P extends DMSFolder> |
createFolder(java.lang.String name)
Creates a new standard folder.
|
<P extends DMSForm> |
createForm(FormType ft,
P template,
PermissionList acl)
Creates a new form of the specified formtype.
|
<P extends DMSForm> |
createForm(FormType ft,
P template,
User u,
PermissionList acl)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createForm(FormType, DMSForm, PermissionList) instead. |
Keyword |
createKeyword(java.lang.String word)
Creates a new Keyword for the passed word and returns this instance.
|
Keyword |
createKeyword(java.lang.String word,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createKeyword(String) instead. |
<P extends DMSNote> |
createNote(java.lang.String subject,
java.lang.String content,
PermissionList acl)
Creates a new note
|
<P extends DMSNote> |
createNote(java.lang.String subject,
java.lang.String content,
User u,
PermissionList acl)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createNote(String, String, PermissionList) instead. |
<P extends DMSWebLink> |
createWebLink(java.lang.String name,
java.lang.String url,
java.lang.String description,
PermissionList acl)
Creates a new link to an URL
|
<P extends DMSWebLink> |
createWebLink(java.lang.String name,
java.lang.String url,
java.lang.String description,
User u,
PermissionList acl)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
createWebLink(String, String, String, PermissionList) instead. |
java.util.List<DMSObject> |
delete(DMSFolder f,
DMSObject o)
Deletes the object o which resides in folder f.
|
void |
delete(DMSFolder f,
DMSObject o,
User u)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
delete(DMSFolder, DMSObject) instead. |
void |
deleteKeyword(Keyword keyword,
User user)
Deprecated.
|
void |
deleteVersion(PersistentVersion version)
Deletes the passed version of an object.
|
void |
deleteVersion(PersistentVersion version,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
deleteVersion(PersistentVersion) instead. |
void |
disableRightChecks()
If this method is called all right checks done using methods
RemoteDMS.checkEdit(User, DMSObject) , RemoteDMS.checkView(User, DMSObject) ,
RemoteDMS.mayEdit(User, DMSObject) and RemoteDMS.mayView(User, DMSObject) are deactivated in the current thread. |
java.util.List<DMSObject> |
emptyRecycleBin()
Empties the Recycle Bin of the current user - i.e. all its content will now be deleted irrevocably
|
void |
enableRightChecks()
enables the right checks if they were previously disabled using method
RemoteDMS.disableRightChecks() . |
java.util.Map<DMSForm,DMSForm> |
fetchMainForms(java.util.Collection<? extends DMSForm> subForms)
Construct a mapping from sub form instances to (filled) main form instances
|
MultiMap<DMSForm,DMSForm> |
fetchSubForms(java.util.Collection<? extends DMSForm> mainForms,
int subformid)
Construct a mapping from mainform instances to (filled) subform instances.
|
byte[] |
getContent(DMSDocForm document)
Get the content of a document.
|
byte[] |
getContent(PersistentVersion version)
Get the content of a document's version.
|
java.io.InputStream |
getContentAsStream(DMSDocForm document)
Get an InputStream to the content of a document.
|
java.io.InputStream |
getContentAsStream(PersistentVersion version)
Get an InputStream to the content of a document's version.
|
<P extends DMSObject> |
getDMSObject(long oid)
Get a DMSObject by oid.
|
<P extends DMSObject> |
getDMSObject(java.lang.String path)
Get a DMSObject by path.
|
<P extends DMSObject> |
getDMSObject(java.lang.String classname,
long oid)
Deprecated.
|
<P extends DMSFolder> |
getFolder(DMSObject obj)
Get the folder containing the passed object.
|
FormType |
getFormType(long oid)
Deprecated.
|
FormType |
getFormType(java.lang.String id,
int version)
Returns the formtype with the given id and version number
|
java.lang.String |
getIcon(java.lang.String extension)
Deprecated.
|
java.lang.String |
getIconFromMimetype(java.lang.String mimetype)
Deprecated.
|
Keyword |
getKeyword(long oid)
Deprecated.
|
<P extends DMSForm> |
getMainForm(DMSForm f)
Returns the main form of the passed form (or null if there is none)
|
<P extends DMSFolder> |
getPublicRootFolder()
Returns the public root folder in the DMS.
|
<P extends DMSFolder> |
getRecycleBin(User user)
Returns the recycle bin for a user.
|
<P extends DMSFolder> |
getRootFolder(User user)
Returns the root DMS folder (i.e. it has no parent) for a user.
|
<P extends DMSForm> |
getTemplates(FormType ft)
Returns the templates for the passed form type.
|
boolean |
isDuplicateName(DMSFolder targetFolder,
DMSObject targetObject,
java.lang.String name,
java.lang.String extension)
Returns true if already an item of the passed folder has the passed name
|
<P extends DMSObject> |
listContents(DMSFolder folder,
FormType ft,
java.lang.String cond,
java.lang.String order,
java.lang.Object[] vals,
boolean recursive)
Returns a list of dms objects which match the passed condition
|
java.util.List<FormType> |
listCreateableFormTypes(java.lang.String searchCond,
java.lang.String order)
Returns the formtypes which meet the search condition and from which the passed user may create
form objects.
|
java.util.List<FormType> |
listCreateableFormTypes(java.lang.String searchCond,
java.lang.String order,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
listCreateableFormTypes(String, String) instead. |
<P extends DMSForm> |
listForms(FormType ft,
java.lang.String cond,
java.lang.String order,
java.lang.Object[] vals)
Deprecated.
|
<P extends Keyword> |
listKeywords()
Deprecated.
|
<P extends Keyword> |
listKeywords(DMSObject obj)
Returns a list of all keywords attached to the passed DMSObject
|
java.util.List<DMSNote> |
listNotes(DMSObject target)
Returns all the notes which are attached to target and which the user may view or edit
No System notes are returned
|
java.util.List<DMSNote> |
listNotes(DMSObject target,
boolean includeSystemNodes)
Returns all the notes which are attached to target and which the user may view or edit
|
java.util.List<DMSNote> |
listNotes(DMSObject target,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
listNotes(DMSObject) instead. |
<P extends DMSFolder> |
listSubfolders(DMSFolder startFolder)
Returns a list of all folders which are subfolders of the given folder.
|
<P extends DMSForm> |
listSubforms(DMSForm f,
int id)
Returns a list of subforms of the passed form (which is empty if there are none)
|
<P extends DMSForm> |
listSubforms(DMSForm f,
int id,
java.lang.String cond,
java.lang.String order,
java.lang.Object[] vals)
Returns a list of subforms of the passed form (which is empty if there are none)
|
java.util.List<PersistentVersion> |
listVersions(DMSObject obj)
Returns the versions of the specified object in descending order of their creation date.
|
java.util.List<PersistentVersion> |
listVersions(DMSObject obj,
java.lang.String condition,
java.lang.String order,
java.lang.Object[] bindVars)
Returns the versions of the specified object matching the specified condition.
|
java.util.List<PersistentVersion> |
listVersions(DMSObject obj,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
listVersions(DMSObject) instead. |
void |
lock(DMSDocForm document)
Locks the document.
|
void |
lock(DMSDocForm document,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
lock(DMSDocForm) instead. |
PersistentVersion |
makeVersion(DMSObject obj,
java.lang.String description)
Makes a version of the passed object.
|
PersistentVersion |
makeVersion(DMSObject obj,
User user,
java.lang.String description)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
makeVersion(DMSObject, String) instead. |
boolean |
mayDelete(User user,
DMSObject obj)
Returns true if the passed user may delete the passed object or if the right check
is deactivated.
|
boolean |
mayEdit(User user,
DMSObject obj)
Returns true if the passed user may edit the passed object or if the right check is
deactivated.
|
boolean |
mayView(User user,
DMSObject obj)
Returns true if the passed user may view the passed object or if the right check
is deactivated.
|
<P extends DMSObject> |
move(DMSFolder src,
DMSFolder dest,
P doc,
short type)
Moves an object from one folder to another.
|
<P extends DMSObject> |
move(DMSFolder src,
DMSFolder dest,
P doc,
short type,
User u)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
move(DMSFolder, DMSFolder, DMSObject, short) instead. |
java.util.List<DMSObject> |
moveToRecycleBin(DMSFolder f,
DMSObject o)
Moves the object o which resides in folder f to the Recycle Bin.
|
<P extends DMSDocForm> |
reloadDocument(DMSFolder folder,
P document,
java.lang.String newExtension,
java.io.InputStream is)
Reloads the document, i.e. replaces the content of the document with the content of the
passed file
|
<P extends DMSDocForm> |
reloadDocument(DMSFolder folder,
P document,
java.lang.String newExtension,
java.io.InputStream is,
long length,
byte[] digest)
Reloads the document, i.e. replaces the content of the document with the content of the
passed stream
|
<P extends DMSDocForm> |
reloadDocument(DMSFolder folder,
P document,
java.lang.String newExtension,
java.io.InputStream is,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
reloadDocument(DMSFolder, DMSDocForm, String, InputStream) instead. |
boolean |
remove(DMSFolder f,
DMSObject o)
Removes an Object from a folder.
|
void |
removeKeyword(DMSObject obj,
Keyword keyword)
Removes the passed keyword from the passed DMSObject
|
void |
removeKeyword(DMSObject obj,
Keyword keyword,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
removeKeyword(DMSObject, Keyword) instead. |
void |
removeNote(DMSObject target,
DMSNote note)
Removes the passed note from the passed document.
|
void |
removeNote(DMSObject target,
DMSNote note,
User user)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
removeNote(DMSObject, DMSNote) instead. |
void |
removeSubform(DMSForm main,
DMSForm sub)
Removes the passed subform from the passed mainform.
|
void |
removeSubform(DMSForm main,
DMSForm sub,
int id)
Removes the passed subform from the subform-relation identified by the passed id in the passed mainform.
|
<P extends DMSObject> |
renameDocument(DMSFolder folder,
P obj,
java.lang.String newName,
java.lang.String newExtension)
Sets the name and extension of the passed object to newName.
|
<P extends DMSObject> |
renameDocument(DMSFolder folder,
P obj,
java.lang.String newName,
java.lang.String newExtension,
User u)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
renameDocument(DMSFolder, DMSObject, String, String) instead. |
java.util.List<DMSObject> |
restoreFromRecycleBin(DMSObject o)
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)
Set the content of a document.
|
void |
setContent(DMSDocForm document,
java.io.InputStream is)
Set the content of a document.
|
void |
setContent(DMSDocForm document,
java.io.InputStream is,
long length,
byte[] digest)
Set the content of a document.
|
void |
setContent(User user,
DMSDocForm document,
byte[] barr)
Deprecated.
since ep 9.0 and will be removed in ep 10.0.
Use
setContent(DMSDocForm, byte[]) instead. |
void |
signDocuments(java.util.List<? extends DMSDocForm> documents,
Agent agent,
char[] password)
Digital Signing of a list of DMS documents.
|
void |
signDocuments(java.util.List<? extends DMSDocForm> documents,
java.lang.String alias,
char[] password)
Deprecated.
|
void |
signVersions(java.util.List<? extends PersistentVersion> versions,
Agent agent,
char[] password)
Digital Signing of a list of DMS document version.
|
void |
signVersions(java.util.List<? extends PersistentVersion> versions,
java.lang.String alias,
char[] password)
Deprecated.
|
void |
unlock(DMSDocForm document)
Unlocks the document.
|
void |
update(DMSObject o)
Updates the passed object
|
@Deprecated <P extends DMSFolder> P createFolder(FormType ft, java.lang.String name, P template, User u, PermissionList acl)
createFolder(FormType, String, DMSFolder, PermissionList)
instead.ft
- the folder's formtypename
- the name for the foldertemplate
- specifies the template which shuld be used for creating the folder (may be null)u
- the user who wants to create the folderacl
- the acl attached to the new folder (may be null)<P extends DMSFolder> P createFolder(java.lang.String name)
createFolder
in interface RemoteDMS
name
- the name for the folder<P extends DMSFolder> P createFolder(FormType ft, java.lang.String name, P template, PermissionList acl)
createFolder
in interface RemoteDMS
ft
- the folder's formtypename
- the name for the foldertemplate
- 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)@Deprecated <P extends DMSDocForm> P createDocForm(FormType ft, java.lang.String name, java.lang.String extension, P template, User u, PermissionList acl)
createDocForm(FormType, String, String, DMSDocForm, PermissionList)
instead.ft
- the document's formtypename
- the name of the new DocFormextension
- 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)<P extends DMSDocForm> P createDocForm(java.lang.String name, java.lang.String extension)
createDocForm
in interface RemoteDMS
name
- the name of the new DocFormextension
- the file extension of the new document<P extends DMSDocForm> P createDocForm(FormType ft, java.lang.String name, java.lang.String extension, P template, PermissionList acl)
createDocForm
in interface RemoteDMS
ft
- the document's formtypename
- the name of the new DocFormextension
- 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)@Deprecated <P extends DMSForm> P createForm(FormType ft, P template, User u, PermissionList acl)
createForm(FormType, DMSForm, PermissionList)
instead.ft
- the form's formtypetemplate
- specifies the template which should be used for creating the folder (may be null)u
- the user who wants to perform this actionacl
- the acl if one should be set (otherwise pass null)<P extends DMSForm> P createForm(FormType ft, P template, PermissionList acl)
createForm
in interface RemoteDMS
ft
- the form's formtypetemplate
- 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)@Deprecated <P extends DMSNote> P createNote(java.lang.String subject, java.lang.String content, User u, PermissionList acl)
createNote(String, String, PermissionList)
instead.subject
- the subject of the notecontent
- the content of the noteu
- the user who wants to perform this actionacl
- the acl if one should be set (otherwise pass null)<P extends DMSNote> P createNote(java.lang.String subject, java.lang.String content, PermissionList acl)
createNote
in interface RemoteDMS
subject
- the subject of the notecontent
- the content of the noteacl
- the acl if one should be set (otherwise pass null)@Deprecated <P extends DMSWebLink> P createWebLink(java.lang.String name, java.lang.String url, java.lang.String description, User u, PermissionList acl)
createWebLink(String, String, String, PermissionList)
instead.name
- the name of the weblinkurl
- the url of the weblinkdescription
- a description text of the the weblinku
- the user who wants to perform this actionacl
- the acl if one should be set (otherwise pass null)<P extends DMSWebLink> P createWebLink(java.lang.String name, java.lang.String url, java.lang.String description, PermissionList acl)
createWebLink
in interface RemoteDMS
name
- the name of the weblinkurl
- the url of the weblinkdescription
- a description text of the the weblinkacl
- the acl if one should be set (otherwise pass null)FormType getFormType(java.lang.String id, int version)
getFormType
in interface RemoteDMS
@Deprecated FormType getFormType(long oid)
getFormType
in interface RemoteDMS
<P extends DMSForm> java.util.List<P> getTemplates(FormType ft)
getTemplates
in interface RemoteDMS
ft
- the form type of which the templates are wanted@Deprecated java.util.List<FormType> listCreateableFormTypes(java.lang.String searchCond, java.lang.String order, User user)
listCreateableFormTypes(String, String)
instead.searchCond
- a sql where-clauseorder
- sql order attributesuser
- the user for which the search should be performedjava.util.List<FormType> listCreateableFormTypes(java.lang.String searchCond, java.lang.String order)
listCreateableFormTypes
in interface RemoteDMS
searchCond
- a sql where-clauseorder
- sql order attributes@Deprecated <P extends DMSObject> P move(DMSFolder src, DMSFolder dest, P doc, short type, User u)
move(DMSFolder, DMSFolder, DMSObject, short)
instead.src
- the folder currently holding the objectdest
- the folder to which the objects should be moveddoc
- the object which should be movedtype
- the type of move operation:
RemoteDMS.MOVE
: the object should be moved (i.e. removed from src and added to dest)
RemoteDMS.COPY
: the object should be copied (i.e. stays in src and a copy is
added to dest)
RemoteDMS.LINK
: the object should be linked (i.e. stays in src and a link to the
object is added to dest)
u
- the user who wants to perform this action<P extends DMSObject> P move(DMSFolder src, DMSFolder dest, P doc, short type)
move
in interface RemoteDMS
src
- the folder currently holding the objectdest
- the folder to which the objects should be moveddoc
- the object which should be movedtype
- the type of move operation:
RemoteDMS.MOVE
: the object should be moved (i.e. removed from src and added to dest)
RemoteDMS.COPY
: the object should be copied (i.e. stays in src and a copy is
added to dest)
RemoteDMS.LINK
: the object should be linked (i.e. stays in src and a link to the
object is added to dest)
@Deprecated <P extends DMSObject> P add(DMSFolder f, P o, User u)
add(DMSFolder, DMSObject)
instead.f
- the folder to which the object should be addedo
- the object which should be added to the folderu
- the user who wants to perform this action<P extends DMSObject> P add(DMSFolder f, P o)
boolean remove(DMSFolder f, DMSObject o)
@Deprecated void delete(DMSFolder f, DMSObject o, User u)
delete(DMSFolder, DMSObject)
instead.f
- the folder holding the object which should be deletedo
- the object which should be deletedu
- the user who wants to perform this actionjava.util.List<DMSObject> delete(DMSFolder f, DMSObject o)
@Deprecated void attachNote(DMSObject target, DMSNote note, User user)
attachNote(DMSObject, DMSNote)
instead.target
- the object to which the note should be attachednote
- the note which should be attacheduser
- the user who wants to perform this actionvoid attachNote(DMSObject target, DMSNote note)
attachNote
in interface RemoteDMS
target
- the object to which the note should be attachednote
- the note which should be attached@Deprecated void removeNote(DMSObject target, DMSNote note, User user)
removeNote(DMSObject, DMSNote)
instead.target
- the object form which the note should be removednote
- the note which should be removeduser
- the user who wants to perform this actionvoid removeNote(DMSObject target, DMSNote note)
removeNote
in interface RemoteDMS
target
- the object form which the note should be removednote
- the note which should be removed@Deprecated java.util.List<DMSNote> listNotes(DMSObject target, User user)
listNotes(DMSObject)
instead.target
- the object which notes are wanteduser
- the user who wants to perform this actionjava.util.List<DMSNote> listNotes(DMSObject target)
java.util.List<DMSNote> listNotes(DMSObject target, boolean includeSystemNodes)
@Deprecated PersistentVersion makeVersion(DMSObject obj, User user, java.lang.String description)
makeVersion(DMSObject, String)
instead.obj
- the object which should be versioneduser
- the user who wants to make the versiondescription
- the version description textPersistentVersion makeVersion(DMSObject obj, java.lang.String description)
makeVersion
in interface RemoteDMS
obj
- the object which should be versioneddescription
- the version description text@Deprecated void deleteVersion(PersistentVersion version, User user)
deleteVersion(PersistentVersion)
instead.version
- the version to be deleteduser
- the user who wants to delete the versionvoid deleteVersion(PersistentVersion version)
deleteVersion
in interface RemoteDMS
version
- the version to be deleted@Deprecated java.util.List<PersistentVersion> listVersions(DMSObject obj, User user)
listVersions(DMSObject)
instead.obj
- the object which versions are requesteduser
- the user who performs this requestjava.util.List<PersistentVersion> listVersions(DMSObject obj)
listVersions
in interface RemoteDMS
obj
- the object which versions are requestedjava.util.List<PersistentVersion> listVersions(DMSObject obj, java.lang.String condition, java.lang.String order, java.lang.Object[] bindVars)
listVersions
in interface RemoteDMS
obj
- the object which versions are requestedcondition
- 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
- if the condition contains place holders for binding variables this array should contain the values@Deprecated void backupToVersion(DMSForm form, PersistentVersion version, User user)
backupToVersion(DMSForm, PersistentVersion)
instead.form
- the object which should be reset to the passed the versionversion
- the version which content should be used (it must be a version of the passed
form)user
- the user who performs this requestvoid backupToVersion(DMSForm form, PersistentVersion version)
backupToVersion
in interface RemoteDMS
form
- the object which should be reset to the passed the versionversion
- the version which content should be used (it must be a version of the passed
form)<P extends DMSFolder> P getRootFolder(User user)
getRootFolder
in interface RemoteDMS
user
- the user who's root folder is requested.<P extends DMSFolder> P getPublicRootFolder()
getPublicRootFolder
in interface RemoteDMS
<P extends DMSFolder> P getRecycleBin(User user)
RemoteDMS
getRecycleBin
in interface RemoteDMS
user
- the user who's recycle bin is requested.@Deprecated <P extends DMSObject> P getDMSObject(java.lang.String classname, long oid)
getDMSObject
in interface RemoteDMS
classname
- the full qualified class name of the requested objectoid
- the oid of the requested object<P extends DMSObject> P getDMSObject(long oid)
getDMSObject
in interface RemoteDMS
oid
- the oid of the requested object<P extends DMSObject> P getDMSObject(java.lang.String path)
getDMSObject
in interface RemoteDMS
path
- the path leading to the wanted DMSObject<P extends DMSFolder> P getFolder(DMSObject obj)
<P extends DMSFolder> java.util.List<P> listSubfolders(DMSFolder startFolder)
listSubfolders
in interface RemoteDMS
startFolder
- the folder which subfolders are requested<P extends DMSForm> P getMainForm(DMSForm f)
getMainForm
in interface RemoteDMS
f
- the form for which the mainform is needed<P extends DMSForm> java.util.List<P> listSubforms(DMSForm f, int id)
listSubforms
in interface RemoteDMS
f
- the form of which the subforms are neededid
- the id of the wanted subforms<P extends DMSForm> java.util.List<P> listSubforms(DMSForm f, int id, java.lang.String cond, java.lang.String order, java.lang.Object[] vals)
listSubforms
in interface RemoteDMS
f
- the form of which the subforms are neededid
- the id of the wanted subformscond
- 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 ordervals
- the value objects for the condition if the condition is build with the syntax
of a prepared statementint countSubforms(DMSForm f, int id)
f
is
the main form.countSubforms
in interface RemoteDMS
f
- the form of which the subforms will be countedid
- the id of the subform relationvoid removeSubform(DMSForm main, DMSForm sub)
removeSubform
in interface RemoteDMS
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 removevoid removeSubform(DMSForm main, DMSForm sub, int id)
removeSubform
in interface RemoteDMS
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 removeid
- the id of the subform-relation from which the subform should be removedvoid addSubform(DMSForm main, DMSForm sub, int id)
addSubform
in interface RemoteDMS
main
- the mainformsub
- the subform to addid
- the id of the set of subform to which the passed subform should be addedMultiMap<DMSForm,DMSForm> fetchSubForms(java.util.Collection<? extends DMSForm> mainForms, int subformid)
fetchSubForms
in interface RemoteDMS
mainForms
- the referencing mainformssubformid
- the id of the subform (tablefield) to getjava.util.Map<DMSForm,DMSForm> fetchMainForms(java.util.Collection<? extends DMSForm> subForms)
fetchMainForms
in interface RemoteDMS
subForms
- the referencing subforms@Deprecated <P extends DMSForm> java.util.List<P> listForms(FormType ft, java.lang.String cond, java.lang.String order, java.lang.Object[] vals)
<P extends DMSObject> java.util.List<P> listContents(DMSFolder folder, FormType ft, java.lang.String cond, java.lang.String order, java.lang.Object[] vals, boolean recursive)
listContents
in interface RemoteDMS
folder
- the folder whose content is wantedft
- the formtype of the desired objectscond
- the condition which must match. The following columns are available for parameter
cond and order:
order
- the sorting order (for available columns see parameter cond)vals
- the value objects for the condition if the condition is build with the syntax
of a prepared statementrecursive
- determines if the search should also include all subfolders@Deprecated <P extends DMSObject> P renameDocument(DMSFolder folder, P obj, java.lang.String newName, java.lang.String newExtension, User u)
renameDocument(DMSFolder, DMSObject, String, String)
instead.folder
- the folder the document belongs toobj
- the object which should be renamednewName
- the new name for the documentnewExtension
- the new extension for the document. This parameter is ignored if the passed
object is not a DMSDocForm
.u
- the user who wants to perform the renaming<P extends DMSObject> P renameDocument(DMSFolder folder, P obj, java.lang.String newName, java.lang.String newExtension)
renameDocument
in interface RemoteDMS
folder
- the folder the document belongs toobj
- the object which should be renamednewName
- the new name for the documentnewExtension
- the new extension for the document. This parameter is ignored if the passed
object is not a DMSDocForm
.@Deprecated <P extends DMSDocForm> P reloadDocument(DMSFolder folder, P document, java.lang.String newExtension, java.io.InputStream is, User user)
reloadDocument(DMSFolder, DMSDocForm, String, InputStream)
instead.folder
- the folder the document belongs todocument
- the document which should be reloadednewExtension
- the possibly new extension (if null or the empty string is passed the old
extension remains unchanged).is
- the inputstream holding the new contentuser
- the user who wants to perfom this action<P extends DMSDocForm> P reloadDocument(DMSFolder folder, P document, java.lang.String newExtension, java.io.InputStream is)
reloadDocument
in interface RemoteDMS
folder
- the folder the document belongs todocument
- the document which should be reloadednewExtension
- the possibly new extension (if null or the empty string is passed the old
extension remains unchanged).is
- the inputstream holding the new content<P extends DMSDocForm> P reloadDocument(DMSFolder folder, P document, java.lang.String newExtension, java.io.InputStream is, long length, byte[] digest)
folder
- the folder the document belongs todocument
- the document which should be reloadednewExtension
- the possibly new extension (if null or the empty string is passed the old
extension remains unchanged).is
- the InputStream
holding the new contentlength
- the length of the new content in bytesdigest
- the message digest of the new content@Deprecated void setContent(User user, DMSDocForm document, byte[] barr)
setContent(DMSDocForm, byte[])
instead.user
- the user who performs this actiondocument
- the documentbarr
- a byte arrayvoid setContent(DMSDocForm document, byte[] barr)
setContent
in interface RemoteDMS
document
- the documentbarr
- a byte arrayvoid setContent(DMSDocForm document, java.io.InputStream is)
setContent(DMSDocForm, byte[])
which is more performant than this method.document
- the document which content should be setis
- an InputStream
to the content of the documentvoid setContent(DMSDocForm document, java.io.InputStream is, long length, byte[] digest)
document
- the document which content should be setis
- an InputStream
to the content of the documentlength
- the length of the new content in bytesdigest
- the message digest of the new contentbyte[] getContent(DMSDocForm document)
getContent
in interface RemoteDMS
document
- the documentjava.io.InputStream getContentAsStream(DMSDocForm document)
document
- the documentbyte[] getContent(PersistentVersion version)
getContent
in interface RemoteDMS
version
- the versionjava.io.InputStream getContentAsStream(PersistentVersion version)
version
- the version@Deprecated void lock(DMSDocForm document, User user)
lock(DMSDocForm)
instead.document
- the documentuser
- the user who performs this actionvoid lock(DMSDocForm document)
void unlock(DMSDocForm document)
@Deprecated <P extends DMSForm> P changeType(DMSForm obj, FormType newType, DMSFolder folder, User user)
changeType(DMSForm, FormType, DMSFolder)
instead.obj
- the objects which type should be changednewType
- the new type for the passed objectfolder
- the folder of which the object is a content memberuser
- the user who performs the change<P extends DMSForm> P changeType(DMSForm obj, FormType newType, DMSFolder folder)
changeType
in interface RemoteDMS
obj
- the objects which type should be changednewType
- the new type for the passed objectfolder
- the folder of which the object is a content membervoid update(DMSObject o)
java.util.List<DMSObject> moveToRecycleBin(DMSFolder f, DMSObject o)
moveToRecycleBin
in interface RemoteDMS
f
- the folder holding the object which should be deletedo
- the object which should be deletedjava.util.List<DMSObject> restoreFromRecycleBin(DMSObject o)
restoreFromRecycleBin
in interface RemoteDMS
o
- the object to restorejava.util.List<DMSObject> emptyRecycleBin()
emptyRecycleBin
in interface RemoteDMS
@Deprecated Keyword createKeyword(java.lang.String word, User user)
createKeyword(String)
instead.word
- the string representing the wanted keyworduser
- the user who creates the keywordjava.rmi.RemoteException
Keyword createKeyword(java.lang.String word)
createKeyword
in interface RemoteDMS
word
- the string representing the wanted keyword@Deprecated void deleteKeyword(Keyword keyword, User user)
deleteKeyword
in interface RemoteDMS
keyword
- the keyword which should be deleteduser
- the user who creates the keyword@Deprecated Keyword getKeyword(long oid)
getKeyword
in interface RemoteDMS
oid
- the oid the wanted keyword@Deprecated <P extends Keyword> java.util.List<P> listKeywords()
listKeywords
in interface RemoteDMS
@Deprecated void addKeyword(DMSObject obj, Keyword keyword, User user)
addKeyword(DMSObject, Keyword)
instead.obj
- the object to which the keyword should be addedkeyword
- the keyword which should be addeduser
- the user who wants to perform this actionjava.rmi.RemoteException
void addKeyword(DMSObject obj, Keyword keyword)
addKeyword
in interface RemoteDMS
obj
- the object to which the keyword should be addedkeyword
- the keyword which should be added@Deprecated void removeKeyword(DMSObject obj, Keyword keyword, User user)
removeKeyword(DMSObject, Keyword)
instead.obj
- the object from which the keyword should be removedkeyword
- the keyword which should be removeduser
- the user who wants to perform this actionjava.rmi.RemoteException
void removeKeyword(DMSObject obj, Keyword keyword)
removeKeyword
in interface RemoteDMS
obj
- the object from which the keyword should be removedkeyword
- the keyword which should be removed<P extends Keyword> java.util.List<P> listKeywords(DMSObject obj)
listKeywords
in interface RemoteDMS
obj
- the object which the keywords should be returnedvoid disableRightChecks()
RemoteDMS.checkEdit(User, DMSObject)
, RemoteDMS.checkView(User, DMSObject)
,
RemoteDMS.mayEdit(User, DMSObject)
and RemoteDMS.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.disableRightChecks
in interface RemoteDMS
void enableRightChecks()
RemoteDMS.disableRightChecks()
.enableRightChecks
in interface RemoteDMS
void checkEdit(User user, DMSObject obj)
ApplicationException
Nr. 27 if the passed user may NOT edit the passed objectvoid checkView(User user, DMSObject obj)
ApplicationException
Nr. 27 if the passed user may NOT view the passed objectvoid checkDelete(User user, DMSObject obj)
ApplicationException
Nr. 27 if the passed user may NOT delete the passed objectcheckDelete
in interface RemoteDMS
user
- the user who wants to delete the objectobj
- the object which should be deletedboolean mayEdit(User user, DMSObject obj)
boolean mayView(User user, DMSObject obj)
boolean mayDelete(User user, DMSObject obj)
@Deprecated java.lang.String getIcon(java.lang.String extension)
@Deprecated java.lang.String getIconFromMimetype(java.lang.String mimetype)
getIconFromMimetype
in interface RemoteDMS
mimetype
- the mimetype for which the icon is wantedvoid checkValidName(DMSObject target, java.lang.String name, java.lang.String extension)
checkValidName
in interface RemoteDMS
target
- the object to which the name belongs to (or will belong to)name
- the name which should be checkedextension
- the extension which should be checkedvoid checkDuplicateNames(DMSFolder targetFolder, DMSObject targetObject, java.lang.String name, java.lang.String extension)
checkDuplicateNames
in interface RemoteDMS
targetFolder
- the folder in which should be checkedtargetObject
- the object the name belongs to (or will belong to)name
- the name which should be checkedextension
- the extension which should be checkedboolean isDuplicateName(DMSFolder targetFolder, DMSObject targetObject, java.lang.String name, java.lang.String extension)
isDuplicateName
in interface RemoteDMS
targetFolder
- the folder in which should be checkedtargetObject
- the object the name belongs to (or will belong to)name
- the name which should be checkedextension
- the extension which should be checked@Deprecated void signDocuments(java.util.List<? extends DMSDocForm> documents, java.lang.String alias, char[] password)
signDocuments
in interface RemoteDMS
alias
- the certificate alias used to sign the docuemntpassword
- the password of the private key used to sign document@Deprecated void signVersions(java.util.List<? extends PersistentVersion> versions, java.lang.String alias, char[] password)
signVersions
in interface RemoteDMS
alias
- the certificate alias used to sign the docuemntpassword
- the password of the private key used to sign documentvoid signDocuments(java.util.List<? extends DMSDocForm> documents, Agent agent, char[] password)
signDocuments
in interface RemoteDMS
agent
- the agent (role or user) which is signing the documentpassword
- the password of the private key used to sign documentvoid signVersions(java.util.List<? extends PersistentVersion> versions, Agent agent, char[] password)
signVersions
in interface RemoteDMS
agent
- the agent (role or user) which is signing the documentpassword
- the password of the private key used to sign document@enterprise 9.0.33982 Copyright © 2001-2023 Groiss Informatics GmbH. All Rights Reserved.