org.sakaiproject.rights.impl

Class BaseRightsService

java.lang.Object

org.sakaiproject.rights.impl.BaseRightsService

All Implemented Interfaces:

org.sakaiproject.rights.api.RightsService

Direct Known Subclasses:

BasicRightsService

public abstract class BaseRightsService
extends Object
implements org.sakaiproject.rights.api.RightsService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRightsService.BasicCopyright
static class	BaseRightsService.BasicCreativeCommonsLicense
static class	BaseRightsService.BasicRightsAssignment Init and Destroy
static interface	BaseRightsService.Storage

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseRightsService.Storage	m_storage

Constructor Summary

Constructors

Constructor and Description
BaseRightsService()

Method Summary

Methods

Modifier and Type	Method and Description
org.sakaiproject.rights.api.RightsAssignment	addRightsAssignment(String entityRef)
org.sakaiproject.rights.api.SiteRightsPolicy	addSiteRightsPolicy(String context)
org.sakaiproject.rights.api.UserRightsPolicy	addUserRightsPolicy(String context, String userId)
void	destroy() Returns to uninitialized state.
org.sakaiproject.rights.api.RightsAssignment	getRightsAssignment(String entityRef)
org.sakaiproject.rights.api.SiteRightsPolicy	getSiteRightsPolicy(String context)
org.sakaiproject.rights.api.UserRightsPolicy	getUserRightsPolicy(String context, String userId)
void	init() Final initialization, once all dependencies are set.
protected abstract BaseRightsService.Storage	newStorage() Construct a Storage object.
void	save(org.sakaiproject.rights.api.RightsAssignment rights)
void	save(org.sakaiproject.rights.api.RightsPolicy policy)
void	setRightsAssignment(String entityRef, org.sakaiproject.rights.api.RightsAssignment rights)

Methods inherited from class java.lang.Object

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

Field Detail

m_storage

protected BaseRightsService.Storage m_storage

Constructor Detail

BaseRightsService

public BaseRightsService()

Method Detail

addRightsAssignment

public org.sakaiproject.rights.api.RightsAssignment addRightsAssignment(String entityRef)

Specified by:

addRightsAssignment in interface org.sakaiproject.rights.api.RightsService

Parameters:

entityRef -

Returns:

addSiteRightsPolicy

public org.sakaiproject.rights.api.SiteRightsPolicy addSiteRightsPolicy(String context)

Specified by:

addSiteRightsPolicy in interface org.sakaiproject.rights.api.RightsService

addUserRightsPolicy

public org.sakaiproject.rights.api.UserRightsPolicy addUserRightsPolicy(String context,
                                                               String userId)

Specified by:

addUserRightsPolicy in interface org.sakaiproject.rights.api.RightsService

destroy

public void destroy()

Returns to uninitialized state.

getRightsAssignment

public org.sakaiproject.rights.api.RightsAssignment getRightsAssignment(String entityRef)
                                                                 throws org.sakaiproject.exception.IdUnusedException

Specified by:

getRightsAssignment in interface org.sakaiproject.rights.api.RightsService

Throws:

org.sakaiproject.exception.IdUnusedException

getSiteRightsPolicy

public org.sakaiproject.rights.api.SiteRightsPolicy getSiteRightsPolicy(String context)

Specified by:

getSiteRightsPolicy in interface org.sakaiproject.rights.api.RightsService

getUserRightsPolicy

public org.sakaiproject.rights.api.UserRightsPolicy getUserRightsPolicy(String context,
                                                               String userId)

Specified by:

getUserRightsPolicy in interface org.sakaiproject.rights.api.RightsService

init

public void init()

Final initialization, once all dependencies are set.

newStorage

protected abstract BaseRightsService.Storage newStorage()

Construct a Storage object.

Returns:

The new storage object.

save

public void save(org.sakaiproject.rights.api.RightsAssignment rights)

Specified by:

save in interface org.sakaiproject.rights.api.RightsService

Parameters:

rights -

save

public void save(org.sakaiproject.rights.api.RightsPolicy policy)

Specified by:

save in interface org.sakaiproject.rights.api.RightsService

setRightsAssignment

public void setRightsAssignment(String entityRef,
                       org.sakaiproject.rights.api.RightsAssignment rights)

Specified by:

setRightsAssignment in interface org.sakaiproject.rights.api.RightsService