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

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.presence.api .PresenceService

All known Subclasses:   org.sakaiproject.presence.impl .BasePresenceService,
PresenceService
public interface PresenceService (Code)

A PresenceService keeps track of a session's presence at various locations in the system.

Location is a combination of site id, (optional) page id and (optional) tool id

Field Summary
final static String EVENT_ABSENCE
     Name for the event of ending presence at a location.
final static String EVENT_PRESENCE
     Name for the event of establishing presence at a location.
final static String REFERENCE_ROOT
     This string starts the references to resources in this service.

Method Summary
String getLocationDescription(String location)
     Form a description for the location.
Parameters:
  location - The presence location.
List getLocations()
     Access a List of all location ids (String).
List getPresence(String locationId)
     Access a List of sessions (UsageSession) now present in a location.
Parameters:
  locationId - A presence location id.
List getPresentUsers(String locationId)
     Access a List of users (User) now present in a location.
Parameters:
  locationId - A presence location id.
List getPresentUsers(String locationId, String siteId)
     Access a List of users (User) now present in a location.
int getTimeout()
     Access the time (in seconds) after which a presence will timeout.
String locationId(String site, String page, String tool)
     Construct a location id from site, page, and tool.
Parameters:
  site - The site id.
Parameters:
  page - The page id (optional).
Parameters:
  tool - The tool id (optional).
String presenceReference(String id)
     Form a presence reference from a location id
Parameters:
  id - the location id.
void removePresence(String locationId)
     Remove the presence of the current session from a location.
void setPresence(String locationId)
     Establish or refresh the presence of the current session in a location.

Field Detail
EVENT_ABSENCE
final static String EVENT_ABSENCE(Code)
Name for the event of ending presence at a location.

EVENT_PRESENCE
final static String EVENT_PRESENCE(Code)
Name for the event of establishing presence at a location.

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

Method Detail
getLocationDescription
String getLocationDescription(String location)(Code)
Form a description for the location.
Parameters:
  location - The presence location. A description for the location.

getLocations
List getLocations()(Code)
Access a List of all location ids (String). The List of all location ids (Strings) (may be empty).

getPresence
List getPresence(String locationId)(Code)
Access a List of sessions (UsageSession) now present in a location.
Parameters:
  locationId - A presence location id. The a List of sessions (UsageSession) now present in the location (may be empty).

getPresentUsers
List getPresentUsers(String locationId)(Code)
Access a List of users (User) now present in a location.
Parameters:
  locationId - A presence location id. The a List of users (User) now present in the location (may be empty).

getPresentUsers
List getPresentUsers(String locationId, String siteId)(Code)
Access a List of users (User) now present in a location.
Parameters:
  locationId - A presence location id.
Parameters:
  siteId - A siteId (added when integrating PrivacyManager) The a List of users (User) now present in the location (may be empty).

getTimeout
int getTimeout()(Code)
Access the time (in seconds) after which a presence will timeout. The time (seconds) after which a presence will timeout.

locationId
String locationId(String site, String page, String tool)(Code)
Construct a location id from site, page, and tool.
Parameters:
  site - The site id.
Parameters:
  page - The page id (optional).
Parameters:
  tool - The tool id (optional). a Location Id.

presenceReference
String presenceReference(String id)(Code)
Form a presence reference from a location id
Parameters:
  id - the location id. A presence reference based on a location id.

removePresence
void removePresence(String locationId)(Code)
Remove the presence of the current session from a location.
Parameters:
  session - The session object.
Parameters:
  locationId - A presence location id.

setPresence
void setPresence(String locationId)(Code)
Establish or refresh the presence of the current session in a location.
Parameters:
  session - The session object.
Parameters:
  locationId - A presence location id.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.