Class WsMembershipLookup
java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsMembershipLookup
- All Implemented Interfaces:
GrouperWsToStringCompact
Class to lookup a membership via web service. Put in a uuid, or fill in the other fields developers make sure each setter calls this.clearMembership();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
result of attribute def name find -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
blank()
see if blankconvertToMembershipIds
(GrouperSession grouperSession, WsMembershipLookup[] wsMembershipLookups, StringBuilder errorMessage, int[] lookupCount) convert membership lookups to membership idsgetUuid()
uuid of the membership to findboolean
hasData()
see if this membership lookup has dataNote: this is not a javabean property because we dont want it in the web serviceNote: this is not a javabean property because we dont want it in the web servicevoid
retrieveMembershipIfNeeded
(GrouperSession grouperSession) retrieve the membership for this lookup if not looked up yet.retrieveMembershipIfNeeded
(GrouperSession grouperSession, String invalidQueryReason) retrieve the membership for this lookup if not looked up yet.void
uuid of the membership to findtoString()
make sure this is an explicit toStringmake sure this is an explicit toString
-
Constructor Details
-
WsMembershipLookup
- Parameters:
uuid1
-
-
WsMembershipLookup
public WsMembershipLookup()
-
-
Method Details
-
blank
public boolean blank()see if blank- Returns:
- true if blank
-
hasData
public boolean hasData()see if this membership lookup has data- Returns:
- true if it has data
-
retrieveMembership
Note: this is not a javabean property because we dont want it in the web service
- Returns:
- the membership
-
retrieveMembershipFindResult
Note: this is not a javabean property because we dont want it in the web service
- Returns:
- the membershipFindResult, this is never null
-
toString
make sure this is an explicit toString -
retrieveMembershipIfNeeded
retrieve the membership for this lookup if not looked up yet. pass in a grouper session- Parameters:
grouperSession
-
-
retrieveMembershipIfNeeded
public Membership retrieveMembershipIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException retrieve the membership 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 membership
- Throws:
WsInvalidQueryException
- if there is a problem, and if the invalidQueryReason is set
-
getUuid
uuid of the membership to find- Returns:
- the uuid
-
setUuid
uuid of the membership to find- Parameters:
uuid1
- the uuid to set
-
convertToMembershipIds
public static Set<String> convertToMembershipIds(GrouperSession grouperSession, WsMembershipLookup[] wsMembershipLookups, StringBuilder errorMessage, int[] lookupCount) convert membership lookups to membership ids- Parameters:
grouperSession
-wsMembershipLookups
-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 membership ids
-
toStringCompact
make sure this is an explicit toString- Specified by:
toStringCompact
in interfaceGrouperWsToStringCompact
- Returns:
- return a compact to string
-