public class DirectoryMetaDataHandler extends java.lang.Object implements MetaDataHandler
Constructor and Description |
---|
DirectoryMetaDataHandler(java.io.File dir) |
Modifier and Type | Method and Description |
---|---|
void |
addComment(java.lang.String id,
ProcessObjectComment comment)
Add an element comment
|
void |
divestRight(java.lang.String id,
AccessType at,
java.util.Set<User> users)
Deny a specific right for a number of users
|
AccessType |
getAccessability(java.lang.String id,
int version,
LoginableUser user)
Determine the access for a given user to a certain model and version
|
java.util.Set<User> |
getAnnotators(java.lang.String id)
Get all users that are allowed to comment on this model
|
java.util.Set<ProcessObjectComment> |
getComments(java.lang.String modelId,
java.lang.String version,
java.lang.String elementId)
Get comments for a certain model element
|
DirectoryConfig |
getConfig() |
java.util.Set<User> |
getEditors(java.lang.String id)
Get all users that are allowed to edit this model
|
java.lang.String |
getFolderAlias(java.lang.String id)
Get folder alias for given ID
|
java.lang.String |
getOwner(java.lang.String id)
Get a model's owner
|
java.util.Set<java.lang.String> |
getPreceedingVersions(java.lang.String id,
java.lang.String version)
Get the preceeding versions for a certain model version
|
java.util.Set<java.lang.String> |
getSucceedingVersions(java.lang.String id,
java.lang.String version)
Get the succeeding versions for a certain model version
|
java.lang.String |
getVersionComment(java.lang.String id,
java.lang.String version)
Get commit message of given ID and version
|
java.lang.String |
getVersionDate(java.lang.String id,
java.lang.String version)
Get the creation date for a certain model version
|
VersionMetaData |
getVersionMetaData(java.lang.String id,
java.lang.String version)
Get meta data object for the given ID and given
|
java.lang.String |
getVersionUser(java.lang.String id,
java.lang.String version)
Get the user's name who commited a certain model version
|
java.util.Set<User> |
getViewers(java.lang.String id)
Get all users that are allowed to view this model
|
void |
grantRight(java.lang.String id,
AccessType at,
java.util.Set<User> users)
Grant a specific right to a number of users
|
void |
remove(java.lang.String id)
Remove the meta data objects for the given model
|
void |
removeComment(java.lang.String id,
java.lang.String commentId)
Remove a certain comment
|
void |
resolveComment(java.lang.String id,
java.lang.String commentId,
java.lang.String version)
Deprecated.
|
void |
setFolderAlias(java.lang.String id,
java.lang.String alias,
SingleUser user)
Set folder alias for given ID
|
boolean |
setOwner(java.lang.String id,
SingleUser owner,
SingleUser admin)
Set a model's owner
|
void |
setPreceedingVersions(java.lang.String id,
java.lang.String version,
java.util.Set<java.lang.String> versions)
Set the preceeding versions for a certain model version
|
void |
setSucceedingVersions(java.lang.String id,
java.lang.String version,
java.util.Set<java.lang.String> versions)
Set the succeeding versions for a certain model version
|
void |
setVersionComment(java.lang.String id,
java.lang.String version,
java.lang.String comment)
Set commit comment for the given ID and version
|
void |
setVersionDate(java.lang.String id,
java.lang.String version,
java.util.Date date)
Set the creation date for the given ID and version
|
void |
setVersionUser(java.lang.String id,
java.lang.String version,
java.lang.String user)
Set the user that commited a certain model version
|
ProcessObjectComment |
updateComment(java.lang.String id,
java.lang.String commentId,
java.lang.String newText,
int validUntil)
Change a comment's text
|
public void setVersionComment(java.lang.String id, java.lang.String version, java.lang.String comment)
MetaDataHandler
setVersionComment
in interface MetaDataHandler
id
- the IDversion
- the versioncomment
- the commit messagepublic java.lang.String getVersionComment(java.lang.String id, java.lang.String version)
MetaDataHandler
getVersionComment
in interface MetaDataHandler
id
- the IDversion
- the versionpublic void setVersionUser(java.lang.String id, java.lang.String version, java.lang.String user)
MetaDataHandler
setVersionUser
in interface MetaDataHandler
id
- the model idversion
- the model versionuser
- the commiting userpublic java.lang.String getVersionUser(java.lang.String id, java.lang.String version)
MetaDataHandler
getVersionUser
in interface MetaDataHandler
id
- the model idversion
- the model versionpublic void setSucceedingVersions(java.lang.String id, java.lang.String version, java.util.Set<java.lang.String> versions)
MetaDataHandler
setSucceedingVersions
in interface MetaDataHandler
id
- the model idversion
- the model versionversions
- the succeeding versionspublic java.util.Set<java.lang.String> getSucceedingVersions(java.lang.String id, java.lang.String version)
MetaDataHandler
getSucceedingVersions
in interface MetaDataHandler
id
- the model idversion
- the model versionpublic void setPreceedingVersions(java.lang.String id, java.lang.String version, java.util.Set<java.lang.String> versions)
MetaDataHandler
setPreceedingVersions
in interface MetaDataHandler
id
- the model idversion
- the model versionversions
- the preceeding versionspublic java.util.Set<java.lang.String> getPreceedingVersions(java.lang.String id, java.lang.String version)
MetaDataHandler
getPreceedingVersions
in interface MetaDataHandler
id
- the model idversion
- the model versionpublic void setFolderAlias(java.lang.String id, java.lang.String alias, SingleUser user)
MetaDataHandler
setFolderAlias
in interface MetaDataHandler
id
- the IDalias
- the folder aliaspublic java.lang.String getFolderAlias(java.lang.String id)
MetaDataHandler
getFolderAlias
in interface MetaDataHandler
id
- the IDpublic VersionMetaData getVersionMetaData(java.lang.String id, java.lang.String version)
MetaDataHandler
getVersionMetaData
in interface MetaDataHandler
id
- the IDversion
- the versionpublic void remove(java.lang.String id)
MetaDataHandler
remove
in interface MetaDataHandler
id
- the model idpublic java.util.Set<ProcessObjectComment> getComments(java.lang.String modelId, java.lang.String version, java.lang.String elementId)
MetaDataHandler
getComments
in interface MetaDataHandler
modelId
- the model idversion
- the model versionelementId
- an element id or 'model' if model comments are requestedpublic DirectoryConfig getConfig()
public AccessType getAccessability(java.lang.String id, int version, LoginableUser user)
MetaDataHandler
getAccessability
in interface MetaDataHandler
id
- the model idversion
- the model versionuser
- the userpublic java.lang.String getOwner(java.lang.String id)
MetaDataHandler
getOwner
in interface MetaDataHandler
id
- the model idpublic java.util.Set<User> getViewers(java.lang.String id)
MetaDataHandler
getViewers
in interface MetaDataHandler
id
- the model idpublic java.util.Set<User> getAnnotators(java.lang.String id)
MetaDataHandler
getAnnotators
in interface MetaDataHandler
id
- the model idpublic java.util.Set<User> getEditors(java.lang.String id)
MetaDataHandler
getEditors
in interface MetaDataHandler
id
- the model idpublic boolean setOwner(java.lang.String id, SingleUser owner, SingleUser admin)
MetaDataHandler
setOwner
in interface MetaDataHandler
id
- the model idowner
- the new owneradmin
- the user that is allowed to set the ownerpublic void grantRight(java.lang.String id, AccessType at, java.util.Set<User> users)
MetaDataHandler
grantRight
in interface MetaDataHandler
id
- the model's IDat
- the kind of access that is grantedusers
- the users that will receive the rightpublic void divestRight(java.lang.String id, AccessType at, java.util.Set<User> users)
MetaDataHandler
divestRight
in interface MetaDataHandler
id
- the model's IDat
- the kind of access that is deniedusers
- the users that lose this rightpublic void addComment(java.lang.String id, ProcessObjectComment comment)
MetaDataHandler
addComment
in interface MetaDataHandler
id
- the model's id to which the annotated element belongscomment
- the commentpublic ProcessObjectComment updateComment(java.lang.String id, java.lang.String commentId, java.lang.String newText, int validUntil)
MetaDataHandler
updateComment
in interface MetaDataHandler
id
- the model idcommentId
- the comment idnewText
- the new comment text@Deprecated public void resolveComment(java.lang.String id, java.lang.String commentId, java.lang.String version)
MetaDataHandler
resolveComment
in interface MetaDataHandler
id
- the model idcommentId
- the comment idversion
- the version in which it was resolvedpublic void removeComment(java.lang.String id, java.lang.String commentId)
MetaDataHandler
removeComment
in interface MetaDataHandler
id
- the model idcommentId
- the comment idpublic void setVersionDate(java.lang.String id, java.lang.String version, java.util.Date date)
MetaDataHandler
setVersionDate
in interface MetaDataHandler
id
- the IDversion
- the versiondate
- the datepublic java.lang.String getVersionDate(java.lang.String id, java.lang.String version)
MetaDataHandler
getVersionDate
in interface MetaDataHandler
id
- the model IDversion
- the model version