Package edu.internet2.middleware.grouper.ws.rest.subject

Class WsRestGetSubjectsRequest

java.lang.Object
edu.internet2.middleware.grouper.ws.rest.subject.WsRestGetSubjectsRequest
All Implemented Interfaces:
WsRequestBean
public class WsRestGetSubjectsRequest extends Object implements WsRequestBean
bean that will be the data from rest request
See Also:
  • for method

  • Constructor Details

    • WsRestGetSubjectsRequest

      public WsRestGetSubjectsRequest()

  • Method Details

    • getWsSubjectLookups

      public WsSubjectLookup[] getWsSubjectLookups()
      are subjects to look in
      Returns:
      subjects

    • setWsSubjectLookups

      public void setWsSubjectLookups(WsSubjectLookup[] wsSubjectLookups1)
      are subjects to look in
      Parameters:
      wsSubjectLookups1 -

    • getSourceIds

      public String[] getSourceIds()
      sourceIds are sources to look in for memberships, or null if all
      Returns:
      the sourceIds

    • setSourceIds

      public void setSourceIds(String[] sourceIds1)
      sourceIds are sources to look in for memberships, or null if all
      Parameters:
      sourceIds1 - the sourceIds to set

    • getClientVersion

      public String getClientVersion()
      is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      Returns:
      the clientVersion

    • setClientVersion

      public void setClientVersion(String clientVersion1)
      is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      Parameters:
      clientVersion1 - the clientVersion to set

    • getWsGroupLookup

      public WsGroupLookup getWsGroupLookup()
      returned subjects must be in this group
      Returns:
      the wsGroupLookup

    • setWsGroupLookup

      public void setWsGroupLookup(WsGroupLookup wsGroupLookup1)
      returned subjects must be in this group
      Parameters:
      wsGroupLookup1 - the wsGroupLookup to set

    • getMemberFilter

      public String getMemberFilter()
      must be one of All, Effective, Immediate, Composite, NonImmediate
      Returns:
      the replaceAllExisting

    • setMemberFilter

      public void setMemberFilter(String replaceAllExisting1)
      must be one of All, Effective, Immediate, Composite, NonImmediate
      Parameters:
      replaceAllExisting1 - the replaceAllExisting to set

    • getActAsSubjectLookup

      public WsSubjectLookup getActAsSubjectLookup()
      subject to act as instead of logged in user
      Returns:
      the actAsSubjectLookup

    • setActAsSubjectLookup

      public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
      subject to act as instead of logged in user
      Parameters:
      actAsSubjectLookup1 - the actAsSubjectLookup to set

    • getFieldName

      public String getFieldName()
      is if the memberships should be retrieved from a certain field membership of the group (certain list)
      Returns:
      the fieldName

    • setFieldName

      public void setFieldName(String fieldName1)
      is if the memberships should be retrieved from a certain field membership of the group (certain list)
      Parameters:
      fieldName1 - the fieldName to set

    • getIncludeGroupDetail

      public String getIncludeGroupDetail()
      T or F as to if the group detail should be returned
      Returns:
      the includeGroupDetail

    • setIncludeGroupDetail

      public void setIncludeGroupDetail(String includeGroupDetail1)
      T or F as to if the group detail should be returned
      Parameters:
      includeGroupDetail1 - the includeGroupDetail to set

    • getIncludeSubjectDetail

      public String getIncludeSubjectDetail()
      T|F, for if the extended subject information should be returned (anything more than just the id)
      Returns:
      the includeSubjectDetail

    • setIncludeSubjectDetail

      public void setIncludeSubjectDetail(String includeSubjectDetail1)
      T|F, for if the extended subject information should be returned (anything more than just the id)
      Parameters:
      includeSubjectDetail1 - the includeSubjectDetail to set

    • getSubjectAttributeNames

      public String[] getSubjectAttributeNames()
      are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      Returns:
      the subjectAttributeNames

    • setSubjectAttributeNames

      public void setSubjectAttributeNames(String[] subjectAttributeNames1)
      are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
      Parameters:
      subjectAttributeNames1 - the subjectAttributeNames to set

    • getParams

      public WsParam[] getParams()
      optional: reserved for future use
      Returns:
      the params

    • setParams

      public void setParams(WsParam[] params1)
      optional: reserved for future use
      Parameters:
      params1 - the params to set

    • retrieveRestHttpMethod

      public GrouperRestHttpMethod retrieveRestHttpMethod()
      Description copied from interface: WsRequestBean
      see which http method this is supposed to be associated with, and override whatever was passed in
      Specified by:
      retrieveRestHttpMethod in interface WsRequestBean
      Returns:
      the method
      See Also:

    • getSearchString

      public String getSearchString()
      search sources with this free-form search string
      Returns:
      search string

    • setSearchString

      public void setSearchString(String searchString1)
      search sources with this free-form search string
      Parameters:
      searchString1 -