Java Doc for IEntityGroup.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » groups » 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 » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.groups 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.jasig.portal.groups.IEntityGroup

All known Subclasses:   org.jasig.portal.channels.groupsmanager.SearchResultsGroupImpl,  org.jasig.portal.groups.EntityGroupImpl,
IEntityGroup
public interface IEntityGroup extends IGroupMember(Code)
An IEntityGroup is a composite, or non-leaf IGroupMember. It contains IEntities and other IEntityGroups.

The api defines methods for adding a member to, and removing it from, a group, though not vice versa. (Although there is nothing to prevent a given IGroupMember implementation from storing references to its containing groups.) These methods only change the group structure in memory.

addMember(IGroupMember gm)
removeMember(IGroupMember gm)

The following methods commit changes in the group structure to the persistent store:

delete() - delete the group and its memberships
update() - insert or update the group, as appropriate
updateMembers() - insert/update/delete group memberships as appropriate

The following methods were added to permit an IEntityGroup to function within a composite group service:

getLocalKey() - returns the key within the service of origin.
getServiceName() - returns the Name of the group service of origin.
setLocalGroupService() - sets the group service of origin.


author:
   Dan Ellentuck
version:
   $Revision: 34758 $





Method Summary
public  voidaddMember(IGroupMember gm)
     Adds IGroupMember gm to this group, but does not commit it to the data store.
public  voiddelete()
     Deletes the IEntityGroup from the data store.
exception:
  GroupsException - if the delete cannot be performed.
public  StringgetCreatorID()
     Returns the name of the group creator.
public  StringgetDescription()
     Returns the group description, which may be null.
public  StringgetLocalKey()
     Returns the key from the group service of origin.
public  StringgetName()
     Returns the group name.
public  NamegetServiceName()
     Returns the Name of the group service of origin.
public  booleanisEditable()
     Answers if this IEntityGroup can be changed or deleted.
public  voidremoveMember(IGroupMember gm)
     Removes the IGroupMember from this group, but does not remove the membership from the data store.
public  voidsetCreatorID(String userID)
    
public  voidsetDescription(String name)
    
public  voidsetLocalGroupService(IIndividualGroupService groupService)
     Sets the group service of origin.
public  voidsetName(String name)
     Sets the group name which must be unique within any of its containing groups.
public  voidupdate()
     Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.
exception:
  GroupsException - if the update cannot be performed.
public  voidupdateMembers()
     Commit this IEntityGroup's memberships to the data store.
exception:
  GroupsException - if the update cannot be performed.



Method Detail
addMember
public void addMember(IGroupMember gm) throws GroupsException(Code)
Adds IGroupMember gm to this group, but does not commit it to the data store. Use updateMembers() to commit memberships to the data store.
Parameters:
  gm - org.jasig.portal.groups.IGroupMember
exception:
  GroupsException - is thrown if the member is a group andthis group already has a group with the same name or if the additionof the group creates a circular reference.



delete
public void delete() throws GroupsException(Code)
Deletes the IEntityGroup from the data store.
exception:
  GroupsException - if the delete cannot be performed.



getCreatorID
public String getCreatorID()(Code)
Returns the name of the group creator. May be null. String



getDescription
public String getDescription()(Code)
Returns the group description, which may be null. String



getLocalKey
public String getLocalKey()(Code)
Returns the key from the group service of origin. String



getName
public String getName()(Code)
Returns the group name. String



getServiceName
public Name getServiceName()(Code)
Returns the Name of the group service of origin. String



isEditable
public boolean isEditable() throws GroupsException(Code)
Answers if this IEntityGroup can be changed or deleted. boolean
exception:
  GroupsException -



removeMember
public void removeMember(IGroupMember gm) throws GroupsException(Code)
Removes the IGroupMember from this group, but does not remove the membership from the data store.
Parameters:
  gm - org.jasig.portal.groups.IGroupMember



setCreatorID
public void setCreatorID(String userID)(Code)

Parameters:
  userID - String (required)



setDescription
public void setDescription(String name)(Code)

Parameters:
  name - String (may be null)



setLocalGroupService
public void setLocalGroupService(IIndividualGroupService groupService) throws GroupsException(Code)
Sets the group service of origin.



setName
public void setName(String name) throws GroupsException(Code)
Sets the group name which must be unique within any of its containing groups.
Parameters:
  name - String
exception:
  GroupsException -



update
public void update() throws GroupsException(Code)
Commit the IEntityGroup AND ITS MEMBERSHIPS to the data store.
exception:
  GroupsException - if the update cannot be performed.



updateMembers
public void updateMembers() throws GroupsException(Code)
Commit this IEntityGroup's memberships to the data store.
exception:
  GroupsException - if the update cannot be performed.



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