Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

edu.internet2.middleware.grouper.userData
Class GrouperUserDataApi

java.lang.Object
  extended by edu.internet2.middleware.grouper.userData.GrouperUserDataApi

public class GrouperUserDataApi
extends Object

api for grouper user data

Author:
mchyzer

Field Summary
static int MAX_USER_DATA_OBJECTS
          this is the max user data objects in json to fit in a 4k field
 
Constructor Summary
GrouperUserDataApi()
           
 
Method Summary
static void favoriteAttributeDefAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDef attributeDef)
           
static void favoriteAttributeDefNameAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDefName attributeDefName)
           
static void favoriteAttributeDefNameRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDefName attributeDefName)
           
static Set<AttributeDefName> favoriteAttributeDefNames(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void favoriteAttributeDefRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDef attributeDef)
           
static Set<AttributeDef> favoriteAttributeDefs(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void favoriteGroupAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Group group)
           
static void favoriteGroupRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Group group)
           
static Set<Group> favoriteGroups(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void favoriteMemberAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Member member)
           
static void favoriteMemberAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, edu.internet2.middleware.subject.Subject subjectThatIsFavorite)
           
static void favoriteMemberRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Member member)
           
static void favoriteMemberRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToRemoveFrom, edu.internet2.middleware.subject.Subject subjectThatIsFavorite)
           
static Set<Member> favoriteMembers(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void favoriteStemAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Stem stem)
           
static void favoriteStemRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Stem stem)
           
static Set<Stem> favoriteStems(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void main(String[] args)
           
static
<T> T
preferences(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Class<T> preferencesClass)
           
static void preferencesAssign(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Object preferences)
           
static void recentlyUsedAttributeDefAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDef attributeDef)
           
static void recentlyUsedAttributeDefNameAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDefName attributeDefName)
           
static void recentlyUsedAttributeDefNameRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDefName attributeDefName)
           
static Set<AttributeDefName> recentlyUsedAttributeDefNames(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void recentlyUsedAttributeDefRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, AttributeDef attributeDef)
           
static Set<AttributeDef> recentlyUsedAttributeDefs(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void recentlyUsedGroupAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Group group)
           
static void recentlyUsedGroupRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Group group)
           
static Set<Group> recentlyUsedGroups(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void recentlyUsedMemberAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Member member)
           
static void recentlyUsedMemberAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, edu.internet2.middleware.subject.Subject subjectThatIsRecentlyUsed)
           
static void recentlyUsedMemberRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Member member)
           
static void recentlyUsedMemberRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToRemoveFrom, edu.internet2.middleware.subject.Subject subjectThatIsRecentlyUsed)
           
static Set<Member> recentlyUsedMembers(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
static void recentlyUsedStemAdd(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Stem stem)
           
static void recentlyUsedStemRemove(String userDataGroupName, edu.internet2.middleware.subject.Subject subjectToAddTo, Stem stem)
           
static Set<Stem> recentlyUsedStems(String userDataGroupName, edu.internet2.middleware.subject.Subject subject)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX_USER_DATA_OBJECTS

public static final int MAX_USER_DATA_OBJECTS
this is the max user data objects in json to fit in a 4k field

See Also:
Constant Field Values
Constructor Detail

GrouperUserDataApi

public GrouperUserDataApi()
Method Detail

main

public static void main(String[] args)
Parameters:
args -

favoriteGroupAdd

public static void favoriteGroupAdd(String userDataGroupName,
                                    edu.internet2.middleware.subject.Subject subjectToAddTo,
                                    Group group)
Parameters:
subjectToAddTo -
userDataGroupName -
group -

favoriteGroupRemove

public static void favoriteGroupRemove(String userDataGroupName,
                                       edu.internet2.middleware.subject.Subject subjectToAddTo,
                                       Group group)
Parameters:
subjectToAddTo -
userDataGroupName -
group -

favoriteGroups

public static Set<Group> favoriteGroups(String userDataGroupName,
                                        edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite groups for a user

recentlyUsedGroupAdd

public static void recentlyUsedGroupAdd(String userDataGroupName,
                                        edu.internet2.middleware.subject.Subject subjectToAddTo,
                                        Group group)
Parameters:
subjectToAddTo -
userDataGroupName -
group -

recentlyUsedGroups

public static Set<Group> recentlyUsedGroups(String userDataGroupName,
                                            edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the recently used groups for a user

recentlyUsedGroupRemove

public static void recentlyUsedGroupRemove(String userDataGroupName,
                                           edu.internet2.middleware.subject.Subject subjectToAddTo,
                                           Group group)
Parameters:
subjectToAddTo -
userDataGroupName -
group -

favoriteAttributeDefAdd

public static void favoriteAttributeDefAdd(String userDataGroupName,
                                           edu.internet2.middleware.subject.Subject subjectToAddTo,
                                           AttributeDef attributeDef)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDef -

favoriteAttributeDefRemove

public static void favoriteAttributeDefRemove(String userDataGroupName,
                                              edu.internet2.middleware.subject.Subject subjectToAddTo,
                                              AttributeDef attributeDef)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDef -

favoriteAttributeDefs

public static Set<AttributeDef> favoriteAttributeDefs(String userDataGroupName,
                                                      edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite attributeDefs for a user

favoriteAttributeDefNameAdd

public static void favoriteAttributeDefNameAdd(String userDataGroupName,
                                               edu.internet2.middleware.subject.Subject subjectToAddTo,
                                               AttributeDefName attributeDefName)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDefName -

favoriteAttributeDefNameRemove

public static void favoriteAttributeDefNameRemove(String userDataGroupName,
                                                  edu.internet2.middleware.subject.Subject subjectToAddTo,
                                                  AttributeDefName attributeDefName)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDefName -

favoriteAttributeDefNames

public static Set<AttributeDefName> favoriteAttributeDefNames(String userDataGroupName,
                                                              edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite attributeDefNames for a user

favoriteStemAdd

public static void favoriteStemAdd(String userDataGroupName,
                                   edu.internet2.middleware.subject.Subject subjectToAddTo,
                                   Stem stem)
Parameters:
subjectToAddTo -
userDataGroupName -
stem -

preferencesAssign

public static void preferencesAssign(String userDataGroupName,
                                     edu.internet2.middleware.subject.Subject subjectToAddTo,
                                     Object preferences)
Parameters:
subjectToAddTo -
userDataGroupName -
preferences -

preferences

public static <T> T preferences(String userDataGroupName,
                                edu.internet2.middleware.subject.Subject subjectToAddTo,
                                Class<T> preferencesClass)
Parameters:
subjectToAddTo -
userDataGroupName -
preferences -

favoriteStemRemove

public static void favoriteStemRemove(String userDataGroupName,
                                      edu.internet2.middleware.subject.Subject subjectToAddTo,
                                      Stem stem)
Parameters:
subjectToAddTo -
userDataGroupName -
stem -

favoriteStems

public static Set<Stem> favoriteStems(String userDataGroupName,
                                      edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite stems for a user

favoriteMemberRemove

public static void favoriteMemberRemove(String userDataGroupName,
                                        edu.internet2.middleware.subject.Subject subjectToRemoveFrom,
                                        edu.internet2.middleware.subject.Subject subjectThatIsFavorite)
Parameters:
subjectToRemoveFrom -
userDataGroupName -
subjectThatIsFavorite -

favoriteMemberAdd

public static void favoriteMemberAdd(String userDataGroupName,
                                     edu.internet2.middleware.subject.Subject subjectToAddTo,
                                     edu.internet2.middleware.subject.Subject subjectThatIsFavorite)
Parameters:
subjectToAddTo -
userDataGroupName -
subjectThatIsFavorite -

recentlyUsedMemberAdd

public static void recentlyUsedMemberAdd(String userDataGroupName,
                                         edu.internet2.middleware.subject.Subject subjectToAddTo,
                                         edu.internet2.middleware.subject.Subject subjectThatIsRecentlyUsed)
Parameters:
subjectToAddTo -
userDataGroupName -
subjectThatIsRecentlyUsed -

favoriteMemberAdd

public static void favoriteMemberAdd(String userDataGroupName,
                                     edu.internet2.middleware.subject.Subject subjectToAddTo,
                                     Member member)
Parameters:
subjectToAddTo -
userDataGroupName -
member -

favoriteMemberRemove

public static void favoriteMemberRemove(String userDataGroupName,
                                        edu.internet2.middleware.subject.Subject subjectToAddTo,
                                        Member member)
Parameters:
subjectToAddTo -
userDataGroupName -
member -

favoriteMembers

public static Set<Member> favoriteMembers(String userDataGroupName,
                                          edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite members for a user

recentlyUsedStemAdd

public static void recentlyUsedStemAdd(String userDataGroupName,
                                       edu.internet2.middleware.subject.Subject subjectToAddTo,
                                       Stem stem)
Parameters:
subjectToAddTo -
userDataGroupName -
stem -

recentlyUsedStemRemove

public static void recentlyUsedStemRemove(String userDataGroupName,
                                          edu.internet2.middleware.subject.Subject subjectToAddTo,
                                          Stem stem)
Parameters:
subjectToAddTo -
userDataGroupName -
stem -

recentlyUsedStems

public static Set<Stem> recentlyUsedStems(String userDataGroupName,
                                          edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the recently used stems for a user

recentlyUsedAttributeDefAdd

public static void recentlyUsedAttributeDefAdd(String userDataGroupName,
                                               edu.internet2.middleware.subject.Subject subjectToAddTo,
                                               AttributeDef attributeDef)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDef -

recentlyUsedAttributeDefRemove

public static void recentlyUsedAttributeDefRemove(String userDataGroupName,
                                                  edu.internet2.middleware.subject.Subject subjectToAddTo,
                                                  AttributeDef attributeDef)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDef -

recentlyUsedAttributeDefs

public static Set<AttributeDef> recentlyUsedAttributeDefs(String userDataGroupName,
                                                          edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite attributeDefs for a user

recentlyUsedAttributeDefNameAdd

public static void recentlyUsedAttributeDefNameAdd(String userDataGroupName,
                                                   edu.internet2.middleware.subject.Subject subjectToAddTo,
                                                   AttributeDefName attributeDefName)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDefName -

recentlyUsedAttributeDefNameRemove

public static void recentlyUsedAttributeDefNameRemove(String userDataGroupName,
                                                      edu.internet2.middleware.subject.Subject subjectToAddTo,
                                                      AttributeDefName attributeDefName)
Parameters:
subjectToAddTo -
userDataGroupName -
attributeDefName -

recentlyUsedAttributeDefNames

public static Set<AttributeDefName> recentlyUsedAttributeDefNames(String userDataGroupName,
                                                                  edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the recent attributeDefNames for a user

recentlyUsedMemberAdd

public static void recentlyUsedMemberAdd(String userDataGroupName,
                                         edu.internet2.middleware.subject.Subject subjectToAddTo,
                                         Member member)
Parameters:
subjectToAddTo -
userDataGroupName -
member -

recentlyUsedMemberRemove

public static void recentlyUsedMemberRemove(String userDataGroupName,
                                            edu.internet2.middleware.subject.Subject subjectToAddTo,
                                            Member member)
Parameters:
subjectToAddTo -
userDataGroupName -
member -

recentlyUsedMembers

public static Set<Member> recentlyUsedMembers(String userDataGroupName,
                                              edu.internet2.middleware.subject.Subject subject)
Parameters:
subject -
userDataGroupName -
Returns:
the favorite members for a user

recentlyUsedMemberRemove

public static void recentlyUsedMemberRemove(String userDataGroupName,
                                            edu.internet2.middleware.subject.Subject subjectToRemoveFrom,
                                            edu.internet2.middleware.subject.Subject subjectThatIsRecentlyUsed)
Parameters:
subjectToRemoveFrom -
userDataGroupName -
subjectThatIsRecentlyUsed -
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD