org.sakaiproject.delegatedaccess.entity

Class DelegatedAccessEntityProviderImpl

java.lang.Object

org.sakaiproject.delegatedaccess.entity.DelegatedAccessEntityProviderImpl

All Implemented Interfaces:

DelegatedAccessEntityProvider, AutoRegister, ActionsExecutable, AutoRegisterEntityProvider, CollectionResolvable, Createable, CRUDable, Deleteable, Describeable, Inputable, Outputable, Propertyable, PropertyProvideable, Redirectable, RequestAware, RequestStorable, Resolvable, RESTful, Sampleable, Saveable, Updateable, CoreEntityProvider, EntityProvider, Formats, PropertiesProvider

public class DelegatedAccessEntityProviderImpl
extends Object
implements DelegatedAccessEntityProvider, CoreEntityProvider, AutoRegisterEntityProvider, PropertyProvideable, RequestStorable, RESTful, 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

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

entityExists

public boolean entityExists(String id)

Specified by:

entityExists in interface CoreEntityProvider

getPropertyValue

public String getPropertyValue(String reference,
                               String name)

Specified by:

getPropertyValue in interface PropertiesProvider

getProperties

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

Specified by:

getProperties in interface PropertiesProvider

setPropertyValue

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

Specified by:

setPropertyValue in interface PropertiesProvider

findEntityRefs

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

Specified by:

findEntityRefs in interface PropertiesProvider

createEntity

public String createEntity(EntityReference ref,
                           Object entity,
                           Map<String,Object> params)

Specified by:

createEntity in interface Createable

getSampleEntity

public Object getSampleEntity()

Specified by:

getSampleEntity in interface Sampleable

updateEntity

public void updateEntity(EntityReference ref,
                         Object entity,
                         Map<String,Object> params)

Specified by:

updateEntity in interface Updateable

getEntity

public Object getEntity(EntityReference ref)

Specified by:

getEntity in interface Resolvable

canEditShopping

public List<?> canEditShopping(EntityView view,
                               Map<String,Object> params)

getShoppingOptions

public List<?> getShoppingOptions(EntityView view,
                                  Map<String,Object> params)

shoppingOptions/roles shoppingOptions/tools

Parameters:

view -

params -

Returns:

initializeAccessForSite

public List initializeAccessForSite(EntityView view,
                                    Map<String,Object> params)

getUsersWithAccessToSite

public List getUsersWithAccessToSite(EntityView view,
                                     Map<String,Object> params)

deleteEntity

public void deleteEntity(EntityReference ref,
                         Map<String,Object> params)

Specified by:

deleteEntity in interface Deleteable

getEntities

public List<?> getEntities(EntityReference ref,
                           Search search)

Specified by:

getEntities in interface CollectionResolvable

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface Outputable

getHandledInputFormats

public String[] getHandledInputFormats()

Specified by:

getHandledInputFormats in interface Inputable

setRequestGetter

public void setRequestGetter(RequestGetter requestGetter)

Specified by:

setRequestGetter in interface RequestAware

setRequestStorage

public void setRequestStorage(RequestStorage requestStorage)

Specified by:

setRequestStorage in interface RequestStorable