edu.internet2.middleware.grouper.subj
Class SubjectCustomizerBase

java.lang.Object
  edu.internet2.middleware.grouper.subj.SubjectCustomizerBase

All Implemented Interfaces:

SubjectCustomizer

Direct Known Subclasses:

SubjectCustomizerForDecoratorExtraAttributes, SubjectCustomizerForDecoratorTestingCollabGroup, SubjectCustomizerForDecoratorTestingHideStudentData, SubjectCustomizerForDecoratorUiDisplay

public abstract class SubjectCustomizerBase
extends java.lang.Object
implements SubjectCustomizer

extend this to do a subject customizer

Author:

mchyzer

Constructor Summary

SubjectCustomizerBase()

Method Summary

java.util.Set<edu.internet2.middleware.subject.Subject>	decorateSubjects(GrouperSession grouperSession, java.util.Set<edu.internet2.middleware.subject.Subject> subjects, java.util.Collection<java.lang.String> attributeNamesRequested) decorate subjects based on attributes requested
java.util.Set<edu.internet2.middleware.subject.Subject>	filterSubjects(GrouperSession grouperSession, java.util.Set<edu.internet2.middleware.subject.Subject> subjects, java.lang.String findSubjectsInStemName) you can edit the subjects (or replace), but you shouldnt remove them

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectCustomizerBase

public SubjectCustomizerBase()

Method Detail

decorateSubjects

public java.util.Set<edu.internet2.middleware.subject.Subject> decorateSubjects(GrouperSession grouperSession,
                                                                                java.util.Set<edu.internet2.middleware.subject.Subject> subjects,
                                                                                java.util.Collection<java.lang.String> attributeNamesRequested)

Description copied from interface: SubjectCustomizer

decorate subjects based on attributes requested

Specified by:

decorateSubjects in interface SubjectCustomizer

Returns:

the subjects if same set, or make a new set

See Also:

SubjectCustomizer#decorateSubjects(GrouperSession, Collection, Collection)

filterSubjects

public java.util.Set<edu.internet2.middleware.subject.Subject> filterSubjects(GrouperSession grouperSession,
                                                                              java.util.Set<edu.internet2.middleware.subject.Subject> subjects,
                                                                              java.lang.String findSubjectsInStemName)

Description copied from interface: SubjectCustomizer

you can edit the subjects (or replace), but you shouldnt remove them

Specified by:

filterSubjects in interface SubjectCustomizer

findSubjectsInStemName - if this is a findSubjectsInStem call, this is the stem name. This is useful to filter when searching for subjects to add to a certain group

Returns:

the subjects if same set, or make a new set

See Also:

SubjectCustomizer#filterSubjects(GrouperSession, Collection, String)