public class AnnouncementEntityProviderImpl
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
| Modifier and Type | Class and Description |
|---|---|
class |
AnnouncementEntityProviderImpl.DecoratedAnnouncement
Class to hold only the fields that we want to return
|
class |
AnnouncementEntityProviderImpl.DecoratedAttachment
Model class for an attachment
|
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_DAYS_IN_PAST |
static int |
DEFAULT_NUM_ANNOUNCEMENTS |
static String |
ENTITY_PREFIX |
developerHelperServiceACTION_METHOD_SUFFIXALL_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| Constructor and Description |
|---|
AnnouncementEntityProviderImpl() |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAnnouncementByID(org.sakaiproject.entitybroker.EntityView view,
Map<String,Object> params)
message/siteId/EntityID
|
List<?> |
getAnnouncementsForSite(org.sakaiproject.entitybroker.EntityView view,
Map<String,Object> params)
site/siteId
|
List<?> |
getAnnouncementsForUser(org.sakaiproject.entitybroker.EntityView view,
Map<String,Object> params)
user
|
Object |
getEntity(org.sakaiproject.entitybroker.EntityReference ref) |
String |
getEntityPrefix()
Prefix for this provider
|
String[] |
getHandledOutputFormats() |
List<?> |
getMessagesOfTheDay(org.sakaiproject.entitybroker.EntityView view,
Map<String,Object> params)
motd
|
Object |
getSampleEntity() |
AnnouncementEntityProviderImpl.DecoratedAnnouncement |
showAnnouncement(org.sakaiproject.entitybroker.EntityView view,
Map<String,Object> params)
This handles announcements, URLs should be like, /announcement/msg/{context}/{channelId}/{announcementId}
an example would be /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b .
|
public static final String ENTITY_PREFIX
public static int DEFAULT_NUM_ANNOUNCEMENTS
public static int DEFAULT_DAYS_IN_PAST
public String getEntityPrefix()
getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderpublic List<?> getAnnouncementsForSite(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
public List<?> getAnnouncementsForUser(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
public List<?> getMessagesOfTheDay(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
public AnnouncementEntityProviderImpl.DecoratedAnnouncement showAnnouncement(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params) throws org.sakaiproject.entity.api.EntityPermissionException
org.sakaiproject.entity.api.EntityPermissionExceptionpublic Object getAnnouncementByID(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
public Object getSampleEntity()
getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleablepublic String[] getHandledOutputFormats()
getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputablepublic Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)
getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.ResolvableCopyright © 2003-2014 The Sakai Foundation. All Rights Reserved.