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

Method Summary

Modifier and Type	Method and Description
Set<Subject>	decorateSubjects(GrouperSession grouperSession, Set<Subject> subjects, Collection<String> attributeNamesRequested) decorate subjects based on attributes requested
Set<Subject>	filterSubjects(GrouperSession grouperSession, Set<Subject> subjects, String findSubjectsInStemName) you can edit the subjects (or replace), but you shouldnt remove them

Method Detail

decorateSubjects

Set<Subject> decorateSubjects(GrouperSession grouperSession,
                              Set<Subject> subjects,
                              Collection<String> attributeNamesRequested)

decorate subjects based on attributes requested

Parameters:

grouperSession -

subjects -

attributeNamesRequested -

Returns:

the subjects if same set, or make a new set

filterSubjects

Set<Subject> filterSubjects(GrouperSession grouperSession,
                            Set<Subject> subjects,
                            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