uk.ac.cam.caret.sakai.rwiki.tool.bean

Class PermissionsBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.PermissionsBean

public class PermissionsBean
extends Object

A Bean that has various helper methods to check whether certain things can be done to a RWikiObject

Author:

andrew

Constructor Summary

Constructors

Constructor and Description
PermissionsBean()
PermissionsBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject, uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService) Creates a fully set-up PermissionsBean

Method Summary

Methods

Modifier and Type	Method and Description
uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService	getObjectService() The currently set RWikiObjectService
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject	getRwikiObject() The current RWikiObject.
boolean	isAdminAllowed() Using the current objectService checks whether admin functions can be performed on the current RWikiObject by the currentUser.
boolean	isReadAllowed() Using the current objectService checks whether the current RWikiObject can be read by the currentUser.
boolean	isUpdateAllowed() Using the current objectService checks whether update can be performed on the current RWikiObject by the currentUser.
void	setObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService) Sets the current RWikiObjectService
void	setRwikiObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject) Sets the current RWikiObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionsBean

public PermissionsBean()

PermissionsBean

public PermissionsBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject,
               uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService)

Creates a fully set-up PermissionsBean

Parameters:

rwikiObject -

currentUser -

objectService -

Method Detail

getObjectService

public uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService getObjectService()

The currently set RWikiObjectService

Returns:

objectService

setObjectService

public void setObjectService(uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService objectService)

Sets the current RWikiObjectService

Parameters:

objectService -

getRwikiObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject getRwikiObject()

The current RWikiObject.

Returns:

rwikiObject.

setRwikiObject

public void setRwikiObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject)

Sets the current RWikiObject.

Parameters:

rwikiObject. -

isAdminAllowed

public boolean isAdminAllowed()

Using the current objectService checks whether admin functions can be performed on the current RWikiObject by the currentUser.

Returns:

true if the currentUser has admin rights on this rwikiObject.

isUpdateAllowed

public boolean isUpdateAllowed()

Using the current objectService checks whether update can be performed on the current RWikiObject by the currentUser.

Returns:

true if the currentUser has update rights on this rwikiObject

isReadAllowed

public boolean isReadAllowed()

Using the current objectService checks whether the current RWikiObject can be read by the currentUser.

Returns:

true if the currentUser has read rights on this rwikiObject.