uPortal 2.4.1
API Documentation

org.jasig.portal.groups
Class RDBMEntityGroupStore

java.lang.Object
  extended byorg.jasig.portal.groups.RDBMEntityGroupStore
All Implemented Interfaces:
IEntityGroupStore, IGroupConstants

public class RDBMEntityGroupStore
extends java.lang.Object
implements IEntityGroupStore, IGroupConstants

Store for EntityGroupImpl.

Version:
$Revision: 1.26.2.1 $
Author:
Dan Ellentuck

Field Summary
 
Fields inherited from interface org.jasig.portal.groups.IGroupConstants
CHANNEL_CATEGORIES, CONTAINS, ENDS_WITH, EVERYONE, IS, NODE_SEPARATOR, PORTAL_ADMINISTRATORS, STARTS_WITH
 
Constructor Summary
RDBMEntityGroupStore()
          RDBMEntityGroupStore constructor.
 
Method Summary
 boolean contains(IEntityGroup group, IGroupMember member)
          Answers if IGroupMember member is a member of group.
 boolean containsGroupNamed(IEntityGroup containingGroup, java.lang.String memberName)
           
 void delete(IEntityGroup group)
          If this entity exists, delete it.
 IEntityGroup find(java.lang.String groupID)
          Find and return an instance of the group.
 java.util.Iterator findContainingGroups(IEntity ent)
          Find the groups that this entity belongs to.
 java.util.Iterator findContainingGroups(IEntityGroup group)
          Find the groups that this group belongs to.
 java.util.Iterator findContainingGroups(IGroupMember gm)
          Find the groups that this group member belongs to.
 java.util.Iterator findEntitiesForGroup(IEntityGroup group)
          Find the IEntities that are members of the IEntityGroup.
 java.util.Iterator findGroupsByCreator(java.lang.String creatorID)
          Find the groups with this creatorID.
 ILockableEntityGroup findLockable(java.lang.String groupID)
          Find and return an instance of the group.
 java.lang.String[] findMemberGroupKeys(IEntityGroup group)
          Find the keys of groups that are members of group.
 java.util.Iterator findMemberGroups(IEntityGroup group)
          Find the IUserGroups that are members of the group.
 IGroupService getGroupService()
           
 IEntity newEntity(java.lang.Class type, java.lang.String key)
           
 IEntityGroup newInstance(java.lang.Class type)
           
 EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype)
          Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type
 void setGroupService(IGroupService newGroupService)
           
static RDBMEntityGroupStore singleton()
           
 void update(IEntityGroup group)
          Commit this entity AND ITS MEMBERSHIPS to the underlying store.
 void updateMembers(IEntityGroup eg)
          Insert and delete group membership rows inside a transaction.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RDBMEntityGroupStore

public RDBMEntityGroupStore()
RDBMEntityGroupStore constructor.

Method Detail

contains

public boolean contains(IEntityGroup group,
                        IGroupMember member)
                 throws GroupsException
Answers if IGroupMember member is a member of group.

Specified by:
contains in interface IEntityGroupStore
Parameters:
group - org.jasig.portal.groups.IEntityGroup
member - org.jasig.portal.groups.IGroupMember
Returns:
boolean
Throws:
GroupsException

containsGroupNamed

public boolean containsGroupNamed(IEntityGroup containingGroup,
                                  java.lang.String memberName)
                           throws GroupsException
Throws:
GroupsException

delete

public void delete(IEntityGroup group)
            throws GroupsException
If this entity exists, delete it.

Specified by:
delete in interface IEntityGroupStore
Parameters:
group - org.jasig.portal.groups.IEntityGroup
Throws:
GroupsException

find

public IEntityGroup find(java.lang.String groupID)
                  throws GroupsException
Find and return an instance of the group.

Specified by:
find in interface IEntityGroupStore
Parameters:
groupID - the group ID
Returns:
org.jasig.portal.groups.IEntityGroup
Throws:
GroupsException

findContainingGroups

public java.util.Iterator findContainingGroups(IEntity ent)
                                        throws GroupsException
Find the groups that this entity belongs to.

Parameters:
ent - the entity in question
Returns:
java.util.Iterator
Throws:
GroupsException

findContainingGroups

public java.util.Iterator findContainingGroups(IEntityGroup group)
                                        throws GroupsException
Find the groups that this group belongs to.

Parameters:
group - org.jasig.portal.groups.IEntityGroup
Returns:
java.util.Iterator
Throws:
GroupsException

findContainingGroups

public java.util.Iterator findContainingGroups(IGroupMember gm)
                                        throws GroupsException
Find the groups that this group member belongs to.

Specified by:
findContainingGroups in interface IEntityGroupStore
Parameters:
gm - the group member in question
Returns:
java.util.Iterator
Throws:
GroupsException

findEntitiesForGroup

public java.util.Iterator findEntitiesForGroup(IEntityGroup group)
                                        throws GroupsException
Find the IEntities that are members of the IEntityGroup.

Specified by:
findEntitiesForGroup in interface IEntityGroupStore
Parameters:
group - the entity group in question
Returns:
java.util.Iterator
Throws:
GroupsException

findGroupsByCreator

public java.util.Iterator findGroupsByCreator(java.lang.String creatorID)
                                       throws GroupsException
Find the groups with this creatorID.

Parameters:
creatorID -
Returns:
java.util.Iterator
Throws:
GroupsException

findLockable

public ILockableEntityGroup findLockable(java.lang.String groupID)
                                  throws GroupsException
Find and return an instance of the group.

Specified by:
findLockable in interface IEntityGroupStore
Parameters:
groupID - the group ID
Returns:
org.jasig.portal.groups.ILockableEntityGroup
Throws:
GroupsException

findMemberGroupKeys

public java.lang.String[] findMemberGroupKeys(IEntityGroup group)
                                       throws GroupsException
Find the keys of groups that are members of group.

Specified by:
findMemberGroupKeys in interface IEntityGroupStore
Parameters:
group - the org.jasig.portal.groups.IEntityGroup
Returns:
String[]
Throws:
GroupsException

findMemberGroups

public java.util.Iterator findMemberGroups(IEntityGroup group)
                                    throws GroupsException
Find the IUserGroups that are members of the group.

Specified by:
findMemberGroups in interface IEntityGroupStore
Parameters:
group - org.jasig.portal.groups.IEntityGroup
Returns:
java.util.Iterator
Throws:
GroupsException

getGroupService

public IGroupService getGroupService()
Returns:
org.jasig.portal.groups.IGroupService

newEntity

public IEntity newEntity(java.lang.Class type,
                         java.lang.String key)
                  throws GroupsException
Returns:
org.jasig.portal.groups.IEntity
Throws:
GroupsException

newInstance

public IEntityGroup newInstance(java.lang.Class type)
                         throws GroupsException
Specified by:
newInstance in interface IEntityGroupStore
Returns:
org.jasig.portal.groups.IEntityGroup
Throws:
GroupsException

searchForGroups

public EntityIdentifier[] searchForGroups(java.lang.String query,
                                          int method,
                                          java.lang.Class leaftype)
                                   throws GroupsException
Description copied from interface: IEntityGroupStore
Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type

Specified by:
searchForGroups in interface IEntityGroupStore
Throws:
GroupsException

setGroupService

public void setGroupService(IGroupService newGroupService)
Parameters:
newGroupService - org.jasig.portal.groups.IGroupService

singleton

public static RDBMEntityGroupStore singleton()
                                      throws GroupsException
Returns:
org.jasig.portal.groups.RDBMEntityGroupStore
Throws:
GroupsException

update

public void update(IEntityGroup group)
            throws GroupsException
Commit this entity AND ITS MEMBERSHIPS to the underlying store.

Specified by:
update in interface IEntityGroupStore
Parameters:
group - org.jasig.portal.groups.IEntityGroup
Throws:
GroupsException

updateMembers

public void updateMembers(IEntityGroup eg)
                   throws GroupsException
Insert and delete group membership rows inside a transaction.

Specified by:
updateMembers in interface IEntityGroupStore
Parameters:
eg - org.jasig.portal.groups.IEntityGroup
Throws:
GroupsException

uPortal 2.4.1
API Documentation