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

Class WsRestGetMembershipsLiteRequest

java.lang.Object
edu.internet2.middleware.grouper.ws.rest.membership.WsRestGetMembershipsLiteRequest
All Implemented Interfaces:
WsRequestBean
public class WsRestGetMembershipsLiteRequest extends Object implements WsRequestBean
request bean for rest get members request

  • Constructor Details

    • WsRestGetMembershipsLiteRequest

      public WsRestGetMembershipsLiteRequest()

  • Method Details

    • getOwnerStemName

      public String getOwnerStemName()
      if looking for privileges on stems, put the stem name to look for here
      Returns:
      stem name

    • setOwnerStemName

      public void setOwnerStemName(String ownerStemName1)
      if looking for privileges on stems, put the stem name to look for here
      Parameters:
      ownerStemName1 -

    • getOwnerStemUuid

      public String getOwnerStemUuid()
      if looking for privileges on stems, put the stem uuid here
      Returns:
      privs on stems

    • setOwnerStemUuid

      public void setOwnerStemUuid(String ownerStemUuid1)
      if looking for privileges on stems, put the stem uuid here
      Parameters:
      ownerStemUuid1 -

    • getNameOfOwnerAttributeDef

      public String getNameOfOwnerAttributeDef()
      if looking for privileges on attribute definitions, put the name of the attribute definition here
      Returns:
      name

    • setNameOfOwnerAttributeDef

      public void setNameOfOwnerAttributeDef(String nameOfOwnerAttributeDef1)
      if looking for privileges on attribute definitions, put the name of the attribute definition here
      Parameters:
      nameOfOwnerAttributeDef1 -

    • getOwnerAttributeDefUuid

      public String getOwnerAttributeDefUuid()
      if looking for privileges on attribute definitions, put the uuid of the attribute definition here
      Returns:
      uuid

    • setOwnerAttributeDefUuid

      public void setOwnerAttributeDefUuid(String ownerAttributeDefUuid1)
      if looking for privileges on attribute definitions, put the uuid of the attribute definition here
      Parameters:
      ownerAttributeDefUuid1 -

    • getFieldType

      public String getFieldType()
      fieldType is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)
      Returns:
      field type

    • setFieldType

      public void setFieldType(String fieldType1)
      fieldType is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)
      Parameters:
      fieldType1 -

    • getServiceRole

      public String getServiceRole()
      serviceRole to filter attributes that a user has a certain role
      Returns:
      service role

    • setServiceRole

      public void setServiceRole(String serviceRole1)
      serviceRole to filter attributes that a user has a certain role
      Parameters:
      serviceRole1 -

    • getServiceId

      public String getServiceId()
      serviceId if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceName
      Returns:
      service id

    • setServiceId

      public void setServiceId(String serviceId1)
      serviceId if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceName
      Parameters:
      serviceId1 -

    • getServiceName

      public String getServiceName()
      serviceName if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceId
      Returns:
      service name

    • setServiceName

      public void setServiceName(String serviceName1)
      serviceName if filtering by users in a service, then this is the service to look in, mutually exclusive with serviceId
      Parameters:
      serviceName1 -

    • getSubjectId

      public String getSubjectId()
      subject id to look for memberships
      Returns:
      subject id

    • setSubjectId

      public void setSubjectId(String subjectId1)
      subject id to look for memberships
      Parameters:
      subjectId1 -

    • getSubjectIdentifier

      public String getSubjectIdentifier()
      subject id to look for memberships
      Returns:
      subject identifier

    • setSubjectIdentifier

      public void setSubjectIdentifier(String subjectIdentifier1)
      subject id to look for memberships
      Parameters:
      subjectIdentifier1 -

    • getSubjectSourceId

      public String getSubjectSourceId()
      subject id to look for memberships
      Returns:
      source id

    • setSubjectSourceId

      public void setSubjectSourceId(String subjectSourceId1)
      subject id to look for memberships
      Parameters:
      subjectSourceId1 -

    • getStemUuid

      public String getStemUuid()
      stem to look in for memberships
      Returns:
      stem uuid

    • setStemUuid

      public void setStemUuid(String stemUuid1)
      stem to look in for memberships
      Parameters:
      stemUuid1 -

    • getStemName

      public String getStemName()
      stem to look in for memberships
      Returns:
      stem name

    • setStemName

      public void setStemName(String stemName1)
      stem to look in for memberships
      Parameters:
      stemName1 -

    • getMembershipIds

      public String getMembershipIds()
      membershipIds are the comma separated list of ids to search for if known
      Returns:
      membership id

    • setMembershipIds

      public void setMembershipIds(String membershipsId1)
      membershipIds are the comma separated list of ids to search for if known
      Parameters:
      membershipsId1 -

    • getSourceIds

      public String getSourceIds()
      sourceids to limit request to, or null for all
      Returns:
      the sourceIds

    • setSourceIds

      public void setSourceIds(String sourceIds1)
      sourceids to limit request to, or null for all
      Parameters:
      sourceIds1 - the sourceIds to set

    • getRetrieveSubjectDetail

      public String getRetrieveSubjectDetail()
      retrieveSubjectDetail
      Returns:
      retrieveSubjectDetail

    • setRetrieveSubjectDetail

      public void setRetrieveSubjectDetail(String retrieveSubjectDetail1)
      retrieveSubjectDetail1
      Parameters:
      retrieveSubjectDetail1 -

    • getActAsSubjectId

      public String getActAsSubjectId()
      actAsSubjectId subject to act as instead of logged in user
      Returns:
      actAsSubjectId

    • setActAsSubjectId

      public void setActAsSubjectId(String actAsSubjectId1)
      actAsSubjectId subject to act as instead of logged in user
      Parameters:
      actAsSubjectId1 -

    • getActAsSubjectSourceId

      public String getActAsSubjectSourceId()
      actAsSubjectSource subject to act as instead of logged in user
      Returns:
      actAsSubjectSource

    • setActAsSubjectSourceId

      public void setActAsSubjectSourceId(String actAsSubjectSource1)
      actAsSubjectSource subject to act as instead of logged in user
      Parameters:
      actAsSubjectSource1 -

    • getActAsSubjectIdentifier

      public String getActAsSubjectIdentifier()
      actAsSubjectIdentifier subject to act as instead of logged in user
      Returns:
      actAsSubjectIdentifier

    • setActAsSubjectIdentifier

      public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
      actAsSubjectIdentifier subject to act as instead of logged in user
      Parameters:
      actAsSubjectIdentifier1 -

    • getSubjectAttributeNames

      public String getSubjectAttributeNames()
      subjectAttributeNames
      Returns:
      subjectAttributeNames

    • setSubjectAttributeNames

      public void setSubjectAttributeNames(String subjectAttributeNames1)
      subjectAttributeNames
      Parameters:
      subjectAttributeNames1 -

    • getIncludeGroupDetail

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

    • setIncludeGroupDetail

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

    • getParamName0

      public String getParamName0()
      paramName0 optional: reserved for future use
      Returns:
      paramName0

    • setParamName0

      public void setParamName0(String _paramName0)
      paramName0 optional: reserved for future use
      Parameters:
      _paramName0 -

    • getParamValue0

      public String getParamValue0()
      paramValue0 optional: reserved for future use
      Returns:
      paramValue0

    • setParamValue0

      public void setParamValue0(String _paramValue0)
      _paramValue0 optional: reserved for future use
      Parameters:
      _paramValue0 -

    • getParamName1

      public String getParamName1()
      paramName1 optional: reserved for future use
      Returns:
      paramName1

    • setParamName1

      public void setParamName1(String _paramName1)
      paramName1 optional: reserved for future use
      Parameters:
      _paramName1 -

    • getParamValue1

      public String getParamValue1()
      paramValue1 optional: reserved for future use
      Returns:
      paramValue1

    • setParamValue1

      public void setParamValue1(String _paramValue1)
      paramValue1 optional: reserved for future use
      Parameters:
      _paramValue1 -

    • getGroupName

      public String getGroupName()
      group name to look in
      Returns:
      the groupName

    • setGroupName

      public void setGroupName(String groupName1)
      group name to look in
      Parameters:
      groupName1 - the groupName to set

    • getGroupUuid

      public String getGroupUuid()
      group uuid to look in
      Returns:
      the groupUuid

    • setGroupUuid

      public void setGroupUuid(String groupUuid1)
      group uuid to look in
      Parameters:
      groupUuid1 - the groupUuid to set

    • getClientVersion

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

    • setClientVersion

      public void setClientVersion(String clientVersion1)
      field is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      Parameters:
      clientVersion1 - the clientVersion 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:

    • getEnabled

      public String getEnabled()
      enabled is A for all, T or null for enabled only, F for disabled
      Returns:
      enabled

    • setEnabled

      public void setEnabled(String enabled1)
      enabled is A for all, T or null for enabled only, F for disabled
      Parameters:
      enabled1 -

    • 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

    • 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

    • 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

    • getScope

      public String getScope()
      scope is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)
      Returns:
      scope

    • getStemScope

      public String getStemScope()
      stemScope is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREE
      Returns:
      stem scope

    • setScope

      public void setScope(String scope1)
      scope is a sql like string which will have a percent % concatenated to the end for group names to search in (or stem names)
      Parameters:
      scope1 -

    • setStemScope

      public void setStemScope(String stemScope1)
      stemScope is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREE
      Parameters:
      stemScope1 -

    • getPageSize

      public String getPageSize()
      page size if paging
      Returns:
      page size

    • setPageSize

      public void setPageSize(String pageSize1)
      page size if paging
      Parameters:
      pageSize1 -

    • getPageNumber

      public String getPageNumber()
      page number 1 indexed if paging
      Returns:
      page number

    • setPageNumber

      public void setPageNumber(String pageNumber1)
      page number 1 indexed if paging
      Parameters:
      pageNumber1 -

    • getSortString

      public String getSortString()
      sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      Returns:
      sort string

    • setSortString

      public void setSortString(String sortString1)
      sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      Parameters:
      sortString1 -

    • getAscending

      public String getAscending()
      ascending T or null for ascending, F for descending.
      Returns:
      ascending

    • setAscending

      public void setAscending(String ascending1)
      ascending T or null for ascending, F for descending.
      Parameters:
      ascending1 -

    • getPageSizeForMember

      public String getPageSizeForMember()
      page size if paging in the members part
      Returns:
      page size for member

    • setPageSizeForMember

      public void setPageSizeForMember(String pageSizeForMember1)
      page size if paging in the members part
      Parameters:
      pageSizeForMember1 -

    • getPageNumberForMember

      public String getPageNumberForMember()
      page number 1 indexed if paging in the members part
      Returns:
      page number for member

    • setPageNumberForMember

      public void setPageNumberForMember(String pageNumberForMember1)
      page number 1 indexed if paging in the members part
      Parameters:
      pageNumberForMember1 -

    • getSortStringForMember

      public String getSortStringForMember()
      must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members part
      Returns:
      sort string for member

    • setSortStringForMember

      public void setSortStringForMember(String sortStringForMember1)
      Parameters:
      sortStringForMember1 -

    • getAscendingForMember

      public String getAscendingForMember()
      T or null for ascending, F for descending in the members part
      Returns:
      if ascending for member

    • setAscendingForMember

      public void setAscendingForMember(String ascendingForMember1)
      T or null for ascending, F for descending in the members part
      Parameters:
      ascendingForMember1 -

    • getPointInTimeFrom

      public String getPointInTimeFrom()
      Returns:
      the pointInTimeFrom

    • setPointInTimeFrom

      public void setPointInTimeFrom(String pointInTimeFrom1)
      Parameters:
      pointInTimeFrom1 - the pointInTimeFrom to set

    • getPointInTimeTo

      public String getPointInTimeTo()
      Returns:
      the pointInTimeTo

    • setPointInTimeTo

      public void setPointInTimeTo(String pointInTimeTo1)
      Parameters:
      pointInTimeTo1 - the pointInTimeTo to set

    • getPageIsCursor

      public String getPageIsCursor()
      Returns:
      the pageIsCursor

    • setPageIsCursor

      public void setPageIsCursor(String pageIsCursor1)
      Parameters:
      pageIsCursor1 - the pageIsCursor to set

    • getPageLastCursorField

      public String getPageLastCursorField()
      Returns:
      the pageLastCursorField

    • setPageLastCursorField

      public void setPageLastCursorField(String pageLastCursorField1)
      Parameters:
      pageLastCursorField1 - the pageLastCursorField to set

    • getPageLastCursorFieldType

      public String getPageLastCursorFieldType()
      Returns:
      the pageLastCursorFieldType

    • setPageLastCursorFieldType

      public void setPageLastCursorFieldType(String pageLastCursorFieldType1)
      Parameters:
      pageLastCursorFieldType1 - the pageLastCursorFieldType to set

    • getPageCursorFieldIncludesLastRetrieved

      public String getPageCursorFieldIncludesLastRetrieved()
      Returns:
      the pageCursorFieldIncludesLastRetrieved

    • setPageCursorFieldIncludesLastRetrieved

      public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved1)
      Parameters:
      pageCursorFieldIncludesLastRetrieved1 - the pageCursorFieldIncludesLastRetrieved to set

    • getPageIsCursorForMember

      public String getPageIsCursorForMember()
      Returns:
      the pageIsCursorForMember

    • setPageIsCursorForMember

      public void setPageIsCursorForMember(String pageIsCursorForMember1)
      Parameters:
      pageIsCursorForMember1 - the pageIsCursorForMember to set

    • getPageLastCursorFieldForMember

      public String getPageLastCursorFieldForMember()
      Returns:
      the pageLastCursorFieldForMember

    • setPageLastCursorFieldForMember

      public void setPageLastCursorFieldForMember(String pageLastCursorFieldForMember1)
      Parameters:
      pageLastCursorFieldForMember1 - the pageLastCursorFieldForMember to set

    • getPageLastCursorFieldTypeForMember

      public String getPageLastCursorFieldTypeForMember()
      Returns:
      the pageLastCursorFieldTypeForMember

    • setPageLastCursorFieldTypeForMember

      public void setPageLastCursorFieldTypeForMember(String pageLastCursorFieldTypeForMember1)
      Parameters:
      pageLastCursorFieldTypeForMember1 - the pageLastCursorFieldTypeForMember to set

    • getPageCursorFieldIncludesLastRetrievedForMember

      public String getPageCursorFieldIncludesLastRetrievedForMember()
      Returns:
      the pageCursorFieldIncludesLastRetrievedForMember

    • setPageCursorFieldIncludesLastRetrievedForMember

      public void setPageCursorFieldIncludesLastRetrievedForMember(String pageCursorFieldIncludesLastRetrievedForMember1)
      Parameters:
      pageCursorFieldIncludesLastRetrievedForMember1 - the pageCursorFieldIncludesLastRetrievedForMember to set

    • getPointInTimeRetrieve

      public String getPointInTimeRetrieve()
      Returns:
      the pointInTimeRetrieve

    • setPointInTimeRetrieve

      public void setPointInTimeRetrieve(String pointInTimeRetrieve1)
      Parameters:
      pointInTimeRetrieve1 - the pointInTimeRetrieve to set