Java Doc for AnnouncementService.java in » ERP-CRM-Financial » sakai » org » sakaiproject » announcement » api » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.announcement.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.announcement.api .AnnouncementService

All known Subclasses:   org.sakaiproject.announcement.impl .BaseAnnouncementService,
AnnouncementService
public interface AnnouncementService extends MessageService(Code)

AnnouncementService is the extension to MessageService configured for Announcements.

MessageChannels are AnnouncementMessageChannels, and Messages are AnnouncementMessages with AnnouncementMessageHeaders.

Security in the announcement service, in addition to that defined in the channels, include:

announcement.channel.add

announcement.channel.remove

Usage Events are generated:

announcement.channel.add - announcement channel resource id

announcement.channel.remove - announcement channel resource id

Field Summary
final static String APPLICATION_ID
     The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
final public static String REFERENCE_ROOT
     This string starts the references to resources in this service.
final public static String SECURE_ANNC_ADD
     Security lock / event for adding channel / message.
final public static String SECURE_ANNC_ALL_GROUPS
     Security function giving the user permission to all groups, if granted to at the channel or site level.
final public static String SECURE_ANNC_READ
     Security lock / event for reading channel / message.
final public static String SECURE_ANNC_READ_DRAFT
     Security lock / event for accessing someone elses draft.
final public static String SECURE_ANNC_REMOVE_ANY
     Security lock / event for removing anyone's message or channel.
final public static String SECURE_ANNC_REMOVE_OWN
     Security lock / event for removing one's own message.
final public static String SECURE_ANNC_ROOT
     Security lock / event root for generic message events to make it a mail event.
final public static String SECURE_ANNC_UPDATE_ANY
     Security lock / event for updating any message.
final public static String SECURE_ANNC_UPDATE_OWN
     Security lock / event for updating one's own message or the channel.

Method Summary
public AnnouncementChannelEdit addAnnouncementChannel(String ref)
     A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
Parameters:
  ref - The channel reference.
public AnnouncementChannel getAnnouncementChannel(String ref)
     A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.
Parameters:
  ref - The channel reference.

Field Detail
APPLICATION_ID
final static String APPLICATION_ID(Code)
The type string for this application: should not change over time as it may be stored in various parts of persistent entities.

REFERENCE_ROOT
final public static String REFERENCE_ROOT(Code)
This string starts the references to resources in this service.

SECURE_ANNC_ADD
final public static String SECURE_ANNC_ADD(Code)
Security lock / event for adding channel / message.

SECURE_ANNC_ALL_GROUPS
final public static String SECURE_ANNC_ALL_GROUPS(Code)
Security function giving the user permission to all groups, if granted to at the channel or site level.

SECURE_ANNC_READ
final public static String SECURE_ANNC_READ(Code)
Security lock / event for reading channel / message.

SECURE_ANNC_READ_DRAFT
final public static String SECURE_ANNC_READ_DRAFT(Code)
Security lock / event for accessing someone elses draft.

SECURE_ANNC_REMOVE_ANY
final public static String SECURE_ANNC_REMOVE_ANY(Code)
Security lock / event for removing anyone's message or channel.

SECURE_ANNC_REMOVE_OWN
final public static String SECURE_ANNC_REMOVE_OWN(Code)
Security lock / event for removing one's own message.

SECURE_ANNC_ROOT
final public static String SECURE_ANNC_ROOT(Code)
Security lock / event root for generic message events to make it a mail event.

SECURE_ANNC_UPDATE_ANY
final public static String SECURE_ANNC_UPDATE_ANY(Code)
Security lock / event for updating any message.

SECURE_ANNC_UPDATE_OWN
final public static String SECURE_ANNC_UPDATE_OWN(Code)
Security lock / event for updating one's own message or the channel.

Method Detail
addAnnouncementChannel
public AnnouncementChannelEdit addAnnouncementChannel(String ref) throws IdUsedException, IdInvalidException, PermissionException(Code)
A (AnnouncementChannel) cover for addChannel() to add a new announcement channel.
Parameters:
  ref - The channel reference. The newly created channel.
exception:
  IdUsedException - if the id is not unique.
exception:
  IdInvalidException - if the id is not made up of valid characters.
exception:
  PermissionException - if the user does not have permission to add a channel.

getAnnouncementChannel
public AnnouncementChannel getAnnouncementChannel(String ref) throws IdUnusedException, PermissionException(Code)
A (AnnouncementChannel) cover for getChannel() to return a specific announcement channel.
Parameters:
  ref - The channel reference. the AnnouncementChannel that has the specified name.
exception:
  IdUnusedException - If this name is not defined for a announcement channel.
exception:
  PermissionException - If the user does not have any permissions to the channel.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.