Package edu.internet2.middleware.grouper.ws.coresoap

Class WsGroupLookup

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsGroupLookup
All Implemented Interfaces:
GrouperWsToStringCompact
public class WsGroupLookup extends Object implements GrouperWsToStringCompact
 Class to lookup a group via web service
 
 developers make sure each setter calls this.clearGroup();

  • Constructor Details

    • WsGroupLookup

      public WsGroupLookup(WsGroup wsGroup)
      Parameters:
      wsGroup -

    • WsGroupLookup

      public WsGroupLookup()

    • WsGroupLookup

      public WsGroupLookup(String groupName1, String uuid1)
      Parameters:
      groupName1 -
      uuid1 -

    • WsGroupLookup

      public WsGroupLookup(String groupName1, String uuid1, String idIndex1)
      Parameters:
      groupName1 -
      uuid1 -
      idIndex1 -

  • Method Details

    • getIdIndex

      public String getIdIndex()
      integer ID for object
      Returns:
      the id

    • setIdIndex

      public void setIdIndex(String idIndex1)
      integer ID for object
      Parameters:
      idIndex1 -

    • convertToGroupIds

      public static Set<String> convertToGroupIds(GrouperSession grouperSession, WsGroupLookup[] wsGroupLookups, StringBuilder errorMessage, TypeOfGroup typeOfGroup, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      convert group lookups to group ids
      Parameters:
      grouperSession -
      wsGroupLookups -
      errorMessage -
      typeOfGroup -
      usePIT -
      pointInTimeFrom -
      pointInTimeTo -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the group ids

    • convertToGroupIds

      public static Set<String> convertToGroupIds(GrouperSession grouperSession, WsGroupLookup[] wsGroupLookups, StringBuilder errorMessage, TypeOfGroup typeOfGroup, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, int[] lookupCount)
      convert group lookups to group ids
      Parameters:
      grouperSession -
      wsGroupLookups -
      errorMessage -
      typeOfGroup -
      usePIT -
      pointInTimeFrom -
      pointInTimeTo -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the group ids

    • blank

      public boolean blank()
      see if blank
      Returns:
      true if blank

    • hasData

      public boolean hasData()
      see if this group lookup has data
      Returns:
      true if it has data

    • retrieveGroup

      public Group retrieveGroup()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the group

    • retrievePITGroups

      public Set<PITGroup> retrievePITGroups()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the pit groups

    • retrieveGroupFindResult

      public WsGroupLookup.GroupFindResult retrieveGroupFindResult()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the groupFindResult, this is never null

    • toString

      public String toString()
      make sure this is an explicit toString
      Overrides:
      toString in class Object

    • toStringCompact

      public String toStringCompact()
      make sure this is an explicit toString
      Specified by:
      toStringCompact in interface GrouperWsToStringCompact
      Returns:
      return a compact to string

    • retrieveGroupIfNeeded

      public void retrieveGroupIfNeeded(GrouperSession grouperSession)
      retrieve the group for this lookup if not looked up yet. pass in a grouper session
      Parameters:
      grouperSession -

    • retrieveGroupIfNeeded

      public Group retrieveGroupIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException
      retrieve the group for this lookup if not looked up yet. pass in a grouper session
      Parameters:
      grouperSession -
      invalidQueryReason - is the text to go in the WsInvalidQueryException
      Returns:
      the group
      Throws:
      WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

    • retrievePITGroupsIfNeeded

      public Set<PITGroup> retrievePITGroupsIfNeeded(String invalidQueryReason, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) throws WsInvalidQueryException
      retrieve the pit groups for this lookup if not looked up yet.
      Parameters:
      invalidQueryReason - is the text to go in the WsInvalidQueryException
      pointInTimeFrom -
      pointInTimeTo -
      Returns:
      the pit group
      Throws:
      WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

    • getUuid

      public String getUuid()
      uuid of the group to find
      Returns:
      the uuid

    • setUuid

      public void setUuid(String uuid1)
      uuid of the group to find
      Parameters:
      uuid1 - the uuid to set

    • getGroupName

      public String getGroupName()
      name of the group to find (includes stems, e.g. stem1:stem2:groupName
      Returns:
      the theName

    • setGroupName

      public void setGroupName(String theName)
      name of the group to find (includes stems, e.g. stem1:stem2:groupName
      Parameters:
      theName - the theName to set