| com.ivata.groupware.business.library.right.LibraryRights
All known Subclasses: com.ivata.groupware.business.library.right.LibraryRightsImpl,
| LibraryRights | | public interface LibraryRights (Code) | |
TODO: add a comment for this type.
author:
Colin MacLeod
author:
colin.macleod@ivata.com
since:
Jun 19, 2004
version:
$Revision: 1.4 $ |
| Method Summary | |
| abstract public void | amendAddRightsForItem(SecuritySession securitySession, Integer id, Collection rights)
This method changes ADD rights. | | abstract public void | amendAmendRightsForItem(SecuritySession securitySession, Integer id, Collection rights)
This method changing AMEND rights. | | abstract public void | amendAmendRightsForTopic(SecuritySession securitySession, Integer id, Collection rights)
This method changing AMEND rights of TOPIC. | | abstract public void | amendRemoveRightsForItem(SecuritySession securitySession, Integer id, Collection rights)
This method changing REMOVE rights. | | abstract public void | amendRemoveRightsForTopic(SecuritySession securitySession, Integer id, Collection rights)
This method changing REMOVE rights of TOPIC. | | abstract public void | amendViewRightsForItem(SecuritySession securitySession, Integer id, Collection rights)
This method changing VIEW rights of ITEMS. | | abstract public void | amendViewRightsForTopic(SecuritySession securitySession, Integer id, Collection rights)
This method changing VIEW rights of TOPIC. | | abstract public boolean | canAddComment(SecuritySession securitySession, CommentDO comment)
Find out if a user is allowed to add a new comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. | | abstract public boolean | canAddToTopic(SecuritySession securitySession, Integer topicId)
Find out if a user is allowed to add items to a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public boolean | canAddTopic(SecuritySession securitySession)
Find out if a user is allowed to add a new topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public boolean | canAmendComment(SecuritySession securitySession, CommentDO comment)
Find out if a user is allowed to change an existing comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. | | abstract public boolean | canAmendInTopic(SecuritySession securitySession, Integer integerParam)
Find out if a user is allowed to amend items in a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
integerParam - the unique identifier of the topic to check. | | abstract public boolean | canAmendTopic(SecuritySession securitySession, Integer id)
Find out if a user is allowed to amend an existing new topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public boolean | canRemoveComment(SecuritySession securitySession, CommentDO comment)
Find out if a user is allowed to remove an existing comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. | | abstract public boolean | canRemoveFromTopic(SecuritySession securitySession, Integer topicId)
Find out if a user is allowed to remove items from a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public boolean | canRemoveTopic(SecuritySession securitySession, Integer id)
Find out if a user is allowed to remove a topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public boolean | canUser(SecuritySession securitySession, Integer topicId, Integer detail, Integer access)
Internal helper method. | | abstract public boolean | canViewInTopic(SecuritySession securitySession, Integer topicId)
Find out if a user is allowed to view items to a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. | | abstract public Collection | findRightsForItemsInTopic(SecuritySession securitySession, Integer id, Integer access)
Find groups which have access to items with topic. | | abstract public Collection | findRightsForTopic(SecuritySession securitySession, Integer id, Integer access)
Find groups which have access to topic. | | abstract public Collection | findTopicsByGroupAccess(SecuritySession securitySession, Integer groupId, Integer access)
Find the unique identifiers of all library topics for which the items
can be accessed by the group specified, with the access level given.
Parameters:
groupId - unique identifier of the group for which to search forlibrary topics.
Parameters:
access - the access level as defined in com.ivata.groupware.business.addressbook.person.group.right.RightConstantsRightConstants. |
| amendAddRightsForItem | | abstract public void amendAddRightsForItem(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | |
This method changes ADD rights. Users in the specified groups will be
able to add ITEMS with this TOPIC.
It's works only with those groups which can be seen by the user.
if I am adding ADD right for a group and the user has not VIEW right
-> also create a VIEW right for that group.
Parameters:
id - of TOPIC
Parameters:
userName - user vhich is goin to change rights
Parameters:
rights - collection of groups for which we will set up ADD right |
| amendAmendRightsForItem | | abstract public void amendAmendRightsForItem(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing AMEND rights. Users in those groups will be able to amend ITEMS with this TOPIC.
It's working only with those groups which can be see by user.
if I am adding AMEND right for group and there is not VIEW right -> so create VIEW right for that group.
Parameters:
id - of TOPIC
Parameters:
userName - user vhich is goin to change rights
Parameters:
rights - collection of groups for which we will set up AMEND right |
| amendAmendRightsForTopic | | abstract public void amendAmendRightsForTopic(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing AMEND rights of TOPIC. It's working only with those groups which can be see by user.
if I am adding AMEND right for group and there is not VIEW right -> so create VIEW right for that group.
Parameters:
id - of TOPIC
Parameters:
userName - user which is chaning
Parameters:
rights - collection of groups for which we will set up AMEND right |
| amendRemoveRightsForItem | | abstract public void amendRemoveRightsForItem(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing REMOVE rights. Users in those groups will be able to remove ITEMS with this TOPIC.
It's working only with those groups which can be see by user.
if I am adding REMOVE right for group and there is not VIEW right -> so create VIEW right for that group.
Parameters:
id - of TOPIC
Parameters:
userName - user vhich is goin to change rights
Parameters:
rights - collection of groups for which we will set up REMOVE right |
| amendRemoveRightsForTopic | | abstract public void amendRemoveRightsForTopic(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing REMOVE rights of TOPIC. It's working only with those groups which can be see by user.
if I am adding REMOVE right for group and there is not VIEW right -> so create VIEW right for that group.
Parameters:
id - of TOPIC
Parameters:
userName - user vhich is going to change
Parameters:
rights - collection of groups for which we will set up REMOVE right |
| amendViewRightsForItem | | abstract public void amendViewRightsForItem(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing VIEW rights of ITEMS. Users in those groups will be albe to see ITEMS with this TOPIC.
It's working only with those groups which can be see by user.
Parameters:
id - of TOPIC
Parameters:
userName - user vhich is goin to change rights
Parameters:
rights - collection of groups for which we will set up VIEW right |
| amendViewRightsForTopic | | abstract public void amendViewRightsForTopic(SecuritySession securitySession, Integer id, Collection rights) throws SystemException(Code) | | This method changing VIEW rights of TOPIC. It's working only with those groups which can be see by user.
Parameters:
id - of TOPIC
Parameters:
userName - user which is changing
Parameters:
rights - collection of groupIds for which we will set up VIEW right |
| canAddComment | | abstract public boolean canAddComment(SecuritySession securitySession, CommentDO comment) throws SystemException(Code) | | Find out if a user is allowed to add a new comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. true if the user is entitled to add this comment,otherwise false. |
| canAddToTopic | | abstract public boolean canAddToTopic(SecuritySession securitySession, Integer topicId) throws SystemException(Code) | | Find out if a user is allowed to add items to a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to add items to thetopic, otherwise false. |
| canAddTopic | | abstract public boolean canAddTopic(SecuritySession securitySession) throws SystemException(Code) | | Find out if a user is allowed to add a new topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to add new topics,otherwise false. |
| canAmendComment | | abstract public boolean canAmendComment(SecuritySession securitySession, CommentDO comment) throws SystemException(Code) | | Find out if a user is allowed to change an existing comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. true if the user is entitled to change this comment,otherwise false. |
| canAmendInTopic | | abstract public boolean canAmendInTopic(SecuritySession securitySession, Integer integerParam) throws SystemException(Code) | | Find out if a user is allowed to amend items in a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
integerParam - the unique identifier of the topic to check. true if the user is entitled to amend items in thetopic, otherwise false. |
| canAmendTopic | | abstract public boolean canAmendTopic(SecuritySession securitySession, Integer id) throws SystemException(Code) | | Find out if a user is allowed to amend an existing new topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to amend thetopic, otherwise false. |
| canRemoveComment | | abstract public boolean canRemoveComment(SecuritySession securitySession, CommentDO comment) throws SystemException(Code) | | Find out if a user is allowed to remove an existing comment.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
comment - the comment check. true if the user is entitled to remove this comment,otherwise false. |
| canRemoveFromTopic | | abstract public boolean canRemoveFromTopic(SecuritySession securitySession, Integer topicId) throws SystemException(Code) | | Find out if a user is allowed to remove items from a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to remove items fromthe topic, otherwise false. |
| canRemoveTopic | | abstract public boolean canRemoveTopic(SecuritySession securitySession, Integer id) throws SystemException(Code) | | Find out if a user is allowed to remove a topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to remove thetopic, otherwise false. |
| canUser | | abstract public boolean canUser(SecuritySession securitySession, Integer topicId, Integer detail, Integer access) throws SystemException(Code) | | Internal helper method. Find out if a user is allowed to access
entries in a given group.
Parameters:
securitySession - Security session to check the rights for.
Parameters:
topicId - Unique identifier of the topic to check.
Parameters:
access - The access level as defined in com.ivata.groupware.business.addressbook.person.group.right.RightConstantsRightConstants. true if the user is entitled to access entries in thetopic, otherwise false. |
| canViewInTopic | | abstract public boolean canViewInTopic(SecuritySession securitySession, Integer topicId) throws SystemException(Code) | | Find out if a user is allowed to view items to a given topic.
Parameters:
userName - the name of the user to check the user rights for.
Parameters:
topicId - the unique identifier of the topic to check. true if the user is entitled to view items in thetopic, otherwise false. |
| findRightsForItemsInTopic | | abstract public Collection findRightsForItemsInTopic(SecuritySession securitySession, Integer id, Integer access) throws SystemException(Code) | | Find groups which have access to items with topic.
Return only those groups which can be see by that user.
Parameters:
id - of TOPIC
Parameters:
userName - user which is trying to find rights
Parameters:
access - find rights with this access Collection of IDS of groups which have access to that items wuth that topic |
| findRightsForTopic | | abstract public Collection findRightsForTopic(SecuritySession securitySession, Integer id, Integer access) throws SystemException(Code) | | Find groups which have access to topic.
Return only those groups which can be see by that user.
Parameters:
id - of TOPIC
Parameters:
userName - user which is trying to find rights
Parameters:
access - find rights with this access Collection of IDS of groups which have access to that topic |
| findTopicsByGroupAccess | | abstract public Collection findTopicsByGroupAccess(SecuritySession securitySession, Integer groupId, Integer access) throws SystemException(Code) | | Find the unique identifiers of all library topics for which the items
can be accessed by the group specified, with the access level given.
Parameters:
groupId - unique identifier of the group for which to search forlibrary topics.
Parameters:
access - the access level as defined in com.ivata.groupware.business.addressbook.person.group.right.RightConstantsRightConstants. a Collection of Integer instances,matching all topics which can be access with this level of accessby the group specified. |
|
|