edu.internet2.middleware.grouper.ws.coresoap
Class WsStemLookup

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.WsStemLookup
All Implemented Interfaces:
GrouperWsToStringCompact

public class WsStemLookup
extends java.lang.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
 

Author:
mchyzer

Nested Class Summary
static class WsStemLookup.StemFindResult
          result of stem find
 
Constructor Summary
WsStemLookup()
           
WsStemLookup(java.lang.String stemName1, java.lang.String uuid1)
           
WsStemLookup(java.lang.String stemName1, java.lang.String uuid1, java.lang.String idIndex1)
           
 
Method Summary
 boolean blank()
          see if blank
static java.util.Set<java.lang.String> convertToStemIds(GrouperSession grouperSession, WsStemLookup[] wsStemLookups, java.lang.StringBuilder errorMessage, int[] lookupCount)
          convert stem lookups to stem ids
 java.lang.String getIdIndex()
          integer ID for object
 java.lang.String getStemName()
          name of the stem to find (includes stems, e.g.
 java.lang.String getUuid()
          uuid of the stem to find
 boolean hasData()
          see if this stem lookup has data
 Stem retrieveStem()
           Note: this is not a javabean property because we dont want it in the web service
 WsStemLookup.StemFindResult retrieveStemFindResult()
           Note: this is not a javabean property because we dont want it in the web service
 void retrieveStemIfNeeded(GrouperSession grouperSession, boolean exceptionOnNull)
          pass in a grouper session
 void setIdIndex(java.lang.String idIndex1)
          integer ID for object
 void setStemName(java.lang.String theName)
          name of the stem to find (includes stems, e.g.
 void setUuid(java.lang.String uuid1)
          uuid of the stem to find
 java.lang.String toString()
          make sure this is an explicit toString
 java.lang.String toStringCompact()
          make sure this is an explicit toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsStemLookup

public WsStemLookup()

WsStemLookup

public WsStemLookup(java.lang.String stemName1,
                    java.lang.String uuid1)
Parameters:
stemName1 -
uuid1 -

WsStemLookup

public WsStemLookup(java.lang.String stemName1,
                    java.lang.String uuid1,
                    java.lang.String idIndex1)
Parameters:
stemName1 -
uuid1 -
idIndex1 -
Method Detail

getIdIndex

public java.lang.String getIdIndex()
integer ID for object

Returns:
the id

setIdIndex

public void setIdIndex(java.lang.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 java.lang.String toString()
make sure this is an explicit toString

Overrides:
toString in class java.lang.Object

retrieveStemIfNeeded

public void retrieveStemIfNeeded(GrouperSession grouperSession,
                                 boolean exceptionOnNull)
pass in a grouper session

Parameters:
grouperSession -
exceptionOnNull - excdeption if nothing in stem

getUuid

public java.lang.String getUuid()
uuid of the stem to find

Returns:
the uuid

setUuid

public void setUuid(java.lang.String uuid1)
uuid of the stem to find

Parameters:
uuid1 - the uuid to set

getStemName

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

Returns:
the theName

setStemName

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

Parameters:
theName - the theName to set

convertToStemIds

public static java.util.Set<java.lang.String> convertToStemIds(GrouperSession grouperSession,
                                                               WsStemLookup[] wsStemLookups,
                                                               java.lang.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 java.lang.String toStringCompact()
make sure this is an explicit toString

Specified by:
toStringCompact in interface GrouperWsToStringCompact
Returns:
return a compact to string