edu.internet2.middleware.grouper.subj
Interface SubjectCustomizer

All Known Implementing Classes:

SubjectCustomizerBase, SubjectCustomizerForDecoratorExtraAttributes, SubjectCustomizerForDecoratorTestingCollabGroup, SubjectCustomizerForDecoratorTestingHideStudentData, SubjectCustomizerForDecoratorUiDisplay

public interface SubjectCustomizer

add the ability to decorate a list of subjects with more attributes. note, while you are decorating, you can check security to see if the groupersession is allowed to see those attributes

Author:

mchyzer

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

Method Detail

decorateSubjects

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

Parameters:

grouperSession -

subjects -

attributeNamesRequested -

Returns:

the subjects if same set, or make a new set

filterSubjects

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

Parameters:

grouperSession -

subjects -

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