com.inubit.research.server.meta

Class ISMetaDataHandler

java.lang.Object

com.inubit.research.server.meta.ISMetaDataHandler

All Implemented Interfaces:

MetaDataHandler

public class ISMetaDataHandler
extends java.lang.Object
implements MetaDataHandler

Constructor Summary

Constructors

Constructor and Description
ISMetaDataHandler(java.net.URL serverURL, java.lang.String usr, ISLocation isManager)

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	getLastCheckinDate(java.lang.String 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) Mark a certain comment as resolved
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ISMetaDataHandler

public ISMetaDataHandler(java.net.URL serverURL,
                         java.lang.String usr,
                         ISLocation isManager)

Method Detail

getFolderAlias

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

Description copied from interface: MetaDataHandler

Get folder alias for given ID

Specified by:

getFolderAlias in interface MetaDataHandler

Parameters:

id - the ID

Returns:

the folder alias

getVersionComment

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

Description copied from interface: MetaDataHandler

Get commit message of given ID and version

Specified by:

getVersionComment in interface MetaDataHandler

Parameters:

id - the ID

version - the version

Returns:

the commit message

getLastCheckinDate

public java.lang.String getLastCheckinDate(java.lang.String id)

getVersionMetaData

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

Description copied from interface: MetaDataHandler

Get meta data object for the given ID and given

Specified by:

getVersionMetaData in interface MetaDataHandler

Parameters:

id - the ID

version - the version

Returns:

the meta data object

remove

public void remove(java.lang.String id)

Description copied from interface: MetaDataHandler

Remove the meta data objects for the given model

Specified by:

remove in interface MetaDataHandler

Parameters:

id - the model id

setFolderAlias

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

Description copied from interface: MetaDataHandler

Set folder alias for given ID

Specified by:

setFolderAlias in interface MetaDataHandler

Parameters:

id - the ID

alias - the folder alias

setVersionComment

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

Description copied from interface: MetaDataHandler

Set commit comment for the given ID and version

Specified by:

setVersionComment in interface MetaDataHandler

Parameters:

id - the ID

version - the version

comment - the commit message

addComment

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

Description copied from interface: MetaDataHandler

Add an element comment

Specified by:

addComment in interface MetaDataHandler

Parameters:

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

comment - the comment

getComments

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

Description copied from interface: MetaDataHandler

Get comments for a certain model element

Specified by:

getComments in interface MetaDataHandler

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

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

Description copied from interface: MetaDataHandler

Change a comment's text

Specified by:

updateComment in interface MetaDataHandler

Parameters:

modelId - the model id

commentId - the comment id

newText - the new comment text

resolveComment

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

Description copied from interface: MetaDataHandler

Mark a certain comment as resolved

Specified by:

resolveComment in interface MetaDataHandler

Parameters:

modelId - the model id

commentId - the comment id

version - the version in which it was resolved

removeComment

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

Description copied from interface: MetaDataHandler

Remove a certain comment

Specified by:

removeComment in interface MetaDataHandler

Parameters:

modeldId - the model id

commentId - the comment id

setVersionDate

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

Description copied from interface: MetaDataHandler

Set the creation date for the given ID and version

Specified by:

setVersionDate in interface MetaDataHandler

Parameters:

id - the ID

version - the version

date - the date

getVersionDate

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

Description copied from interface: MetaDataHandler

Get the creation date for a certain model version

Specified by:

getVersionDate in interface MetaDataHandler

Parameters:

id - the model ID

version - the model version

Returns:

the formatted date

setSucceedingVersions

public void setSucceedingVersions(java.lang.String id,
                                  java.lang.String version,
                                  java.util.Set<java.lang.String> versions)

Description copied from interface: MetaDataHandler

Set the succeeding versions for a certain model version

Specified by:

setSucceedingVersions in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

versions - the succeeding versions

getSucceedingVersions

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

Description copied from interface: MetaDataHandler

Get the succeeding versions for a certain model version

Specified by:

getSucceedingVersions in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

Returns:

the succeeding versions

setPreceedingVersions

public void setPreceedingVersions(java.lang.String id,
                                  java.lang.String version,
                                  java.util.Set<java.lang.String> versions)

Description copied from interface: MetaDataHandler

Set the preceeding versions for a certain model version

Specified by:

setPreceedingVersions in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

versions - the preceeding versions

getPreceedingVersions

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

Description copied from interface: MetaDataHandler

Get the preceeding versions for a certain model version

Specified by:

getPreceedingVersions in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

Returns:

the preceeding versions

setVersionUser

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

Description copied from interface: MetaDataHandler

Set the user that commited a certain model version

Specified by:

setVersionUser in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

user - the commiting user

getVersionUser

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

Description copied from interface: MetaDataHandler

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

Specified by:

getVersionUser in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

Returns:

the user name

getAccessability

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

Description copied from interface: MetaDataHandler

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

Specified by:

getAccessability in interface MetaDataHandler

Parameters:

id - the model id

version - the model version

user - the user

Returns:

the maximum access of the given user for this model

getOwner

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

Description copied from interface: MetaDataHandler

Get a model's owner

Specified by:

getOwner in interface MetaDataHandler

Parameters:

id - the model id

Returns:

the owner's name

getViewers

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

Description copied from interface: MetaDataHandler

Get all users that are allowed to view this model

Specified by:

getViewers in interface MetaDataHandler

Parameters:

id - the model id

Returns:

the set of users

getEditors

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

Description copied from interface: MetaDataHandler

Get all users that are allowed to edit this model

Specified by:

getEditors in interface MetaDataHandler

Parameters:

id - the model id

Returns:

the set of users

getAnnotators

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

Description copied from interface: MetaDataHandler

Get all users that are allowed to comment on this model

Specified by:

getAnnotators in interface MetaDataHandler

Parameters:

id - the model id

Returns:

the set of users

setOwner

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

Description copied from interface: MetaDataHandler

Set a model's owner

Specified by:

setOwner in interface MetaDataHandler

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

grantRight

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

Description copied from interface: MetaDataHandler

Grant a specific right to a number of users

Specified by:

grantRight in interface MetaDataHandler

Parameters:

id - the model's ID

at - the kind of access that is granted

users - the users that will receive the right

divestRight

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

Description copied from interface: MetaDataHandler

Deny a specific right for a number of users

Specified by:

divestRight in interface MetaDataHandler

Parameters:

id - the model's ID

at - the kind of access that is denied

users - the users that lose this right