edu.internet2.middleware.grouper.webservices
Class WsSubjectLookup

java.lang.Object
  extended by edu.internet2.middleware.grouper.webservices.WsSubjectLookup

public class WsSubjectLookup
extends Object

 template to lookup a subject
 
 developers make sure each setter calls this.clearSubject();
 
 TODO: add logging
 

Author:
mchyzer

Constructor Summary
WsSubjectLookup()
           
WsSubjectLookup(String subjectId1, String subjectIdentifier1)
           
 
Method Summary
 String getSubjectId()
          id of the subject
 String getSubjectIdentifier()
          any identifier of the subject
 String getSubjectSource()
          optional: source of subject in the subject api source list
 String getSubjectType()
          optional: type of subject, can be anything in SubjectTypeEnum: PERSON, GROUP, APPLICATION
 boolean isBlank()
          see if there is a blank query (if there is not id or identifier
 edu.internet2.middleware.subject.Subject retrieveSubject()
           Note: this is not a javabean property because we dont want it in the web service
 edu.internet2.middleware.grouper.webservices.WsSubjectLookup.SubjectFindResult retrieveSubjectFindResult()
           Note: this is not a javabean property because we dont want it in the web service
 void setSubjectId(String subjectId1)
          id of the subject
 void setSubjectIdentifier(String subjectIdentifier1)
          any identifier of the subject
 void setSubjectSource(String subjectSource1)
          optional: source of subject in the subject api source list
 void setSubjectType(String subjectType1)
          optional: type of subject, can be anything in SubjectTypeEnum: PERSON, GROUP, APPLICATION
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsSubjectLookup

public WsSubjectLookup(String subjectId1,
                       String subjectIdentifier1)
Parameters:
subjectId1 -
subjectIdentifier1 -

WsSubjectLookup

public WsSubjectLookup()
Method Detail

toString

public String toString()
Overrides:
toString in class Object

isBlank

public boolean isBlank()
see if there is a blank query (if there is not id or identifier

Returns:
true or false

getSubjectType

public String getSubjectType()
optional: type of subject, can be anything in SubjectTypeEnum: PERSON, GROUP, APPLICATION

Returns:
the subjectType

setSubjectType

public void setSubjectType(String subjectType1)
optional: type of subject, can be anything in SubjectTypeEnum: PERSON, GROUP, APPLICATION

Parameters:
subjectType1 - the subjectType to set

getSubjectSource

public String getSubjectSource()
optional: source of subject in the subject api source list

Returns:
the subjectSource

setSubjectSource

public void setSubjectSource(String subjectSource1)
optional: source of subject in the subject api source list

Parameters:
subjectSource1 - the subjectSource to set

retrieveSubject

public edu.internet2.middleware.subject.Subject retrieveSubject()
 
 Note: this is not a javabean property because we dont want it in the web service
 

Returns:
the subject

retrieveSubjectFindResult

public edu.internet2.middleware.grouper.webservices.WsSubjectLookup.SubjectFindResult retrieveSubjectFindResult()
 
 Note: this is not a javabean property because we dont want it in the web service
 

Returns:
the subjectFindResult, this is never null

getSubjectId

public String getSubjectId()
id of the subject

Returns:
the subjectId

setSubjectId

public void setSubjectId(String subjectId1)
id of the subject

Parameters:
subjectId1 - the subjectId to set

getSubjectIdentifier

public String getSubjectIdentifier()
any identifier of the subject

Returns:
the subjectIdentifier

setSubjectIdentifier

public void setSubjectIdentifier(String subjectIdentifier1)
any identifier of the subject

Parameters:
subjectIdentifier1 - the subjectIdentifier to set