org.sakaiproject.signup.tool.entityproviders

Class MySignupEventsProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.signup.tool.entityproviders.MySignupEventsProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, 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.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable, 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.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class MySignupEventsProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable, org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable

Handles the signupEvent entity

Author:

Peter Liu

Field Summary

Fields

Modifier and Type	Field and Description
protected EventProcessHandler	eventProcessHandler
static String	PREFIX
protected org.sakaiproject.signup.logic.SakaiFacade	sakaiFacade
protected org.sakaiproject.signup.logic.SignupMeetingService	signupMeetingService

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

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
MySignupEventsProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	createEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params) Note that details is the only optional field
org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap[]	defineURLMappings()
void	deleteEntity(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
boolean	entityExists(String id)
List<?>	getEntities(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search) Example for accessing multiple events's Json objects URL: http://localhost:8080/direct/mySignup/user/50c08b39-0232-4072-b5fc-7c5bc2e3e965.json?
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix()
EventProcessHandler	getEventProcessHandler()
String[]	getHandledInputFormats()
String[]	getHandledOutputFormats()
org.sakaiproject.signup.logic.SakaiFacade	getSakaiFacade()
Object	getSampleEntity()
org.sakaiproject.signup.logic.SignupMeetingService	getSignupMeetingService()
void	setEventProcessHandler(EventProcessHandler eventProcessHandler)
void	setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)
void	setSakaiFacade(org.sakaiproject.signup.logic.SakaiFacade sakaiFacade)
void	setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService)
void	updateEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

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

Field Detail

sakaiFacade

protected org.sakaiproject.signup.logic.SakaiFacade sakaiFacade

signupMeetingService

protected org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService

eventProcessHandler

protected EventProcessHandler eventProcessHandler

PREFIX

public static String PREFIX

Constructor Detail

MySignupEventsProvider

public MySignupEventsProvider()

Method Detail

getEntityPrefix

public String getEntityPrefix()

Specified by:

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

defineURLMappings

public org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap[] defineURLMappings()

Specified by:

defineURLMappings in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable

entityExists

public boolean entityExists(String id)

Specified by:

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

createEntity

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

Note that details is the only optional field

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

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)

Example for accessing multiple events's Json objects URL: http://localhost:8080/direct/mySignup/user/50c08b39-0232-4072-b5fc-7c5bc2e3e965.json?viewNextDays=30&rnd=32421 where '50c08b39-0232-4072-b5fc-7c5bc2e3e965' is userId and 'rnd' is any random numbers Important Note: the userId is only used when you log in as admin. Otherwise it is not used and you can use any random number for this userId in url instead.

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

setRequestStorage

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

Specified by:

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

getSakaiFacade

public org.sakaiproject.signup.logic.SakaiFacade getSakaiFacade()

setSakaiFacade

public void setSakaiFacade(org.sakaiproject.signup.logic.SakaiFacade sakaiFacade)

getSignupMeetingService

public org.sakaiproject.signup.logic.SignupMeetingService getSignupMeetingService()

setSignupMeetingService

public void setSignupMeetingService(org.sakaiproject.signup.logic.SignupMeetingService signupMeetingService)

getEventProcessHandler

public EventProcessHandler getEventProcessHandler()

setEventProcessHandler

public void setEventProcessHandler(EventProcessHandler eventProcessHandler)