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

Class WsStemLookup

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsStemLookup
All Implemented Interfaces:
GrouperWsToStringCompact
public class WsStemLookup extends Object implements GrouperWsToStringCompact
 Class to lookup a stem via web service
 
 developers make sure each setter calls this.clearSubject();
 TODO: add in extensions in the query

  • Constructor Details

    • WsStemLookup

      public WsStemLookup()

    • WsStemLookup

      public WsStemLookup(String stemName1, String uuid1)
      Parameters:
      stemName1 -
      uuid1 -

    • WsStemLookup

      public WsStemLookup(String stemName1, String uuid1, String idIndex1)
      Parameters:
      stemName1 -
      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 -

    • blank

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

    • hasData

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

    • retrieveStem

      public Stem retrieveStem()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the stem

    • retrieveStemFindResult

      public WsStemLookup.StemFindResult retrieveStemFindResult()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the subjectFindResult, this is never null

    • toString

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

    • retrieveStemIfNeeded

      public void retrieveStemIfNeeded(GrouperSession grouperSession, boolean exceptionOnNull)
      pass in a grouper session
      Parameters:
      grouperSession -
      exceptionOnNull - excdeption if nothing in stem

    • getUuid

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

    • setUuid

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

    • getStemName

      public String getStemName()
      name of the stem to find (includes stems, e.g. stem1:stem2:stemName
      Returns:
      the theName

    • setStemName

      public void setStemName(String theName)
      name of the stem to find (includes stems, e.g. stem1:stem2:stemName
      Parameters:
      theName - the theName to set

    • convertToStemIds

      public static Set<String> convertToStemIds(GrouperSession grouperSession, WsStemLookup[] wsStemLookups, StringBuilder errorMessage, int[] lookupCount)
      convert stem lookups to stem ids
      Parameters:
      grouperSession -
      wsStemLookups -
      errorMessage -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the stem ids

    • toStringCompact

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