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

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.user.api .PreferencesService

All known Subclasses:   org.sakaiproject.user.impl .BasePreferencesService,
PreferencesService
public interface PreferencesService extends EntityProducer(Code)

The PreferencesService keeps sets of preferences for each user (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 static String REFERENCE_ROOT
     This string starts the references to resources in this service.
final static String SECURE_ADD_PREFS
     Securiy / Event for adding a preferences.
final static String SECURE_EDIT_PREFS
     Securiy / Event for updating a preferences.
final static String SECURE_REMOVE_PREFS
     Securiy / Event for removing a preferences.

Method Summary
PreferencesEdit add(String id)
     Add a new set of preferences with this id.
boolean allowUpdate(String id)
     Check to see if the current user can add or modify permissions with this id.
Parameters:
  id - The preferences id.
void cancel(PreferencesEdit edit)
     Cancel the changes made to a PreferencesEdit object, and release the lock.
void commit(PreferencesEdit edit)
     Commit the changes made to a PreferencesEdit object, and release the lock.
PreferencesEdit edit(String id)
     Get a locked Preferences object for editing.
Preferences getPreferences(String id)
     Access a set of preferences associated with this id.
Parameters:
  id - The preferences id.
void remove(PreferencesEdit edit)
     Remove this PreferencesEdit - it must be locked from edit().

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 static String REFERENCE_ROOT(Code)
This string starts the references to resources in this service.

SECURE_ADD_PREFS
final static String SECURE_ADD_PREFS(Code)
Securiy / Event for adding a preferences.

SECURE_EDIT_PREFS
final static String SECURE_EDIT_PREFS(Code)
Securiy / Event for updating a preferences.

SECURE_REMOVE_PREFS
final static String SECURE_REMOVE_PREFS(Code)
Securiy / Event for removing a preferences.

Method Detail
add
PreferencesEdit add(String id) throws PermissionException, IdUsedException(Code)
Add a new set of preferences with this id. Must commit(), remove() or cancel() when done.
Parameters:
  id - The preferences id. A PreferencesEdit object for editing, possibly new.
exception:
  PermissionException - if the current user does not have permission add preferences for this id.
exception:
  IdUsedException - if these preferences already exist.

allowUpdate
boolean allowUpdate(String id)(Code)
Check to see if the current user can add or modify permissions with this id.
Parameters:
  id - The preferences id. true if the user is allowed to update or add these preferences, false if not.

cancel
void cancel(PreferencesEdit edit)(Code)
Cancel the changes made to a PreferencesEdit object, and release the lock. The PreferencesEdit is disabled, and not to be used after this call.
Parameters:
  user - The PreferencesEdit object to commit.

commit
void commit(PreferencesEdit edit)(Code)
Commit the changes made to a PreferencesEdit object, and release the lock. The PreferencesEdit is disabled, and not to be used after this call.
Parameters:
  user - The PreferencesEdit object to commit.

edit
PreferencesEdit edit(String id) throws PermissionException, InUseException, IdUnusedException(Code)
Get a locked Preferences object for editing. Must commit(), cancel() or remove() when done.
Parameters:
  id - The preferences id. A PreferencesEdit object for editing, possibly new.
exception:
  PermissionException - if the current user does not have permission to edit these preferences.
exception:
  InUseException - if the preferences object is locked by someone else.
exception:
  IdUnusedException - if there is not preferences object with this id.

getPreferences
Preferences getPreferences(String id)(Code)
Access a set of preferences associated with this id.
Parameters:
  id - The preferences id. The Preferences object.

remove
void remove(PreferencesEdit edit)(Code)
Remove this PreferencesEdit - it must be locked from edit(). The PreferencesEdit is disabled, and not to be used after this call.
Parameters:
  user - The PreferencesEdit object to remove.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.