edu.northwestern.at.wordhoard.swing.calculator.modelutils
Class UserGroupPermissionUtils

java.lang.Object
  extended by edu.northwestern.at.wordhoard.swing.calculator.modelutils.UserGroupPermissionUtils

public class UserGroupPermissionUtils
extends java.lang.Object

Work set utilities.


Constructor Summary
protected UserGroupPermissionUtils()
          Don't allow instantiation but do allow overrides.
 
Method Summary
static void addReadPermission(AuthoredTextAnnotation annotation, UserGroup userGroup)
          Add read permission for group to indicated item.
static UserGroupPermission createUserGroupPermission(UserGroupPermission userGroupPermission)
          Create a new UserGroupPermission.
static void deletePermission(AuthoredTextAnnotation annotation, UserGroup userGroup)
          delete permission for group on indicated item.
static boolean deleteUserGroupPermission(UserGroupPermission userGroupPermission)
          Delete a UserGroupPermission.
static java.util.Map getPermissionsForItem(AuthoredTextAnnotation annotation)
          Get all usergroups associated with a specific annotation.
static void setPermission(AuthoredTextAnnotation annotation, UserGroup userGroup, java.lang.String permission)
          set permission for group on indicated item.
static boolean updateUserGroupPermission(UserGroupPermission userGroupPermission, java.lang.String permission)
          Update UserGroupPermission.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupPermissionUtils

protected UserGroupPermissionUtils()
Don't allow instantiation but do allow overrides.

Method Detail

createUserGroupPermission

public static UserGroupPermission createUserGroupPermission(UserGroupPermission userGroupPermission)
                                                     throws BadOwnerException
Create a new UserGroupPermission.

Parameters:
userGroupPermission - The user group permission.
Returns:
UserGroupPermission object if created, else null.
Throws:
BadOwnerException - if the owner is null or empty.

updateUserGroupPermission

public static boolean updateUserGroupPermission(UserGroupPermission userGroupPermission,
                                                java.lang.String permission)
                                         throws BadOwnerException
Update UserGroupPermission.

Returns:
UserGroupPermission object
Throws:
BadOwnerException - if the owner is null or empty or not admin.

deleteUserGroupPermission

public static boolean deleteUserGroupPermission(UserGroupPermission userGroupPermission)
Delete a UserGroupPermission.

Parameters:
userGroupPermission - The UserGroupPermission to delete.
Returns:
true if work set deleted, false otherwise.

The currently logged in user must be the owner to delete an UserGroupPermission.


getPermissionsForItem

public static java.util.Map getPermissionsForItem(AuthoredTextAnnotation annotation)
Get all usergroups associated with a specific annotation.

Parameters:
annotation - The annotation.
Returns:
All available user groups for the annotation.

addReadPermission

public static void addReadPermission(AuthoredTextAnnotation annotation,
                                     UserGroup userGroup)
Add read permission for group to indicated item.

Parameters:
annotation - The AuthoredTextAnnotation made readable
userGroup - The UserGroup allowed to read the item

setPermission

public static void setPermission(AuthoredTextAnnotation annotation,
                                 UserGroup userGroup,
                                 java.lang.String permission)
set permission for group on indicated item.

Parameters:
annotation - The AuthoredTextAnnotation
userGroup - The UserGroup allowed given permission
permission - The permission

deletePermission

public static void deletePermission(AuthoredTextAnnotation annotation,
                                    UserGroup userGroup)
delete permission for group on indicated item.

Parameters:
annotation - The AuthoredTextAnnotation
userGroup - The UserGroup allowed given permission