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

Method Detail

decorateSubjects

Set<edu.internet2.middleware.subject.Subject> decorateSubjects(GrouperSession grouperSession,
                                                               Set<edu.internet2.middleware.subject.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<edu.internet2.middleware.subject.Subject> filterSubjects(GrouperSession grouperSession,
                                                             Set<edu.internet2.middleware.subject.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