Java Doc for Group.java in  » Forum » nemesis-forum » org » nemesis » forum » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » Forum » nemesis forum » org.nemesis.forum 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.nemesis.forum.Group

All known Subclasses:   org.nemesis.forum.proxy.GroupProxy,  org.nemesis.forum.impl.DbGroup,
Group
public interface Group (Code)
Organizes Users into a group for easier permissions management at the Forum level. In this way, Groups essentially serve the same purpose that they do in Unix or Windows.

For example, CREATE_THREAD permissions can be set per forum. A forum administrator may wish to create a "Thread Posters" group that has CREATE_THREAD permissions in the forum. Then, users can be added to that group and will automatically receive CREATE_THREAD permissions in that forum.

Security for Group objects is provide by GroupProxy protection proxy objects.
See Also:   User





Method Summary
public  voidaddAdministrator(User user)
     Grants administrator privileges of the group to a user.

This method is restricted to those with group administration permission.

public  voidaddMember(User user)
     Adds a member to the group.

This method is restricted to those with group administration permission.

public  Iteratoradministrators()
     An iterator for all the users that are administrators of the group.
public  intgetAdministratorCount()
     Returns the number of group administrators.
public  StringgetDescription()
     Returns the description of the group.
public  intgetID()
     Returns the id of the group.
public  intgetMemberCount()
     Returns the number of group members.
public  StringgetName()
     Returns the name of the group.
abstract public  ForumPermissionsgetPermissions(Authorization authorization)
     Returns the permissions for the group that correspond to the passed-in Authorization.
public  booleanhasPermission(int type)
     Returns true if the handle on the object has the permission specified. A list of possible permissions can be found in the ForumPermissions class.
public  booleanisAdministrator(User user)
     Returns true if the User has group administrator permissions.
public  booleanisMember(User user)
     Returns true if if the User is a member of the group.
public  Iteratormembers()
     An iterator for all the users that are members of the group.
public  voidremoveAdministrator(User user)
     Revokes administrator privileges of the group to a user.

This method is restricted to those with group administration permission.

public  voidremoveMember(User user)
     Removes a member from the group.
public  voidsetDescription(String description)
     Sets the description of the group.
public  voidsetName(String name)
     Sets the name of the group.



Method Detail
addAdministrator
public void addAdministrator(User user) throws UnauthorizedException(Code)
Grants administrator privileges of the group to a user.

This method is restricted to those with group administration permission.
Parameters:
  user - the User to grant adminstrative privileges to.
throws:
  UnauthorizedException - if does not have group admin permissions.




addMember
public void addMember(User user) throws UnauthorizedException(Code)
Adds a member to the group.

This method is restricted to those with group administration permission.
Parameters:
  user - the User to add to the group.
throws:
  UnauthorizedException - if does not have group admin permissions.




administrators
public Iterator administrators()(Code)
An iterator for all the users that are administrators of the group. an Iterator for all administrators of the group.



getAdministratorCount
public int getAdministratorCount()(Code)
Returns the number of group administrators. the number of group administrators.



getDescription
public String getDescription()(Code)
Returns the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ forum'. the description of the group.



getID
public int getID()(Code)
Returns the id of the group. the id of the group.



getMemberCount
public int getMemberCount()(Code)
Returns the number of group members. the number of group members.



getName
public String getName()(Code)
Returns the name of the group. For example, 'XYZ Admins'. the name of the group.



getPermissions
abstract public ForumPermissions getPermissions(Authorization authorization)(Code)
Returns the permissions for the group that correspond to the passed-in Authorization.
Parameters:
  authorization - the auth token to lookup permissions for.



hasPermission
public boolean hasPermission(int type)(Code)
Returns true if the handle on the object has the permission specified. A list of possible permissions can be found in the ForumPermissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.
Parameters:
  type - a permission type. true if the specified permission is valid.
See Also:   ForumPermissions



isAdministrator
public boolean isAdministrator(User user)(Code)
Returns true if the User has group administrator permissions. Group administrators are also considered to be members. true if the User is an administrator of the group.



isMember
public boolean isMember(User user)(Code)
Returns true if if the User is a member of the group. true if the User is a member of the group.



members
public Iterator members()(Code)
An iterator for all the users that are members of the group. an Iterator for all members of the group.



removeAdministrator
public void removeAdministrator(User user) throws UnauthorizedException(Code)
Revokes administrator privileges of the group to a user.

This method is restricted to those with group administration permission.
Parameters:
  user - the User to grant adminstrative privileges to.
throws:
  UnauthorizedException - if does not have group admin permissions.




removeMember
public void removeMember(User user) throws UnauthorizedException(Code)
Removes a member from the group. If the User is not in the group, this method does nothing.

This method is restricted to those with group administration permission.
Parameters:
  user - the User to remove from the group.
throws:
  UnauthorizedException - if does not have group admin permissions.




setDescription
public void setDescription(String description) throws UnauthorizedException(Code)
Sets the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ forum'.

This method is restricted to those with group administration permission.
Parameters:
  name - the description of the group.
throws:
  UnauthorizedException - if does not have group admin permissions.




setName
public void setName(String name) throws UnauthorizedException(Code)
Sets the name of the group. For example, 'XYZ Admins'.

This method is restricted to those with group administration permission.
Parameters:
  name - the name for the group.
throws:
  UnauthorizedException - if does not have group admin permissions.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.