org.sakaiproject.delegatedaccess.entity

Class DelegatedAccessEntityProviderImpl

java.lang.Object

org.sakaiproject.delegatedaccess.entity.DelegatedAccessEntityProviderImpl

All Implemented Interfaces:

org.sakaiproject.delegatedaccess.entity.DelegatedAccessEntityProvider, org.sakaiproject.entitybroker.collector.AutoRegister, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Createable, org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable, org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Propertyable, org.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.capabilities.Saveable, org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable, org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.Formats, org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider

public class DelegatedAccessEntityProviderImpl
extends Object
implements org.sakaiproject.delegatedaccess.entity.DelegatedAccessEntityProvider, org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable, org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware

This is the RESTful service for the Shopping Period Admin. This allows an instructor to update their own shopping period information through site-manage

Author:

Bryan Holladay (holladay@longsight.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DelegatedAccessEntityProviderImpl.GenericOutputSerialized

Field Summary

Fields inherited from interface org.sakaiproject.delegatedaccess.entity.DelegatedAccessEntityProvider

ENTITY_PREFIX

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DelegatedAccessEntityProviderImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<?>	canEditShopping(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
String	createEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)
void	deleteEntity(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
boolean	entityExists(String id)
List<String>	findEntityRefs(String[] prefixes, String[] name, String[] searchValue, boolean exactMatch)
List<?>	getEntities(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search)
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix()
String[]	getHandledInputFormats()
String[]	getHandledOutputFormats()
Map<String,String>	getProperties(String reference)
String	getPropertyValue(String reference, String name)
Object	getSampleEntity()
List<?>	getShoppingOptions(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) shoppingOptions/roles shoppingOptions/tools
List	getUsersWithAccessToSite(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
List	initializeAccessForSite(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
void	setPropertyValue(String reference, String name, String value)
void	setRequestGetter(org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter requestGetter)
void	setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)
void	updateEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatedAccessEntityProviderImpl

public DelegatedAccessEntityProviderImpl()

Method Detail

getEntityPrefix

public String getEntityPrefix()

Specified by:

getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

entityExists

public boolean entityExists(String id)

Specified by:

entityExists in interface org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider

getPropertyValue

public String getPropertyValue(String reference,
                      String name)

Specified by:

getPropertyValue in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider

getProperties

public Map<String,String> getProperties(String reference)

Specified by:

getProperties in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider

setPropertyValue

public void setPropertyValue(String reference,
                    String name,
                    String value)

Specified by:

setPropertyValue in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider

findEntityRefs

public List<String> findEntityRefs(String[] prefixes,
                          String[] name,
                          String[] searchValue,
                          boolean exactMatch)

Specified by:

findEntityRefs in interface org.sakaiproject.entitybroker.entityprovider.extension.PropertiesProvider

createEntity

public String createEntity(org.sakaiproject.entitybroker.EntityReference ref,
                  Object entity,
                  Map<String,Object> params)

Specified by:

createEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Createable

getSampleEntity

public Object getSampleEntity()

Specified by:

getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

updateEntity

public void updateEntity(org.sakaiproject.entitybroker.EntityReference ref,
                Object entity,
                Map<String,Object> params)

Specified by:

updateEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

getEntity

public Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)

Specified by:

getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

canEditShopping

public List<?> canEditShopping(org.sakaiproject.entitybroker.EntityView view,
                      Map<String,Object> params)

getShoppingOptions

public List<?> getShoppingOptions(org.sakaiproject.entitybroker.EntityView view,
                         Map<String,Object> params)

shoppingOptions/roles shoppingOptions/tools

Parameters:

view -

params -

Returns:

initializeAccessForSite

public List initializeAccessForSite(org.sakaiproject.entitybroker.EntityView view,
                           Map<String,Object> params)

getUsersWithAccessToSite

public List getUsersWithAccessToSite(org.sakaiproject.entitybroker.EntityView view,
                            Map<String,Object> params)

deleteEntity

public void deleteEntity(org.sakaiproject.entitybroker.EntityReference ref,
                Map<String,Object> params)

Specified by:

deleteEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable

getEntities

public List<?> getEntities(org.sakaiproject.entitybroker.EntityReference ref,
                  org.sakaiproject.entitybroker.entityprovider.search.Search search)

Specified by:

getEntities in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

getHandledInputFormats

public String[] getHandledInputFormats()

Specified by:

getHandledInputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable

setRequestGetter

public void setRequestGetter(org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter requestGetter)

Specified by:

setRequestGetter in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware

setRequestStorage

public void setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)

Specified by:

setRequestStorage in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable