org.sakaiproject.service.legacy.announcement.cover
Class AnnouncementService

java.lang.Object
  extended byorg.sakaiproject.service.legacy.announcement.cover.AnnouncementService

public class AnnouncementService
extends Object

AnnouncementService is a static Cover for the AnnouncementService; see that interface for usage details.

Version:
$Revision: 2762 $
Author:
University of Michigan, Sakai Software Development Team

Field Summary
static String REF_TYPE_CHANNEL
           
static String REF_TYPE_CHANNEL_GROUPS
           
static String REF_TYPE_MESSAGE
           
static String REFERENCE_ROOT
           
static String SECURE_ADD
           
static String SECURE_ANNC_ADD
           
static String SECURE_ANNC_READ
           
static String SECURE_ANNC_READ_DRAFT
           
static String SECURE_ANNC_REMOVE_ANY
           
static String SECURE_ANNC_REMOVE_OWN
           
static String SECURE_ANNC_ROOT
           
static String SECURE_ANNC_UPDATE_ANY
           
static String SECURE_ANNC_UPDATE_OWN
           
static String SECURE_READ
           
static String SECURE_READ_DRAFT
           
static String SECURE_REMOVE_ANY
           
static String SECURE_REMOVE_OWN
           
static String SECURE_UPDATE_ANY
           
static String SECURE_UPDATE_OWN
           
static String SERVICE_NAME
           
 
Constructor Summary
AnnouncementService()
           
 
Method Summary
static AnnouncementChannelEdit addAnnouncementChannel(String param0)
           
static MessageChannelEdit addChannel(String param0)
           
static boolean allowAddChannel(String param0)
           
static boolean allowEditChannel(String param0)
           
static boolean allowGetChannel(String param0)
           
static boolean allowRemoveChannel(String param0)
           
static String archive(String param0, Document param1, Stack param2, String param3, List param4)
           
static void cancelChannel(MessageChannelEdit param0)
           
static void cancelMessage(MessageEdit param0)
           
static String channelReference(String param0, String param1)
           
static void commitChannel(MessageChannelEdit param0)
           
static MessageChannelEdit editChannel(String param0)
           
static AnnouncementChannel getAnnouncementChannel(String param0)
           
static MessageChannel getChannel(String param0)
           
static List getChannelIds(String param0)
           
static List getChannels()
           
static AnnouncementService getInstance()
          Access the component instance: special cover only method.
static String getLabel()
           
static Message getMessage(Reference param0)
           
static List getMessages(String param0, Time param1, int param2, boolean param3, boolean param4, boolean param5)
           
static void importResources(String param0, String param1, List param2)
           
static String merge(String param0, Element param1, String param2, String param3, Map param4, HashMap param5, Set param6)
           
static String messageReference(String param0, String param1)
           
static String messageReference(String param0, String param1, String param2)
           
static void removeChannel(MessageChannelEdit param0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SERVICE_NAME

public static String SERVICE_NAME

REFERENCE_ROOT

public static String REFERENCE_ROOT

SECURE_ANNC_ROOT

public static String SECURE_ANNC_ROOT

SECURE_ANNC_READ

public static String SECURE_ANNC_READ

SECURE_ANNC_ADD

public static String SECURE_ANNC_ADD

SECURE_ANNC_REMOVE_OWN

public static String SECURE_ANNC_REMOVE_OWN

SECURE_ANNC_REMOVE_ANY

public static String SECURE_ANNC_REMOVE_ANY

SECURE_ANNC_UPDATE_OWN

public static String SECURE_ANNC_UPDATE_OWN

SECURE_ANNC_UPDATE_ANY

public static String SECURE_ANNC_UPDATE_ANY

SECURE_ANNC_READ_DRAFT

public static String SECURE_ANNC_READ_DRAFT

SECURE_READ

public static String SECURE_READ

SECURE_ADD

public static String SECURE_ADD

SECURE_REMOVE_OWN

public static String SECURE_REMOVE_OWN

SECURE_REMOVE_ANY

public static String SECURE_REMOVE_ANY

SECURE_UPDATE_OWN

public static String SECURE_UPDATE_OWN

SECURE_UPDATE_ANY

public static String SECURE_UPDATE_ANY

SECURE_READ_DRAFT

public static String SECURE_READ_DRAFT

REF_TYPE_CHANNEL

public static String REF_TYPE_CHANNEL

REF_TYPE_CHANNEL_GROUPS

public static String REF_TYPE_CHANNEL_GROUPS

REF_TYPE_MESSAGE

public static String REF_TYPE_MESSAGE
Constructor Detail

AnnouncementService

public AnnouncementService()
Method Detail

getInstance

public static AnnouncementService getInstance()
Access the component instance: special cover only method.

Returns:
the component instance.

getAnnouncementChannel

public static AnnouncementChannel getAnnouncementChannel(String param0)
                                                  throws IdUnusedException,
                                                         PermissionException
Throws:
IdUnusedException
PermissionException

addAnnouncementChannel

public static AnnouncementChannelEdit addAnnouncementChannel(String param0)
                                                      throws IdUsedException,
                                                             IdInvalidException,
                                                             PermissionException
Throws:
IdUsedException
IdInvalidException
PermissionException

getChannels

public static List getChannels()

allowGetChannel

public static boolean allowGetChannel(String param0)

allowAddChannel

public static boolean allowAddChannel(String param0)

addChannel

public static MessageChannelEdit addChannel(String param0)
                                     throws IdUsedException,
                                            IdInvalidException,
                                            PermissionException
Throws:
IdUsedException
IdInvalidException
PermissionException

allowEditChannel

public static boolean allowEditChannel(String param0)

editChannel

public static MessageChannelEdit editChannel(String param0)
                                      throws IdUnusedException,
                                             PermissionException,
                                             InUseException
Throws:
IdUnusedException
PermissionException
InUseException

commitChannel

public static void commitChannel(MessageChannelEdit param0)

cancelChannel

public static void cancelChannel(MessageChannelEdit param0)

allowRemoveChannel

public static boolean allowRemoveChannel(String param0)

removeChannel

public static void removeChannel(MessageChannelEdit param0)
                          throws PermissionException
Throws:
PermissionException

channelReference

public static String channelReference(String param0,
                                      String param1)

messageReference

public static String messageReference(String param0,
                                      String param1,
                                      String param2)

messageReference

public static String messageReference(String param0,
                                      String param1)

cancelMessage

public static void cancelMessage(MessageEdit param0)

getMessages

public static List getMessages(String param0,
                               Time param1,
                               int param2,
                               boolean param3,
                               boolean param4,
                               boolean param5)
                        throws PermissionException
Throws:
PermissionException

getChannelIds

public static List getChannelIds(String param0)

getMessage

public static Message getMessage(Reference param0)
                          throws IdUnusedException,
                                 PermissionException
Throws:
IdUnusedException
PermissionException

getChannel

public static MessageChannel getChannel(String param0)
                                 throws IdUnusedException,
                                        PermissionException
Throws:
IdUnusedException
PermissionException

merge

public static String merge(String param0,
                           Element param1,
                           String param2,
                           String param3,
                           Map param4,
                           HashMap param5,
                           Set param6)

getLabel

public static String getLabel()

archive

public static String archive(String param0,
                             Document param1,
                             Stack param2,
                             String param3,
                             List param4)

importResources

public static void importResources(String param0,
                                   String param1,
                                   List param2)