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

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

public class WsExternalSubjectLookup
extends java.lang.Object
implements GrouperWsToStringCompact

 Class to lookup an attribute def via web service
 
 developers make sure each setter calls this.clearAttributeDef();
 

Author:
mchyzer

Nested Class Summary
static class WsExternalSubjectLookup.ExternalSubjectFindResult
          result of extneral subject find
 
Constructor Summary
WsExternalSubjectLookup()
           
WsExternalSubjectLookup(java.lang.String identifier1)
           
 
Method Summary
 boolean blank()
          see if blank
 java.lang.String getIdentifier()
          name of the attributeDef to find (includes stems, e.g.
 boolean hasData()
          see if this attributeDef lookup has data
 ExternalSubject retrieveExternalSubject()
           Note: this is not a javabean property because we dont want it in the web service
 WsExternalSubjectLookup.ExternalSubjectFindResult retrieveExternalSubjectFindResult()
           Note: this is not a javabean property because we dont want it in the web service
 void retrieveExternalSubjectIfNeeded(GrouperSession grouperSession)
          retrieve the external subject for this lookup if not looked up yet.
 ExternalSubject retrieveExternalSubjectIfNeeded(GrouperSession grouperSession, java.lang.String invalidQueryReason)
          retrieve the external subject for this lookup if not looked up yet.
 void setIdentifier(java.lang.String theName)
          name of the attributeDef to find (includes stems, e.g.
 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

WsExternalSubjectLookup

public WsExternalSubjectLookup()

WsExternalSubjectLookup

public WsExternalSubjectLookup(java.lang.String identifier1)
Parameters:
identifier1 -
Method Detail

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

Overrides:
toString in class java.lang.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,
                                                       java.lang.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 java.lang.String getIdentifier()
name of the attributeDef to find (includes stems, e.g. stem1:stem2:attributeDef

Returns:
the theName

setIdentifier

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

Parameters:
theName - the theName to set

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