Package edu.internet2.middleware.grouperClient.ws.beans

Class WsRestGetMembershipsRequest

java.lang.Object
edu.internet2.middleware.grouperClient.ws.beans.WsRestGetMembershipsRequest
All Implemented Interfaces:
WsRequestBean
public class WsRestGetMembershipsRequest extends Object implements WsRequestBean
bean that will be the data from rest request GrouperServiceLogic#getMemberships(edu.internet2.middleware.grouper.ws.GrouperWsVersion, WsGroupLookup[], WsSubjectLookup[], edu.internet2.middleware.grouper.ws.member.WsMemberFilter, WsSubjectLookup, edu.internet2.middleware.grouper.Field, boolean, String[], boolean, WsParam[], String[], String, edu.internet2.middleware.grouper.ws.soap.WsStemLookup, edu.internet2.middleware.grouper.ws.query.StemScope, String, String[]) for method

  • Constructor Details

    • WsRestGetMembershipsRequest

      public WsRestGetMembershipsRequest()

  • Method Details

    • getWsOwnerStemLookups

      public WsStemLookup[] getWsOwnerStemLookups()
      stem lookups if looking for memberships on certain stems
      Returns:
      stem lookups

    • setWsOwnerStemLookups

      public void setWsOwnerStemLookups(WsStemLookup[] wsStemLookups1)
      stem lookups if looking for memberships on certain stems
      Parameters:
      wsStemLookups1 -

    • getWsOwnerAttributeDefLookups

      public WsAttributeDefLookup[] getWsOwnerAttributeDefLookups()
      attribute definition lookups if looking for memberships on certain attribute definitions
      Returns:
      attributeDef lookups

    • setWsOwnerAttributeDefLookups

      public void setWsOwnerAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
      attribute definition lookups if looking for memberships on certain attribute definitions
      Parameters:
      wsAttributeDefLookups1 -

    • 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:
      the service role

    • setServiceRole

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

    • getServiceLookup

      public WsAttributeDefNameLookup getServiceLookup()
      serviceLookup if filtering by users in a service, then this is the service to look in
      Returns:
      service lookup

    • setServiceLookup

      public void setServiceLookup(WsAttributeDefNameLookup serviceLookup1)
      serviceLookup if filtering by users in a service, then this is the service to look in
      Parameters:
      serviceLookup1 -

    • getMembershipIds

      public String[] getMembershipIds()
      membershipIds are the ids to search for if they are known
      Returns:
      the ids

    • setMembershipIds

      public void setMembershipIds(String[] membershipsIds1)
      membershipIds are the ids to search for if they are known
      Parameters:
      membershipsIds1 -

    • 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 -

    • getStemScope

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

    • 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 -

    • getWsStemLookup

      public WsStemLookup getWsStemLookup()
      wsStemLookup is the stem to look in for memberships
      Returns:
      stem lookup

    • setWsStemLookup

      public void setWsStemLookup(WsStemLookup wsStemLookup1)
      wsStemLookup is the stem to look in for memberships
      Parameters:
      wsStemLookup1 -

    • 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

    • 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 -

    • 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

    • getWsGroupLookups

      public WsGroupLookup[] getWsGroupLookups()
      are groups to look in
      Returns:
      the wsGroupLookups

    • setWsGroupLookups

      public void setWsGroupLookups(WsGroupLookup[] wsGroupLookups1)
      are groups to look in
      Parameters:
      wsGroupLookups1 - 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

    • 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 -

    • getPageIsCursor

      public String getPageIsCursor()
      Returns:
      the pageIsCursor

    • setPageIsCursor

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

    • getPageLastCursorField

      public String getPageLastCursorField()
      Returns:
      the pageLastCursorField

    • setPageLastCursorField

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

    • getPageLastCursorFieldType

      public String getPageLastCursorFieldType()
      Returns:
      the pageLastCursorFieldType

    • setPageLastCursorFieldType

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

    • getPageCursorFieldIncludesLastRetrieved

      public String getPageCursorFieldIncludesLastRetrieved()
      Returns:
      the pageCursorFieldIncludesLastRetrieved

    • setPageCursorFieldIncludesLastRetrieved

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

    • getPageIsCursorForMember

      public String getPageIsCursorForMember()
      Returns:
      the pageIsCursorForMember

    • setPageIsCursorForMember

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

    • getPageLastCursorFieldForMember

      public String getPageLastCursorFieldForMember()
      Returns:
      the pageLastCursorFieldForMember

    • setPageLastCursorFieldForMember

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

    • getPageLastCursorFieldTypeForMember

      public String getPageLastCursorFieldTypeForMember()
      Returns:
      the pageLastCursorFieldTypeForMember

    • setPageLastCursorFieldTypeForMember

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

    • getPageCursorFieldIncludesLastRetrievedForMember

      public String getPageCursorFieldIncludesLastRetrievedForMember()
      Returns:
      the pageCursorFieldIncludesLastRetrievedForMember

    • setPageCursorFieldIncludesLastRetrievedForMember

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

    • getPointInTimeRetrieve

      public String getPointInTimeRetrieve()
      Returns:
      the pointInTimeRetrieve

    • setPointInTimeRetrieve

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

    • getPointInTimeFrom

      public String getPointInTimeFrom()
      Returns:
      the pointInTimeFrom

    • setPointInTimeFrom

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

    • getPointInTimeTo

      public String getPointInTimeTo()
      Returns:
      the pointInTimeTo

    • setPointInTimeTo

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