Java Doc for CourierService.java in » ERP-CRM-Financial » sakai » org » sakaiproject » courier » 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.courier.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.courier.api .CourierService

All known Subclasses:   org.sakaiproject.courier.impl .BasicCourierService,
CourierService
public interface CourierService (Code)

CourierService is the Interface for a Sakai service which can be used to push messages from the Sakai server components to the user interface in the browser.
It is used mostly to cause a tool in a particular portal instance to be refreshed to respond to a change noticed at the server.

An Address identifies a particular client's window: it merges the Usage session, the window's portal page location, and perhaps the tool id (for floating tool windows).

A Delivery object captures the Address, the HTML Element Id involved, and any other details of a particular type of delivery.

Field Summary
final static String SERVICE_NAME
     This string can be used to find the service in the service manager.

Method Summary
void clear(String address, String elementId)
     Clear any pending delivery requests to the particular client window for this element.
void clear(String address)
     Clear any pending delivery requests to this session client window.
void deliver(Delivery delivery)
     Queue up a delivery for the client window identified in the Delivery object.
List getDeliveries(String address)
     Access and de-queue the Deliveries queued up for a particular session client window.
Parameters:
  address - The address of client window.
boolean hasDeliveries(String address)
     Check to see if there are any deliveries queued up for a particular session client window.
Parameters:
  address - The address of the client window.

Field Detail
SERVICE_NAME
final static String SERVICE_NAME(Code)
This string can be used to find the service in the service manager.

Method Detail
clear
void clear(String address, String elementId)(Code)
Clear any pending delivery requests to the particular client window for this element.
Parameters:
  address - The address of the client window.
Parameters:
  elementId - The id of the html element.

clear
void clear(String address)(Code)
Clear any pending delivery requests to this session client window.
Parameters:
  address - The address of client window.

deliver
void deliver(Delivery delivery)(Code)
Queue up a delivery for the client window identified in the Delivery object. The particular form of delivery is determined by the type of Delivery object sent.
Parameters:
  delivery - The Delivery (or extension) object to deliver.

getDeliveries
List getDeliveries(String address)(Code)
Access and de-queue the Deliveries queued up for a particular session client window.
Parameters:
  address - The address of client window. a List of Delivery objects addressed to this session client window.

hasDeliveries
boolean hasDeliveries(String address)(Code)
Check to see if there are any deliveries queued up for a particular session client window.
Parameters:
  address - The address of the client window. true if there are deliveries for this client window, false if not.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.