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

Class WsMembershipAnyLookup

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsMembershipAnyLookup
All Implemented Interfaces:
GrouperWsToStringCompact
public class WsMembershipAnyLookup extends Object implements 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();

  • Constructor Details

    • WsMembershipAnyLookup

      public WsMembershipAnyLookup()

    • WsMembershipAnyLookup

      public WsMembershipAnyLookup(WsGroupLookup wsGroupLookup1, WsSubjectLookup wsSubjectLookup1)
      Parameters:
      wsGroupLookup1 -
      wsSubjectLookup1 -

  • Method Details

    • retrieveErrorMessage

      public String retrieveErrorMessage()
      error message to return why this is invalid this is not a javabean property since we dont want it in xml
      Returns:
      error message

    • getWsGroupLookup

      public WsGroupLookup getWsGroupLookup()
      group lookup for group
      Returns:
      group lookup

    • setWsGroupLookup

      public void setWsGroupLookup(WsGroupLookup wsGroupLookup1)
      group lookup for group
      Parameters:
      wsGroupLookup1 -

    • getWsSubjectLookup

      public WsSubjectLookup getWsSubjectLookup()
      subject lookup for subject
      Returns:
      subject lookup

    • setWsSubjectLookup

      public void setWsSubjectLookup(WsSubjectLookup wsSubjectLookup1)
      subject lookup for subject
      Parameters:
      wsSubjectLookup1 -

    • 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

    • retrieveGroupMember

      public GroupMember retrieveGroupMember()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the membership

    • retrieveMembershipAnyFindResult

      public WsMembershipAnyLookup.MembershipAnyFindResult retrieveMembershipAnyFindResult()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the membershipFindResult, this is never null

    • toString

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

    • retrieveMembershipAnyIfNeeded

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

    • retrieveMembershipAnyIfNeeded

      public GroupMember retrieveMembershipAnyIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException
      retrieve the membership any 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

    • convertToGroupMemberIds

      public static Set<edu.internet2.middleware.grouperClient.collections.MultiKey> convertToGroupMemberIds(GrouperSession grouperSession, WsMembershipAnyLookup[] wsMembershipAnyLookups, StringBuilder errorMessage, TypeOfGroup typeOfGroup, int[] lookupCount)
      convert membership any lookups to membership any ids
      Parameters:
      grouperSession -
      wsMembershipAnyLookups -
      errorMessage -
      typeOfGroup -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the GroupMember ids

    • toStringCompact

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