Java Doc for IGroupMember.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.IGroupMember

All known Subclasses:   org.jasig.portal.groups.GroupMemberImpl,
IGroupMember
public interface IGroupMember extends IBasicEntity(Code)
An IGroupMember defines common behavior for both the leaf IEntity and composite IEntityGroup sub-types that together make up a Groups structure.

An IGroupMember can answer both its parents and its children but has no api for adding or removing them. These methods are defined on the composite type, IEntityGroup, since you add a member to a group, and not vice versa.

Because it extends IBasicEntity, an IGroupMember has an EntityIdentifier that can be used to cache and lock it. A leaf IGroupMember also has a separate EntityIdentifier for its underlying entity. This second EntityIdentifier is used to create and record group memberships. In the case of a composite (non-leaf) IGroupMember, both EntityIdentifiers are the same.

Take care to implement equals() and hashCode() so that duplicates returned from "deep" methods can be recognized.
author:
   Dan Ellentuck
version:
   $Revision: 34758 $





Method Summary
public  booleancontains(IGroupMember gm)
     Answers if IGroupMember gm is a member of this.
public  booleandeepContains(IGroupMember gm)
     Answers if IGroupMember gm is a recursive member of this.
public  booleanequals(Object o)
     Answers if Object o is an IGroupMember that refers to the same underlying entity(ies) as this.
public  IteratorgetAllContainingGroups()
     Returns an Iterator over the Set of this IGroupMember's recursively-retrieved parent groups.
public  IteratorgetAllEntities()
     Returns an Iterator over the Set of this IGroupMember's recursively-retrieved members that are IEntities.
public  IteratorgetAllMembers()
     Returns an Iterator over the Set of recursively-retrieved IGroupMembers that are members of this.
public  IteratorgetContainingGroups()
     Returns an Iterator over this IGroupMember's parent groups.
public  IteratorgetEntities()
     Returns an Iterator over this IGroupMember's members that are IEntities.
public  ClassgetEntityType()
     Returns the underlying entity type.
public  StringgetKey()
     Returns the key of the underlying entity.
public  ClassgetLeafType()
    
public  IEntityGroupgetMemberGroupNamed(String name)
     Returns the named IEntityGroup from our members Collection.
public  IteratorgetMembers()
     Returns an Iterator over the IGroupMembers in our member Collection.
public  ClassgetType()
     Returns the type of the underlying entity.
public  EntityIdentifiergetUnderlyingEntityIdentifier()
     Returns EntityIdentifier for this IGroupMember's underlying entity.
public  booleanhasMembers()
     Answers if this IGroupMember has any members.
public  inthashCode()
    
public  booleanisDeepMemberOf(IGroupMember gm)
     Answers if this is a recursive member of IGroupMember gm.
public  booleanisEntity()
    
public  booleanisGroup()
    
public  booleanisMemberOf(IGroupMember gm)
     Answers if this is a member of IGroupMember gm.



Method Detail
contains
public boolean contains(IGroupMember gm) throws GroupsException(Code)
Answers if IGroupMember gm is a member of this. boolean
Parameters:
  gm - org.jasig.portal.groups.IGroupMember



deepContains
public boolean deepContains(IGroupMember gm) throws GroupsException(Code)
Answers if IGroupMember gm is a recursive member of this. boolean
Parameters:
  gm - org.jasig.portal.groups.IGroupMember



equals
public boolean equals(Object o)(Code)
Answers if Object o is an IGroupMember that refers to the same underlying entity(ies) as this.
Parameters:
  o - boolean



getAllContainingGroups
public Iterator getAllContainingGroups() throws GroupsException(Code)
Returns an Iterator over the Set of this IGroupMember's recursively-retrieved parent groups. java.util.Iterator



getAllEntities
public Iterator getAllEntities() throws GroupsException(Code)
Returns an Iterator over the Set of this IGroupMember's recursively-retrieved members that are IEntities. java.util.Iterator



getAllMembers
public Iterator getAllMembers() throws GroupsException(Code)
Returns an Iterator over the Set of recursively-retrieved IGroupMembers that are members of this. java.util.Iterator



getContainingGroups
public Iterator getContainingGroups() throws GroupsException(Code)
Returns an Iterator over this IGroupMember's parent groups. java.util.Iterator



getEntities
public Iterator getEntities() throws GroupsException(Code)
Returns an Iterator over this IGroupMember's members that are IEntities. java.util.Iterator



getEntityType
public Class getEntityType()(Code)
Returns the underlying entity type. For an IEntityGroup, this is analagous to Class as applied to an Array; it is an attribute of the group object. For an IEntity, it is the entity type of the group the entity belongs to, which may be any Class the underlying entity can be legally cast to. Thus, an IEntity with an underlying entity of type Manager could have an entity type of Employee as long as Employee was a superclass of Manager. java.lang.Class



getKey
public String getKey()(Code)
Returns the key of the underlying entity. String



getLeafType
public Class getLeafType()(Code)

See Also:   IGroupMember.getEntityType()



getMemberGroupNamed
public IEntityGroup getMemberGroupNamed(String name) throws GroupsException(Code)
Returns the named IEntityGroup from our members Collection. org.jasig.portal.groups.IEntityGroup
Parameters:
  name - java.lang.String



getMembers
public Iterator getMembers() throws GroupsException(Code)
Returns an Iterator over the IGroupMembers in our member Collection. java.util.Iterator



getType
public Class getType()(Code)
Returns the type of the underlying entity. For a group this will be IEntityGroup. For an entity, it will be the type of the underlying EntityIdentifier. java.lang.Class



getUnderlyingEntityIdentifier
public EntityIdentifier getUnderlyingEntityIdentifier()(Code)
Returns EntityIdentifier for this IGroupMember's underlying entity. In the case of an IEntityGroup, it will be the EntityIdentifier for this. In the case of an IEntity, it will be the EntityIdentifier that identifies the underlying IPerson, ChannelDefinition, etc. org.jasig.portal.EntityIdentifier



hasMembers
public boolean hasMembers() throws GroupsException(Code)
Answers if this IGroupMember has any members. boolean



hashCode
public int hashCode()(Code)
int



isDeepMemberOf
public boolean isDeepMemberOf(IGroupMember gm) throws GroupsException(Code)
Answers if this is a recursive member of IGroupMember gm. boolean
Parameters:
  gm - org.jasig.portal.groups.IGroupMember



isEntity
public boolean isEntity()(Code)
boolean



isGroup
public boolean isGroup()(Code)
boolean



isMemberOf
public boolean isMemberOf(IGroupMember gm) throws GroupsException(Code)
Answers if this is a member of IGroupMember gm. boolean
Parameters:
  gm - org.jasig.portal.groups.IGroupMember



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