com.inubit.research.server.meta

Interface MetaDataHandler

All Known Implementing Classes:

DatabaseMetaDataHandler, DirectoryMetaDataHandler, ISMetaDataHandler

public interface MetaDataHandler

Interface for all meta data handlers

Method Summary

Modifier and Type	Method and Description
void	addComment(java.lang.String modelId, 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
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 modeldId, java.lang.String commentId) Remove a certain comment
void	resolveComment(java.lang.String modelId, 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 modelId, java.lang.String commentId, java.lang.String newText, int validUntil) Change a comment's text

Method Detail

setVersionComment

void setVersionComment(java.lang.String id,
                       java.lang.String version,
                       java.lang.String comment)

Set commit comment for the given ID and version

Parameters:

id - the ID

version - the version

comment - the commit message

getVersionComment

java.lang.String getVersionComment(java.lang.String id,
                                   java.lang.String version)

Get commit message of given ID and version

Parameters:

id - the ID

version - the version

Returns:

the commit message

setFolderAlias

void setFolderAlias(java.lang.String id,
                    java.lang.String alias,
                    SingleUser user)

Set folder alias for given ID

Parameters:

id - the ID

alias - the folder alias

getFolderAlias

java.lang.String getFolderAlias(java.lang.String id)

Get folder alias for given ID

Parameters:

id - the ID

Returns:

the folder alias

setVersionUser

void setVersionUser(java.lang.String id,
                    java.lang.String version,
                    java.lang.String user)

Set the user that commited a certain model version

Parameters:

id - the model id

version - the model version

user - the commiting user

getVersionUser

java.lang.String getVersionUser(java.lang.String id,
                                java.lang.String version)

Get the user's name who commited a certain model version

Parameters:

id - the model id

version - the model version

Returns:

the user name

addComment

void addComment(java.lang.String modelId,
                ProcessObjectComment comment)

Add an element comment

Parameters:

modelId - the model's id to which the annotated element belongs

comment - the comment

getComments

java.util.Set<ProcessObjectComment> getComments(java.lang.String modelId,
                                                java.lang.String version,
                                                java.lang.String elementId)

Get comments for a certain model element

Parameters:

modelId - the model id

version - the model version

elementId - an element id or 'model' if model comments are requested

Returns:

the set of comments

updateComment

ProcessObjectComment updateComment(java.lang.String modelId,
                                   java.lang.String commentId,
                                   java.lang.String newText,
                                   int validUntil)

Change a comment's text

Parameters:

modelId - the model id

commentId - the comment id

newText - the new comment text

resolveComment

@Deprecated
void resolveComment(java.lang.String modelId,
                                java.lang.String commentId,
                                java.lang.String version)

Deprecated.

Mark a certain comment as resolved

Parameters:

modelId - the model id

commentId - the comment id

version - the version in which it was resolved

removeComment

void removeComment(java.lang.String modeldId,
                   java.lang.String commentId)

Remove a certain comment

Parameters:

modeldId - the model id

commentId - the comment id

setVersionDate

void setVersionDate(java.lang.String id,
                    java.lang.String version,
                    java.util.Date date)

Set the creation date for the given ID and version

Parameters:

id - the ID

version - the version

date - the date

getVersionDate

java.lang.String getVersionDate(java.lang.String id,
                                java.lang.String version)

Get the creation date for a certain model version

Parameters:

id - the model ID

version - the model version

Returns:

the formatted date

setSucceedingVersions

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

Parameters:

id - the model id

version - the model version

versions - the succeeding versions

getSucceedingVersions

java.util.Set<java.lang.String> getSucceedingVersions(java.lang.String id,
                                                      java.lang.String version)

Get the succeeding versions for a certain model version

Parameters:

id - the model id

version - the model version

Returns:

the succeeding versions

setPreceedingVersions

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

Parameters:

id - the model id

version - the model version

versions - the preceeding versions

getPreceedingVersions

java.util.Set<java.lang.String> getPreceedingVersions(java.lang.String id,
                                                      java.lang.String version)

Get the preceeding versions for a certain model version

Parameters:

id - the model id

version - the model version

Returns:

the preceeding versions

getVersionMetaData

VersionMetaData getVersionMetaData(java.lang.String id,
                                   java.lang.String version)

Get meta data object for the given ID and given

Parameters:

id - the ID

version - the version

Returns:

the meta data object

remove

void remove(java.lang.String id)

Remove the meta data objects for the given model

Parameters:

id - the model id

getAccessability

AccessType getAccessability(java.lang.String id,
                            int version,
                            LoginableUser user)

Determine the access for a given user to a certain model and version

Parameters:

id - the model id

version - the model version

user - the user

Returns:

the maximum access of the given user for this model

getOwner

java.lang.String getOwner(java.lang.String id)

Get a model's owner

Parameters:

id - the model id

Returns:

the owner's name

setOwner

boolean setOwner(java.lang.String id,
                 SingleUser owner,
                 SingleUser admin)

Set a model's owner

Parameters:

id - the model id

owner - the new owner

admin - the user that is allowed to set the owner

Returns:

• true, if setting owner was successful
• false, otherwise

getViewers

java.util.Set<User> getViewers(java.lang.String id)

Get all users that are allowed to view this model

Parameters:

id - the model id

Returns:

the set of users

getEditors

java.util.Set<User> getEditors(java.lang.String id)

Get all users that are allowed to edit this model

Parameters:

id - the model id

Returns:

the set of users

getAnnotators

java.util.Set<User> getAnnotators(java.lang.String id)

Get all users that are allowed to comment on this model

Parameters:

id - the model id

Returns:

the set of users

grantRight

void grantRight(java.lang.String id,
                AccessType at,
                java.util.Set<User> users)

Grant a specific right to a number of users

Parameters:

id - the model's ID

at - the kind of access that is granted

users - the users that will receive the right

divestRight

void divestRight(java.lang.String id,
                 AccessType at,
                 java.util.Set<User> users)

Deny a specific right for a number of users

Parameters:

id - the model's ID

at - the kind of access that is denied

users - the users that lose this right