edu.internet2.middleware.grouper.internal.dao
Interface GroupDAO

All Superinterfaces:
GrouperDAO
All Known Implementing Classes:
Hib3GroupDAO

public interface GroupDAO
extends GrouperDAO

Basic Group DAO interface.

Since:
1.2.0
Version:
$Id: GroupDAO.java,v 1.30 2009-12-10 08:54:15 mchyzer Exp $
Author:
blair christensen.

Method Summary
 void delete(Group _g)
           
 boolean exists(String uuid)
           
 Set<Group> findAllByAnyApproximateAttr(String val)
           
 Set<Group> findAllByAnyApproximateAttr(String val, String scope)
           
 Set<Group> findAllByAnyApproximateAttr(String val, String scope, boolean secureQuery)
           
 Set<Group> findAllByApproximateAlternateName(String name)
          Find groups using an approximate string for the alternate name.
 Set<Group> findAllByApproximateAlternateName(String name, String scope)
          Find groups using an approximate string for the alternate name.
 Set<Group> findAllByApproximateAttr(String attr, String val)
           
 Set<Group> findAllByApproximateAttr(String attr, String val, String scope)
           
 Set<Group> findAllByApproximateAttrSecure(String attr, String val, String scope)
           
 Set<Group> findAllByApproximateCurrentName(String name)
          Find groups using an approximate string for the current name, display name, extension, display extension.
 Set<Group> findAllByApproximateCurrentName(String name, String scope)
          Find groups using an approximate string for the current name, display name, extension, display extension.
 Set<Group> findAllByApproximateName(String name)
           
 Set<Group> findAllByApproximateName(String name, String scope)
           
 Set<Group> findAllByApproximateNameSecure(String name, String scope, QueryOptions queryOptions)
           
 Set<Group> findAllByApproximateNameSecure(String name, String scope, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findAllByAttr(String attr, String val)
           
 Set<Group> findAllByAttr(String attr, String val, String scope)
           
 Set<Group> findAllByAttr(String attr, String val, String scope, boolean secureQuery)
           
 Set<Group> findAllByCreatedAfter(Date d)
           
 Set<Group> findAllByCreatedAfter(Date d, String scope)
           
 Set<Group> findAllByCreatedBefore(Date d)
           
 Set<Group> findAllByCreatedBefore(Date d, String scope)
           
 Set<Group> findAllByLastMembershipAfter(Date d)
           
 Set<Group> findAllByLastMembershipAfter(Date d, String scope)
           
 Set<Group> findAllByLastMembershipBefore(Date d)
           
 Set<Group> findAllByLastMembershipBefore(Date d, String scope)
           
 Set<Group> findAllByModifiedAfter(Date d)
           
 Set<Group> findAllByModifiedAfter(Date d, String scope)
           
 Set<Group> findAllByModifiedBefore(Date d)
           
 Set<Group> findAllByModifiedBefore(Date d, String scope)
           
 Set<Group> findAllByType(GroupType _gt)
          note, this doesnt cache
 Set<Group> findAllByType(GroupType _gt, QueryOptions queryOptions)
          this caches
 Set<Group> findAllByType(GroupType _gt, String scope)
           
 Group findByAlternateName(String name, boolean exceptionIfNotFound)
          Find a group by its alternate name only.
 Set<Group> findByApproximateDescriptionSecure(String description, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByApproximateDisplayExtensionSecure(String extension, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByApproximateDisplayNameSecure(String displayName, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByApproximateExtensionSecure(String extension, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByAttribute(String attr, String val)
          Deprecated. use overload
 Group findByAttribute(String attr, String val, boolean exceptionIfNotFound)
           
 Group findByAttribute(String attr, String val, boolean exceptionIfNotFound, boolean secureQuery)
           
 Set<Group> findByCreatorOrModifier(Member member)
          find groups by creator or modifier
 Group findByCurrentName(String name, boolean exceptionIfNotFound)
          Find a group by its current name only.
 Set<Group> findByDescriptionSecure(String description, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByDisplayExtensionSecure(String displayExtension, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByDisplayNameSecure(String displayName, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> findByExtensionSecure(String extension, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByIdIndex(Long idIndex, boolean exceptionIfNotFound)
           
 Group findByIdIndexSecure(Long idIndex, boolean exceptionIfNotFound, QueryOptions queryOptions)
          find a group by id index
 Group findByName(String name)
          Deprecated. use overload
 Group findByName(String name, boolean exceptionIfNotFound)
           
 Group findByName(String name, boolean exceptionIfNotFound, QueryOptions queryOptions)
           
 Group findByName(String name, boolean exceptionIfNotFound, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByNameSecure(String name, boolean exceptionIfNotFound, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByNameSecure(String name, boolean exceptionIfNotFound, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups, Set<Privilege> inPrivSet)
           
 Set<Group> findByNamesSecure(Collection<String> names, QueryOptions queryOptions)
           
 Set<Group> findByNamesSecure(Collection<String> names, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByUuid(String uuid)
          Deprecated. use overload
 Group findByUuid(String uuid, boolean exceptionIfNotFound)
           
 Group findByUuid(String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions)
           
 Group findByUuid(String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Group findByUuidOrName(String uuid, String name, boolean exceptionIfNull)
           
 Group findByUuidOrName(String uuid, String name, boolean exceptionIfNull, QueryOptions queryOptions)
           
 Set<Group> findByUuids(Collection<String> uuids, boolean exceptionOnNotFound)
          find all groups which have these uuids
 Group findByUuidSecure(String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
          find by uuid secure
 Set<Group> findByUuidsSecure(Collection<String> uuids, QueryOptions queryOptions)
          find by uuid secure
 Set<Group> findByUuidsSecure(Collection<String> uuids, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
          find by uuid secure
 Set<Group> findGroupsInStemWithoutPrivilege(GrouperSession grouperSession, String stemId, Stem.Scope scope, edu.internet2.middleware.subject.Subject subject, Privilege privilege, QueryOptions queryOptions, boolean considerAllSubject, String sqlLikeString)
          see which groups do not have this privilege
 Set<Group> getAllGroups()
           
 Set<Group> getAllGroups(String scope)
           
 Set<Group> getAllGroupsMembershipSecure(Field field, String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, QueryOptions queryOptions, Boolean enabled, MembershipType membershipType, Stem stem, Stem.Scope stemScope)
           
 Set<Group> getAllGroupsMembershipSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly)
           
 Set<Group> getAllGroupsMembershipSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly)
           
 Set<Group> getAllGroupsMembershipSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly, Stem stem, Stem.Scope stemScope)
           
 Set<Group> getAllGroupsSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions)
           
 Set<Group> getAllGroupsSecure(GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> getAllGroupsSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions)
           
 Set<Group> getAllGroupsSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
           
 Set<Group> getAllGroupsSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field)
          get all groups secure, split the scope by whitespace
 Set<Group> getAllGroupsSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field, String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName, edu.internet2.middleware.subject.Subject subjectNotInGroup, Collection<String> groupIds, Collection<String> groupNames, Boolean compositeOwner)
          get all groups secure, split the scope by whitespace
 Set<Group> getAllGroupsSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroup, boolean splitScope, edu.internet2.middleware.subject.Subject membershipSubject, Field field, String parentStemId, Stem.Scope stemScope, boolean findByUuidOrName, edu.internet2.middleware.subject.Subject subjectNotInGroup, Collection<String> groupIds, Collection<String> groupNames, Boolean compositeOwner, String idOfAttributeDefName, Object attributeValue)
          get all groups secure, split the scope by whitespace
 Set<Group> getAllGroupsSplitScopeSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
          get all groups secure, split the scope by whitespace
 Set<Group> getAllGroupsSplitScopeSecure(String scope, GrouperSession grouperSession, edu.internet2.middleware.subject.Subject subject, Set<Privilege> privileges, QueryOptions queryOptions, TypeOfGroup typeOfGroup)
          get all groups secure, split the scope by whitespace
 Set<Group> getImmediateChildren(Stem stem)
           
 Set<Group> getImmediateChildrenMembershipSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, boolean enabledOnly)
          get immediate children secure
 Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions)
          get immediate children secure
 Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession, Stem stem, edu.internet2.middleware.subject.Subject subject, Set<Privilege> inPrivSet, QueryOptions queryOptions, Set<TypeOfGroup> typeOfGroups)
          get immediate children secure
 void putInExistsCache(String uuid, boolean exists)
          put in cache
 void saveUpdateProperties(Group group)
          save the update properties which are auto saved when business method is called
 void update(Group _g)
           
 void updateLastImmediateMembershipChange(String groupId)
           
 void updateLastMembershipChange(String groupId)
           
 void updateLastMembershipChangeIncludeAncestorGroups(String groupId)
          This will update last_membership_change for group owners where group member in groupSet is the given groupId.
 

Method Detail

putInExistsCache

void putInExistsCache(String uuid,
                      boolean exists)
put in cache

Parameters:
uuid -
exists -

delete

void delete(Group _g)
            throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

exists

boolean exists(String uuid)
               throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByAnyApproximateAttr

Set<Group> findAllByAnyApproximateAttr(String val)
                                       throws GrouperDAOException,
                                              IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.2.0

findAllByAnyApproximateAttr

Set<Group> findAllByAnyApproximateAttr(String val,
                                       String scope)
                                       throws GrouperDAOException,
                                              IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.4.0

findAllByAnyApproximateAttr

Set<Group> findAllByAnyApproximateAttr(String val,
                                       String scope,
                                       boolean secureQuery)
                                       throws GrouperDAOException,
                                              IllegalStateException
Parameters:
val -
scope -
secureQuery -
Returns:
set
Throws:
GrouperDAOException
IllegalStateException

findAllByApproximateAttr

Set<Group> findAllByApproximateAttr(String attr,
                                    String val)
                                    throws GrouperDAOException,
                                           IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.2.0

findAllByApproximateAttr

Set<Group> findAllByApproximateAttr(String attr,
                                    String val,
                                    String scope)
                                    throws GrouperDAOException,
                                           IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.4.0

findAllByApproximateAttrSecure

Set<Group> findAllByApproximateAttrSecure(String attr,
                                          String val,
                                          String scope)
                                          throws GrouperDAOException,
                                                 IllegalStateException
Parameters:
attr - attribute name
val - value
scope - some folder or null for all
Returns:
the grops
Throws:
GrouperDAOException
IllegalStateException
Since:
2.0.2

findAllByAttr

Set<Group> findAllByAttr(String attr,
                         String val)
                         throws GrouperDAOException,
                                IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.3

findAllByAttr

Set<Group> findAllByAttr(String attr,
                         String val,
                         String scope)
                         throws GrouperDAOException,
                                IllegalStateException
Throws:
GrouperDAOException
IllegalStateException
Since:
1.4.0

findAllByAttr

Set<Group> findAllByAttr(String attr,
                         String val,
                         String scope,
                         boolean secureQuery)
                         throws GrouperDAOException,
                                IllegalStateException
Parameters:
attr -
val -
scope -
secureQuery -
Returns:
set
Throws:
GrouperDAOException
IllegalStateException

findAllByApproximateName

Set<Group> findAllByApproximateName(String name)
                                    throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByApproximateName

Set<Group> findAllByApproximateName(String name,
                                    String scope)
                                    throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findAllByApproximateNameSecure

Set<Group> findAllByApproximateNameSecure(String name,
                                          String scope,
                                          QueryOptions queryOptions)
                                          throws GrouperDAOException
Throws:
GrouperDAOException
Since:
2.1.0

findAllByCreatedAfter

Set<Group> findAllByCreatedAfter(Date d)
                                 throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByCreatedAfter

Set<Group> findAllByCreatedAfter(Date d,
                                 String scope)
                                 throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findAllByCreatedBefore

Set<Group> findAllByCreatedBefore(Date d)
                                  throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByCreatedBefore

Set<Group> findAllByCreatedBefore(Date d,
                                  String scope)
                                  throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findAllByModifiedAfter

Set<Group> findAllByModifiedAfter(Date d)
                                  throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByModifiedAfter

Set<Group> findAllByModifiedAfter(Date d,
                                  String scope)
                                  throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findAllByModifiedBefore

Set<Group> findAllByModifiedBefore(Date d)
                                   throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findAllByModifiedBefore

Set<Group> findAllByModifiedBefore(Date d,
                                   String scope)
                                   throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findAllByLastMembershipAfter

Set<Group> findAllByLastMembershipAfter(Date d)
                                        throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.5.0

findAllByLastMembershipAfter

Set<Group> findAllByLastMembershipAfter(Date d,
                                        String scope)
                                        throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.5.0

findAllByLastMembershipBefore

Set<Group> findAllByLastMembershipBefore(Date d)
                                         throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.5.0

findAllByLastMembershipBefore

Set<Group> findAllByLastMembershipBefore(Date d,
                                         String scope)
                                         throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.5.0

findAllByType

Set<Group> findAllByType(GroupType _gt)
                         throws GrouperDAOException
note, this doesnt cache

Throws:
GrouperDAOException
Since:
1.2.0

findAllByType

Set<Group> findAllByType(GroupType _gt,
                         QueryOptions queryOptions)
                         throws GrouperDAOException
this caches

Throws:
GrouperDAOException
Since:
1.2.0

findAllByType

Set<Group> findAllByType(GroupType _gt,
                         String scope)
                         throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

findByAttribute

@Deprecated
Group findByAttribute(String attr,
                                 String val)
                      throws GrouperDAOException,
                             GroupNotFoundException
Deprecated. use overload

Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByAttribute

Group findByAttribute(String attr,
                      String val,
                      boolean exceptionIfNotFound)
                      throws GrouperDAOException,
                             GroupNotFoundException
Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByAttribute

Group findByAttribute(String attr,
                      String val,
                      boolean exceptionIfNotFound,
                      boolean secureQuery)
                      throws GrouperDAOException,
                             GroupNotFoundException
Parameters:
attr -
val -
exceptionIfNotFound -
secureQuery -
Returns:
group
Throws:
GrouperDAOException
GroupNotFoundException

findByName

@Deprecated
Group findByName(String name)
                 throws GrouperDAOException,
                        GroupNotFoundException
Deprecated. use overload

Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByName

Group findByName(String name,
                 boolean exceptionIfNotFound)
                 throws GrouperDAOException,
                        GroupNotFoundException
Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByIdIndex

Group findByIdIndex(Long idIndex,
                    boolean exceptionIfNotFound)
                    throws GroupNotFoundException
Throws:
GroupNotFoundException
Since:
2.2

findByIdIndexSecure

Group findByIdIndexSecure(Long idIndex,
                          boolean exceptionIfNotFound,
                          QueryOptions queryOptions)
                          throws GroupNotFoundException
find a group by id index

Parameters:
idIndex - id index to find
exceptionIfNotFound - true if exception should be thrown if not found
queryOptions - query options
Returns:
the gorup or null or exception
Throws:
GroupNotFoundException

findByName

Group findByName(String name,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions)
                 throws GrouperDAOException,
                        GroupNotFoundException
Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByNameSecure

Group findByNameSecure(String name,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       Set<TypeOfGroup> typeOfGroups)
Since:
2.0.2

findByNameSecure

Group findByNameSecure(String name,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       Set<TypeOfGroup> typeOfGroups,
                       Set<Privilege> inPrivSet)
Since:
2.2.1

findByName

Group findByName(String name,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions,
                 Set<TypeOfGroup> typeOfGroups)
                 throws GrouperDAOException,
                        GroupNotFoundException
Throws:
GrouperDAOException
GroupNotFoundException
Since:
2.1.0

findByUuid

@Deprecated
Group findByUuid(String uuid)
                 throws GrouperDAOException,
                        GroupNotFoundException
Deprecated. use overload

Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.2.0

findByUuid

Group findByUuid(String uuid,
                 boolean exceptionIfNotFound)
                 throws GrouperDAOException,
                        GroupNotFoundException
Throws:
GrouperDAOException
GroupNotFoundException

findByUuid

Group findByUuid(String uuid,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions)
                 throws GrouperDAOException,
                        GroupNotFoundException
Parameters:
uuid -
exceptionIfNotFound -
queryOptions -
Returns:
the group or null or exception
Throws:
GrouperDAOException
GroupNotFoundException

findByUuidSecure

Group findByUuidSecure(String uuid,
                       boolean exceptionIfNotFound,
                       QueryOptions queryOptions,
                       Set<TypeOfGroup> typeOfGroups)
find by uuid secure

Parameters:
uuid -
exceptionIfNotFound -
queryOptions -
typeOfGroups -
Returns:
the group or null or exception
Throws:
GrouperDAOException
GroupNotFoundException

findByUuid

Group findByUuid(String uuid,
                 boolean exceptionIfNotFound,
                 QueryOptions queryOptions,
                 Set<TypeOfGroup> typeOfGroups)
                 throws GrouperDAOException,
                        GroupNotFoundException
Parameters:
uuid -
exceptionIfNotFound -
queryOptions -
typeOfGroups - to search in or null for all
Returns:
the group or null or exception
Throws:
GrouperDAOException
GroupNotFoundException

findByUuids

Set<Group> findByUuids(Collection<String> uuids,
                       boolean exceptionOnNotFound)
                       throws GroupNotFoundException
find all groups which have these uuids

Parameters:
uuids -
exceptionOnNotFound - if exception should be thrown when a uuid doesnt match up
Returns:
the groups
Throws:
GroupNotFoundException

getAllGroups

Set<Group> getAllGroups()
                        throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.3.1

getAllGroupsSecure

Set<Group> getAllGroupsSecure(GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> inPrivSet,
                              QueryOptions queryOptions)
                              throws GrouperDAOException
Parameters:
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
Returns:
groups
Throws:
GrouperDAOException

getAllGroupsSecure

Set<Group> getAllGroupsSecure(GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> inPrivSet,
                              QueryOptions queryOptions,
                              Set<TypeOfGroup> typeOfGroups)
                              throws GrouperDAOException
Parameters:
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
typeOfGroups - type of groups to return, or null for all
Returns:
groups
Throws:
GrouperDAOException

getAllGroupsSecure

Set<Group> getAllGroupsSecure(String scope,
                              GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> inPrivSet,
                              QueryOptions queryOptions)
                              throws GrouperDAOException
Parameters:
scope -
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
Returns:
the groups
Throws:
GrouperDAOException

getAllGroupsSecure

Set<Group> getAllGroupsSecure(String scope,
                              GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> inPrivSet,
                              QueryOptions queryOptions,
                              Set<TypeOfGroup> typeOfGroups)
                              throws GrouperDAOException
Parameters:
scope -
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
typeOfGroups - type of groups to return or null for all
Returns:
the groups
Throws:
GrouperDAOException

getImmediateChildrenSecure

Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession,
                                      Stem stem,
                                      edu.internet2.middleware.subject.Subject subject,
                                      Set<Privilege> inPrivSet,
                                      QueryOptions queryOptions)
                                      throws GrouperDAOException
get immediate children secure

Parameters:
grouperSession -
stem -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
Returns:
the set of groups
Throws:
GrouperDAOException

getImmediateChildrenSecure

Set<Group> getImmediateChildrenSecure(GrouperSession grouperSession,
                                      Stem stem,
                                      edu.internet2.middleware.subject.Subject subject,
                                      Set<Privilege> inPrivSet,
                                      QueryOptions queryOptions,
                                      Set<TypeOfGroup> typeOfGroups)
                                      throws GrouperDAOException
get immediate children secure

Parameters:
grouperSession -
stem -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
typeOfGroups - type of groups to return, or null for all
Returns:
the set of groups
Throws:
GrouperDAOException

getImmediateChildrenMembershipSecure

Set<Group> getImmediateChildrenMembershipSecure(GrouperSession grouperSession,
                                                Stem stem,
                                                edu.internet2.middleware.subject.Subject subject,
                                                Set<Privilege> inPrivSet,
                                                QueryOptions queryOptions,
                                                boolean enabledOnly)
                                                throws GrouperDAOException
get immediate children secure

Parameters:
grouperSession -
stem -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
enabledOnly -
Returns:
the set of groups
Throws:
GrouperDAOException

getAllGroups

Set<Group> getAllGroups(String scope)
                        throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

getImmediateChildren

Set<Group> getImmediateChildren(Stem stem)
                                throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.4.0

update

void update(Group _g)
            throws GrouperDAOException
Throws:
GrouperDAOException
Since:
1.2.0

findByCreatorOrModifier

Set<Group> findByCreatorOrModifier(Member member)
find groups by creator or modifier

Parameters:
member -
Returns:
the groups

findAllByApproximateNameSecure

Set<Group> findAllByApproximateNameSecure(String name,
                                          String scope,
                                          QueryOptions queryOptions,
                                          Set<TypeOfGroup> typeOfGroups)
                                          throws GrouperDAOException
Parameters:
name -
scope -
queryOptions -
typeOfGroups -
Returns:
the set of groups
Throws:
GrouperDAOException
Since:
2.1.0

findByAlternateName

Group findByAlternateName(String name,
                          boolean exceptionIfNotFound)
                          throws GrouperDAOException,
                                 GroupNotFoundException
Find a group by its alternate name only.

Parameters:
name -
exceptionIfNotFound -
Returns:
group
Throws:
GrouperDAOException
GroupNotFoundException

findByCurrentName

Group findByCurrentName(String name,
                        boolean exceptionIfNotFound)
                        throws GrouperDAOException,
                               GroupNotFoundException
Find a group by its current name only.

Parameters:
name -
exceptionIfNotFound -
Returns:
group
Throws:
GrouperDAOException
GroupNotFoundException

findAllByApproximateCurrentName

Set<Group> findAllByApproximateCurrentName(String name)
                                           throws GrouperDAOException
Find groups using an approximate string for the current name, display name, extension, display extension.

Parameters:
name -
Returns:
set
Throws:
GrouperDAOException

findAllByApproximateCurrentName

Set<Group> findAllByApproximateCurrentName(String name,
                                           String scope)
                                           throws GrouperDAOException
Find groups using an approximate string for the current name, display name, extension, display extension.

Parameters:
name -
scope -
Returns:
set
Throws:
GrouperDAOException

findAllByApproximateAlternateName

Set<Group> findAllByApproximateAlternateName(String name)
                                             throws GrouperDAOException
Find groups using an approximate string for the alternate name.

Parameters:
name -
Returns:
set
Throws:
GrouperDAOException

findAllByApproximateAlternateName

Set<Group> findAllByApproximateAlternateName(String name,
                                             String scope)
                                             throws GrouperDAOException
Find groups using an approximate string for the alternate name.

Parameters:
name -
scope -
Returns:
set
Throws:
GrouperDAOException

getAllGroupsMembershipSecure

Set<Group> getAllGroupsMembershipSecure(GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions,
                                        boolean enabledOnly)
                                        throws GrouperDAOException
Parameters:
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
enabledOnly -
Returns:
groups
Throws:
GrouperDAOException

getAllGroupsMembershipSecure

Set<Group> getAllGroupsMembershipSecure(String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions,
                                        boolean enabledOnly)
                                        throws GrouperDAOException
Parameters:
scope -
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
enabledOnly -
Returns:
the groups
Throws:
GrouperDAOException

getAllGroupsMembershipSecure

Set<Group> getAllGroupsMembershipSecure(String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        Set<Privilege> inPrivSet,
                                        QueryOptions queryOptions,
                                        boolean enabledOnly,
                                        Stem stem,
                                        Stem.Scope stemScope)
                                        throws GrouperDAOException
Parameters:
scope -
stemScope -
grouperSession -
subject -
queryOptions -
inPrivSet - means that each row must have a matching priv in this set to user or GrouperAll. There are some constants in AccessPrivilege of pre-canned sets
enabledOnly -
stem -
Returns:
the groups
Throws:
GrouperDAOException

getAllGroupsMembershipSecure

Set<Group> getAllGroupsMembershipSecure(Field field,
                                        String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        QueryOptions queryOptions,
                                        Boolean enabled,
                                        MembershipType membershipType,
                                        Stem stem,
                                        Stem.Scope stemScope)
                                        throws GrouperDAOException
Parameters:
field -
scope -
grouperSession -
subject -
queryOptions - if sorting on name, displayName, extension, displayExtension
enabled - null for all, True for enabledOnly, False for disabledOnly
membershipType - immediate, effective, etc
stem - if searching in a specific stem
stemScope - sub or one
Returns:
the groups
Throws:
GrouperDAOException

updateLastMembershipChange

void updateLastMembershipChange(String groupId)
Parameters:
groupId -

updateLastImmediateMembershipChange

void updateLastImmediateMembershipChange(String groupId)
Parameters:
groupId -

updateLastMembershipChangeIncludeAncestorGroups

void updateLastMembershipChangeIncludeAncestorGroups(String groupId)
This will update last_membership_change for group owners where group member in groupSet is the given groupId.

Parameters:
groupId -

findByUuidOrName

Group findByUuidOrName(String uuid,
                       String name,
                       boolean exceptionIfNull)
                       throws GrouperDAOException,
                              GroupNotFoundException
Parameters:
uuid -
name -
exceptionIfNull -
Returns:
the stem or null
Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.6.0

findByUuidOrName

Group findByUuidOrName(String uuid,
                       String name,
                       boolean exceptionIfNull,
                       QueryOptions queryOptions)
                       throws GrouperDAOException,
                              GroupNotFoundException
Parameters:
uuid -
name -
exceptionIfNull -
queryOptions -
Returns:
the stem or null
Throws:
GrouperDAOException
GroupNotFoundException
Since:
1.6.0

saveUpdateProperties

void saveUpdateProperties(Group group)
save the update properties which are auto saved when business method is called

Parameters:
group -

findGroupsInStemWithoutPrivilege

Set<Group> findGroupsInStemWithoutPrivilege(GrouperSession grouperSession,
                                            String stemId,
                                            Stem.Scope scope,
                                            edu.internet2.middleware.subject.Subject subject,
                                            Privilege privilege,
                                            QueryOptions queryOptions,
                                            boolean considerAllSubject,
                                            String sqlLikeString)
see which groups do not have this privilege

Parameters:
grouperSession -
stemId -
scope -
subject -
privilege -
queryOptions -
considerAllSubject -
sqlLikeString -
Returns:
the groups

getAllGroupsSplitScopeSecure

Set<Group> getAllGroupsSplitScopeSecure(String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        Set<Privilege> privileges,
                                        QueryOptions queryOptions,
                                        TypeOfGroup typeOfGroup)
get all groups secure, split the scope by whitespace

Parameters:
scope -
grouperSession -
subject -
privileges -
queryOptions -
typeOfGroup - or null for all
Returns:
set of group

getAllGroupsSecure

Set<Group> getAllGroupsSecure(String scope,
                              GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> privileges,
                              QueryOptions queryOptions,
                              Set<TypeOfGroup> typeOfGroup,
                              boolean splitScope,
                              edu.internet2.middleware.subject.Subject membershipSubject,
                              Field field)
get all groups secure, split the scope by whitespace

Parameters:
scope -
grouperSession -
subject -
privileges -
queryOptions -
typeOfGroup - or null for all
splitScope -
field -
Returns:
set of group

getAllGroupsSecure

Set<Group> getAllGroupsSecure(String scope,
                              GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> privileges,
                              QueryOptions queryOptions,
                              Set<TypeOfGroup> typeOfGroup,
                              boolean splitScope,
                              edu.internet2.middleware.subject.Subject membershipSubject,
                              Field field,
                              String parentStemId,
                              Stem.Scope stemScope,
                              boolean findByUuidOrName,
                              edu.internet2.middleware.subject.Subject subjectNotInGroup,
                              Collection<String> groupIds,
                              Collection<String> groupNames,
                              Boolean compositeOwner)
get all groups secure, split the scope by whitespace

Parameters:
scope -
grouperSession -
subject -
privileges -
queryOptions -
typeOfGroup - or null for all
splitScope -
membershipSubject -
field -
parentStemId -
stemScope -
findByUuidOrName -
subjectNotInGroup - is a subject which does not have a membership in the group
groupIds - are the group ids to search for
groupNames - are the group names to search for
compositeOwner - if we are filtering for groups which are or are not composite owners
Returns:
set of group
Since:
v2.2

getAllGroupsSecure

Set<Group> getAllGroupsSecure(String scope,
                              GrouperSession grouperSession,
                              edu.internet2.middleware.subject.Subject subject,
                              Set<Privilege> privileges,
                              QueryOptions queryOptions,
                              Set<TypeOfGroup> typeOfGroup,
                              boolean splitScope,
                              edu.internet2.middleware.subject.Subject membershipSubject,
                              Field field,
                              String parentStemId,
                              Stem.Scope stemScope,
                              boolean findByUuidOrName,
                              edu.internet2.middleware.subject.Subject subjectNotInGroup,
                              Collection<String> groupIds,
                              Collection<String> groupNames,
                              Boolean compositeOwner,
                              String idOfAttributeDefName,
                              Object attributeValue)
get all groups secure, split the scope by whitespace

Parameters:
scope -
grouperSession -
subject -
privileges -
queryOptions -
typeOfGroup - or null for all
splitScope -
membershipSubject -
field -
parentStemId -
stemScope -
findByUuidOrName -
subjectNotInGroup - is a subject which does not have a membership in the group
groupIds - are the group ids to search for
groupNames - are the group names to search for
compositeOwner - if we are filtering for groups which are or are not composite owners
idOfAttributeDefName - if looking for groups that have this attribute def name
attributeValue - if looking for groups that have this attribute value on the attribute def name
Returns:
set of group
Since:
v2.2.1

findByUuidsSecure

Set<Group> findByUuidsSecure(Collection<String> uuids,
                             QueryOptions queryOptions)
find by uuid secure

Parameters:
uuids -
exceptionIfNotFound -
queryOptions -
Returns:
the group or null or exception
Throws:
GrouperDAOException
GroupNotFoundException

findByUuidsSecure

Set<Group> findByUuidsSecure(Collection<String> uuids,
                             QueryOptions queryOptions,
                             Set<TypeOfGroup> typeOfGroups)
find by uuid secure

Parameters:
uuids -
exceptionIfNotFound -
queryOptions -
typeOfGroups -
Returns:
the group or null or exception
Throws:
GrouperDAOException
GroupNotFoundException

findByNamesSecure

Set<Group> findByNamesSecure(Collection<String> names,
                             QueryOptions queryOptions)
Parameters:
names -
queryOptions -
Since:
2.0.2

findByNamesSecure

Set<Group> findByNamesSecure(Collection<String> names,
                             QueryOptions queryOptions,
                             Set<TypeOfGroup> typeOfGroups)
Parameters:
names -
queryOptions -
typeOfGroups -
Since:
2.1.0

getAllGroupsSplitScopeSecure

Set<Group> getAllGroupsSplitScopeSecure(String scope,
                                        GrouperSession grouperSession,
                                        edu.internet2.middleware.subject.Subject subject,
                                        Set<Privilege> privileges,
                                        QueryOptions queryOptions,
                                        Set<TypeOfGroup> typeOfGroups)
get all groups secure, split the scope by whitespace

Parameters:
scope -
grouperSession -
subject -
privileges -
queryOptions -
typeOfGroups - or null for all
Returns:
set of group

findByApproximateDescriptionSecure

Set<Group> findByApproximateDescriptionSecure(String description,
                                              QueryOptions queryOptions,
                                              Set<TypeOfGroup> typeOfGroups)

findByDescriptionSecure

Set<Group> findByDescriptionSecure(String description,
                                   QueryOptions queryOptions,
                                   Set<TypeOfGroup> typeOfGroups)

findByDisplayNameSecure

Set<Group> findByDisplayNameSecure(String displayName,
                                   QueryOptions queryOptions,
                                   Set<TypeOfGroup> typeOfGroups)

findByApproximateDisplayNameSecure

Set<Group> findByApproximateDisplayNameSecure(String displayName,
                                              QueryOptions queryOptions,
                                              Set<TypeOfGroup> typeOfGroups)

findByExtensionSecure

Set<Group> findByExtensionSecure(String extension,
                                 QueryOptions queryOptions,
                                 Set<TypeOfGroup> typeOfGroups)

findByApproximateExtensionSecure

Set<Group> findByApproximateExtensionSecure(String extension,
                                            QueryOptions queryOptions,
                                            Set<TypeOfGroup> typeOfGroups)

findByDisplayExtensionSecure

Set<Group> findByDisplayExtensionSecure(String displayExtension,
                                        QueryOptions queryOptions,
                                        Set<TypeOfGroup> typeOfGroups)

findByApproximateDisplayExtensionSecure

Set<Group> findByApproximateDisplayExtensionSecure(String extension,
                                                   QueryOptions queryOptions,
                                                   Set<TypeOfGroup> typeOfGroups)