|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.ws.soap.WsSubjectLookup
public class WsSubjectLookup
template to lookup a subject. to lookup a group as a subject, use the group uuid (e.g. fa2dd790-d3f9-4cf4-ac41-bb82e63bff66) in the subject id of the subject lookup. Optionally you can use g:gsa as the source id. developers make sure each setter calls this.clearSubject();
Nested Class Summary | |
---|---|
static class |
WsSubjectLookup.MemberFindResult
result of a subject find |
static class |
WsSubjectLookup.SubjectFindResult
result of a subject find |
Constructor Summary | |
---|---|
WsSubjectLookup()
|
|
WsSubjectLookup(String subjectId1,
String subjectSource1,
String subjectIdentifier1)
|
Method Summary | |
---|---|
boolean |
blank()
see if there is a blank query (if there is not id or identifier |
static Set<String> |
convertToMemberIds(GrouperSession grouperSession,
WsSubjectLookup[] wsSubjectLookups,
StringBuilder errorMessage)
convert subject lookups to member ids (create if not exist) |
static Set<String> |
convertToMemberIds(GrouperSession grouperSession,
WsSubjectLookup[] wsSubjectLookups,
StringBuilder errorMessage,
int[] lookupCount)
convert subject lookups to member ids (create if not exist) |
static WsSubjectLookup |
createIfNeeded(String subjectId,
String sourceId,
String subjectIdentifier)
create if any not null, otherwise null |
String |
getSubjectId()
id of the subject |
String |
getSubjectIdentifier()
any identifier of the subject |
String |
getSubjectSourceId()
optional: source of subject in the subject api source list |
boolean |
hasData()
see if this group lookup has data |
static void |
main(String[] args)
|
Member |
retrieveMember()
Retrieve the member object for this subject, do not create if not there Note: this is not a javabean property because we dont want it in the web service |
Member |
retrieveMember(String invalidInputReason)
Note: this is not a javabean property because we dont want it in the web service |
WsSubjectLookup.MemberFindResult |
retrieveMemberFindResult()
Note: this is not a javabean property because we dont want it in the web service |
Subject |
retrieveSubject()
Note: this is not a javabean property because we dont want it in the web service |
Subject |
retrieveSubject(String invalidInputReason)
Note: this is not a javabean property because we dont want it in the web service |
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 |
setSubjectSourceId(String subjectSource1)
optional: source of subject in the subject api source list |
String |
toString()
|
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 |
---|
public WsSubjectLookup(String subjectId1, String subjectSource1, String subjectIdentifier1)
subjectId1
- subjectSource1
- subjectIdentifier1
- public WsSubjectLookup()
Method Detail |
---|
public static WsSubjectLookup createIfNeeded(String subjectId, String sourceId, String subjectIdentifier)
subjectId
- sourceId
- subjectIdentifier
-
public String toString()
toString
in class Object
public static void main(String[] args)
args
- public boolean blank()
public boolean hasData()
public String getSubjectSourceId()
public void setSubjectSourceId(String subjectSource1)
subjectSource1
- the subjectSource to setpublic Subject retrieveSubject()
Note: this is not a javabean property because we dont want it in the web service
public Member retrieveMember()
Retrieve the member object for this subject, do not create if not there Note: this is not a javabean property because we dont want it in the web service
public Member retrieveMember(String invalidInputReason)
Note: this is not a javabean property because we dont want it in the web service
invalidInputReason
- label to be put in WsInvalidQueryException
WsInvalidQueryException
public Subject retrieveSubject(String invalidInputReason)
Note: this is not a javabean property because we dont want it in the web service
invalidInputReason
- label to be put in WsInvalidQueryException
WsInvalidQueryException
public WsSubjectLookup.SubjectFindResult retrieveSubjectFindResult()
Note: this is not a javabean property because we dont want it in the web service
public WsSubjectLookup.MemberFindResult retrieveMemberFindResult()
Note: this is not a javabean property because we dont want it in the web service
public String getSubjectId()
public void setSubjectId(String subjectId1)
subjectId1
- the subjectId to setpublic String getSubjectIdentifier()
public void setSubjectIdentifier(String subjectIdentifier1)
subjectIdentifier1
- the subjectIdentifier to setpublic static Set<String> convertToMemberIds(GrouperSession grouperSession, WsSubjectLookup[] wsSubjectLookups, StringBuilder errorMessage)
grouperSession
- wsSubjectLookups
- errorMessage
-
public static Set<String> convertToMemberIds(GrouperSession grouperSession, WsSubjectLookup[] wsSubjectLookups, StringBuilder errorMessage, int[] lookupCount)
grouperSession
- wsSubjectLookups
- errorMessage
- lookupCount
- is an array of size one int where 1 will be added if there are records, and no change if not
public String toStringCompact()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |