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

Class WsExternalSubjectLookup

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsExternalSubjectLookup
All Implemented Interfaces:
GrouperWsToStringCompact
public class WsExternalSubjectLookup extends Object implements GrouperWsToStringCompact
 Class to lookup an attribute def via web service
 
 developers make sure each setter calls this.clearAttributeDef();

  • Constructor Details

    • WsExternalSubjectLookup

      public WsExternalSubjectLookup()

    • WsExternalSubjectLookup

      public WsExternalSubjectLookup(String identifier1)
      Parameters:
      identifier1 -

  • Method Details

    • blank

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

    • hasData

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

    • retrieveExternalSubject

      public ExternalSubject retrieveExternalSubject()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the attributeDef

    • retrieveExternalSubjectFindResult

      public WsExternalSubjectLookup.ExternalSubjectFindResult retrieveExternalSubjectFindResult()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the attributeDefFindResult, this is never null

    • toString

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

    • retrieveExternalSubjectIfNeeded

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

    • retrieveExternalSubjectIfNeeded

      public ExternalSubject retrieveExternalSubjectIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException
      retrieve the external subject 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 attributeDef
      Throws:
      WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

    • getIdentifier

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

    • setIdentifier

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

    • toStringCompact

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