edu.internet2.middleware.grouper

Class CompositeFinder

java.lang.Object

edu.internet2.middleware.grouper.CompositeFinder

public class CompositeFinder
extends Object

Use this class to find a composite

Sample call

 Composite c = CompositeFinder.findAsOwner(group, true)
 

Constructor Summary

Constructors

Constructor and Description
CompositeFinder()

Method Summary

Modifier and Type	Method and Description
CompositeFinder	assignParentStemId(String parentStemId1)
CompositeFinder	assignPrivileges(Set<Privilege> theGroups) assign privileges to filter by that the subject has on the owner group
CompositeFinder	assignStemScope(Stem.Scope theScope)
CompositeFinder	assignSubject(Subject theSubject) this is the subject that has certain memberships in the query on owner group
static Set<Composite>	findAsFactor(Group g) Find where the specified Group is a Composite factor.
static Composite	findAsOwner(Group g) Deprecated. use findAsOwner(Group, boolean) instead.
static Composite	findAsOwner(Group g, boolean throwExceptionIfNotFound) Find Composite owned by this Group.
Set<Composite>	findComposites() find composites

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompositeFinder

public CompositeFinder()

Method Detail

assignParentStemId

public CompositeFinder assignParentStemId(String parentStemId1)

Parameters:

parentStemId1 -

Returns:

this for chaining

assignStemScope

public CompositeFinder assignStemScope(Stem.Scope theScope)

Parameters:

theScope -

Returns:

this for chaining

findComposites

public Set<Composite> findComposites()

find composites

Returns:

composites

assignPrivileges

public CompositeFinder assignPrivileges(Set<Privilege> theGroups)

assign privileges to filter by that the subject has on the owner group

Parameters:

theGroups -

Returns:

this for chaining

assignSubject

public CompositeFinder assignSubject(Subject theSubject)

this is the subject that has certain memberships in the query on owner group

Parameters:

theSubject -

Returns:

this for chaining

findAsFactor

public static Set<Composite> findAsFactor(Group g)

Find where the specified Group is a Composite factor.

 Set composites = CompositeFinder.findAsFactor(g);
 

Parameters:

g - Search on this Group.

Returns:

A set of Composite objects.

Since:

1.0

findAsOwner

@Deprecated
public static Composite findAsOwner(Group g)
                                         throws CompositeNotFoundException,
                                                GroupNotFoundException

Deprecated. use findAsOwner(Group, boolean) instead.

Find Composite owned by this Group.

 Composite c = CompositeFinder.findAsOwner(g);
 

Parameters:

g - Search on this Group.

Returns:

c Composite owned by this Group.

Throws:

CompositeNotFoundException

GroupNotFoundException

Since:

1.0

findAsOwner

public static Composite findAsOwner(Group g,
                                    boolean throwExceptionIfNotFound)
                             throws CompositeNotFoundException,
                                    GroupNotFoundException

Find Composite owned by this Group.

 Composite c = CompositeFinder.findAsOwner(g, false);
 

Parameters:

g - Search on this Group.

throwExceptionIfNotFound - true to throw exception if not found

Returns:

c Composite owned by this Group.

Throws:

CompositeNotFoundException - if throwExceptionIfNotFound is true, and composite is not found

GroupNotFoundException - if the group owner of composite cant be found (this is a problem)

Since:

1.0