public class AnnouncementService extends Object
AnnouncementService is a static Cover for the AnnouncementService
; see that interface for usage details.
Constructor and Description |
---|
AnnouncementService()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AnnouncementChannelEdit |
addAnnouncementChannel(String param0)
Deprecated.
A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
|
static MessageChannelEdit |
addChannel(String param0)
Deprecated.
Add a new channel.
|
static boolean |
allowAddChannel(String param0)
Deprecated.
check permissions for addChannel().
|
static boolean |
allowEditChannel(String param0)
Deprecated.
check permissions for editChannel()
|
static boolean |
allowGetChannel(String param0)
Deprecated.
check permissions for getChannel().
|
static boolean |
allowRemoveChannel(String param0)
Deprecated.
Check permissions for removeChannel().
|
static String |
archive(String param0,
Document param1,
Stack param2,
String param3,
List param4)
Deprecated.
|
static void |
cancelChannel(MessageChannelEdit param0)
Deprecated.
Cancel the changes made to a MessageChannelEdit object, and release the lock.
|
static void |
cancelMessage(MessageEdit param0)
Deprecated.
Cancel the changes made to a MessageEdit object, and release the lock.
|
static String |
channelReference(String param0,
String param1)
Deprecated.
Access the internal reference which can be used to access the channel from within the system.
|
static void |
clearMessagesCache(String channelRef)
Deprecated.
clears the message cache for this channel
|
static void |
commitChannel(MessageChannelEdit param0)
Deprecated.
Commit the changes made to a MessageChannelEdit object, and release the lock.
|
static MessageChannelEdit |
editChannel(String param0)
Deprecated.
Return a specific channel, as specified by channel id, locked for update.
|
static AnnouncementChannel |
getAnnouncementChannel(String param0)
Deprecated.
A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.
|
static Reference |
getAnnouncementReference(String param0)
Deprecated.
Get announcement entity reference for given context
|
static MessageChannel |
getChannel(String param0)
Deprecated.
Return a specific channel.
|
static List |
getChannelIds(String param0)
Deprecated.
Access a list of channel ids that are defined related to the context.
|
static List |
getChannels()
Deprecated.
Return a list of all the defined channels.
|
static AnnouncementService |
getInstance()
Deprecated.
Access the component instance: special cover only method.
|
static String |
getLabel()
Deprecated.
|
static Message |
getMessage(Reference param0)
Deprecated.
Get a message, given a reference.
|
static List |
getMessages(String channelReference,
Filter filter,
boolean order,
boolean merged)
Deprecated.
Return a list of messages from the provided channel (merged flag returns merged messages)
|
static List |
getMessages(String param0,
Time param1,
int param2,
boolean param3,
boolean param4,
boolean param5)
Deprecated.
Access a list of messages in the channel, that are after the date, limited to just the n latest messages, ordered as specified, including drafts if specified.
|
static String |
getRssUrl(Reference param0)
Deprecated.
Get URL to access the announcement rss feed
|
static Map |
getSummary(String param0,
int param1,
int param2)
Deprecated.
Get a summary of an Announcement Channel
|
static boolean |
isMessageViewable(AnnouncementMessage param0)
Deprecated.
Determine if message viewable based on release/retract dates (if set)
|
static String |
merge(String param0,
Element param1,
String param2,
String param3,
Map param4,
HashMap param5,
Set param6)
Deprecated.
|
static String |
messageReference(String param0,
String param1)
Deprecated.
Access the internal reference which can be used to access the message from within the system.
|
static String |
messageReference(String param0,
String param1,
String param2)
Deprecated.
Access the internal reference which can be used to access the message from within the system.
|
static void |
removeChannel(MessageChannelEdit param0)
Deprecated.
Remove a channel - it must be locked from editChannel().
|
public static final String MOD_DATE
public static final String RELEASE_DATE
public static final String RETRACT_DATE
public static final String ASSIGNMENT_REFERENCE
public static final String EVENT_ANNC_UPDATE_TITLE
public static final String EVENT_ANNC_UPDATE_ACCESS
public static final String EVENT_ANNC_UPDATE_AVAILABILITY
public static String APPLICATION_ID
public static String REFERENCE_ROOT
public static String SECURE_ANNC_ROOT
public static String SECURE_ANNC_READ
public static String SECURE_ANNC_ADD
public static String SECURE_ANNC_REMOVE_OWN
public static String SECURE_ANNC_REMOVE_ANY
public static String SECURE_ANNC_UPDATE_OWN
public static String SECURE_ANNC_UPDATE_ANY
public static String SECURE_ANNC_READ_DRAFT
public static String SECURE_READ
public static String SECURE_ADD
public static String SECURE_REMOVE_OWN
public static String SECURE_REMOVE_ANY
public static String SECURE_UPDATE_OWN
public static String SECURE_UPDATE_ANY
public static String SECURE_READ_DRAFT
public static String REF_TYPE_CHANNEL
public static String REF_TYPE_MESSAGE
public static AnnouncementService getInstance()
public static AnnouncementChannel getAnnouncementChannel(String param0) throws IdUnusedException, PermissionException
param0
- The channel reference string.IdUnusedException
- If this name is not defined for a announcement channel.PermissionException
- If the user does not have any permissions to the channel.public static AnnouncementChannelEdit addAnnouncementChannel(String param0) throws IdUsedException, IdInvalidException, PermissionException
param0
- The channel reference string.IdUsedException
- if the id is not unique.IdInvalidException
- if the id is not made up of valid characters.PermissionException
- if the user does not have permission to add a channel.public static List getChannels()
public static boolean allowGetChannel(String param0)
param0
- The channel reference string.public static boolean allowAddChannel(String param0)
param0
- The channel reference string.public static MessageChannelEdit addChannel(String param0) throws IdUsedException, IdInvalidException, PermissionException
The
- channel reference string.IdUsedException
- if the id is not unique.IdInvalidException
- if the id is not made up of valid characters.PermissionException
- if the user does not have permission to add a channel.public static boolean allowEditChannel(String param0)
param0
- The channel reference string.public static MessageChannelEdit editChannel(String param0) throws IdUnusedException, PermissionException, InUseException
param0
- The channel reference string.IdUnusedException
- If this name is not a defined channel.PermissionException
- If the user does not have any permissions to edit the channel.InUseException
- if the channel is locked for edit by someone else.public static void commitChannel(MessageChannelEdit param0)
param0
- The MessageChannelEdit object to commit.public static void cancelChannel(MessageChannelEdit param0)
param0
- The MessageChannelEdit object to cancel.public static boolean allowRemoveChannel(String param0)
param0
- The channel reference string.public static void removeChannel(MessageChannelEdit param0) throws PermissionException
param0
- The MessageChannelEdit object of the channel to remove.PermissionException
- if the user does not have permission to remove a channel.public static String channelReference(String param0, String param1)
param0
- The context string.param1
- The channel id.public static String messageReference(String param0, String param1, String param2)
param0
- The context string.param1
- The channel id.param2
- The message id.public static String messageReference(String param0, String param1)
param0
- The channel reference stringparam1
- The message id.public static void cancelMessage(MessageEdit param0)
param0
- The MessageEdit object to cancel.public static List getMessages(String param0, Time param1, int param2, boolean param3, boolean param4, boolean param5) throws PermissionException
param0
- channel reference stringparam1
- if null, no date limit, else limited to only messages after this date.param2
- if 0, no count limit, else limited to only the latest this number of messages.param3
- if true, sort oldest first, else sort latest first.param4
- if true, include drafts (if the user has draft permission), else leave them out.param5
- if true, include only messages marked pubview, else include any.PermissionException
- If the current user does not have channel read permission.public static List getChannelIds(String param0)
param0
- The context in which to searchpublic static Message getMessage(Reference param0) throws IdUnusedException, PermissionException
param0
- The message referenceIdUnusedException
- If this reference does not identify a message.PermissionException
- If the user does not have any permissions to the message.public static MessageChannel getChannel(String param0) throws IdUnusedException, PermissionException
param0
- The channel reference.IdUnusedException
- If this name is not defined for any channel.PermissionException
- If the user does not have any permissions to the channel.public static String merge(String param0, Element param1, String param2, String param3, Map param4, HashMap param5, Set param6)
public static String getLabel()
public static String archive(String param0, Document param1, Stack param2, String param3, List param4)
public static Map getSummary(String param0, int param1, int param2) throws IdUsedException, IdInvalidException, PermissionException
param0
- channel reference string.param1
- Maximum number of items to returnparam2
- Maximum number of days to peer backIdUsedException
- if the id is not unique.IdInvalidException
- if the id is not made up of valid characters.PermissionException
- if the user does not have permission to add a channel.public static Reference getAnnouncementReference(String param0)
param0
- announcement context (site-id)public static String getRssUrl(Reference param0)
param0
- The announcement entity referencepublic static boolean isMessageViewable(AnnouncementMessage param0)
param0
- AnnouncementMessagepublic static void clearMessagesCache(String channelRef)
channelRef
- public static List getMessages(String channelReference, Filter filter, boolean order, boolean merged) throws IdUnusedException, PermissionException, NullPointerException
channelReference
- Channel's reference Stringfilter
- A filtering object to accept messages, or null if no filtering is desired.order
- Order of messages, ascending if true, descending if falsemerged
- flag to include merged channel messages, true returns ALL messages including merged sites/channelsIdUnusedException
- If this name is not defined for a announcement channel.PermissionException
- if the user does not have read permission to the channel.NullPointerException
Copyright © 2003–2019 The Sakai Foundation. All rights reserved.