WsRestGetPermissionAssignmentsRequest

java.lang.Object
- edu.internet2.middleware.grouper.ws.rest.permission.WsRestGetPermissionAssignmentsRequest

All Implemented Interfaces:: WsRequestBean

public class WsRestGetPermissionAssignmentsRequest
extends java.lang.Object
implements WsRequestBean

Bean for rest request to get permissions

Constructor Summary

Constructors
Constructor and Description

WsRestGetPermissionAssignmentsRequest()

Constructors
Constructor and Description
`WsRestGetPermissionAssignmentsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WsSubjectLookup`	`getActAsSubjectLookup()` if acting as someone else
`java.lang.String[]`	`getActions()` actions to query, or none to query all actions
`java.lang.String`	`getClientVersion()` is the version of the client.
`java.lang.String`	`getEnabled()` A for all, T or null for enabled only, F for disabled
`java.lang.String`	`getImmediateOnly()` immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
`java.lang.String`	`getIncludeAssignmentsOnAssignments()` if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
`java.lang.String`	`getIncludeAttributeAssignments()` T or F for it attribute assignments should be returned
`java.lang.String`	`getIncludeAttributeDefNames()` T or F for if attributeDefName objects should be returned
`java.lang.String`	`getIncludeGroupDetail()` T or F as to if the group detail should be returned
`java.lang.String`	`getIncludeLimits()` includeLimits T or F (default to F) for if limits should be returned with the results.
`java.lang.String`	`getIncludePermissionAssignDetail()` T or F for if the permission details should be returned
`java.lang.String`	`getIncludeSubjectDetail()` T\|F, for if the extended subject information should be returned (anything more than just the id)
`WsPermissionEnvVar[]`	`getLimitEnvVars()` limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
`WsParam[]`	`getParams()` optional: reserved for future use
`java.lang.String`	`getPermissionProcessor()` if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set).
`java.lang.String`	`getPermissionType()` are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
`java.lang.String`	`getPointInTimeFrom()` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
`java.lang.String`	`getPointInTimeTo()` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
`WsGroupLookup[]`	`getRoleLookups()` are roles to look in
`java.lang.String[]`	`getSubjectAttributeNames()` are the additional subject attributes (data) to return.
`WsAttributeDefLookup[]`	`getWsAttributeDefLookups()` find assignments in these attribute defs (optional)
`WsAttributeDefNameLookup[]`	`getWsAttributeDefNameLookups()` find assignments in these attribute def names (optional)
`WsSubjectLookup[]`	`getWsSubjectLookups()` are subjects to look in
`GrouperRestHttpMethod`	`retrieveRestHttpMethod()` see which http method this is supposed to be associated with, and override whatever was passed in
`void`	`setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)` if acting as someone else
`void`	`setActions(java.lang.String[] actions1)` actions to query, or none to query all actions
`void`	`setClientVersion(java.lang.String clientVersion1)` is the version of the client.
`void`	`setEnabled(java.lang.String enabled1)` A for all, T or null for enabled only, F for disabled
`void`	`setImmediateOnly(java.lang.String immediateOnly1)` immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
`void`	`setIncludeAssignmentsOnAssignments(java.lang.String includeAssignmentsOnAssignments1)` if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
`void`	`setIncludeAttributeAssignments(java.lang.String includeAttributeAssignments1)` T or F for it attribute assignments should be returned
`void`	`setIncludeAttributeDefNames(java.lang.String includeAttributeDefNames1)` T or F for if attributeDefName objects should be returned
`void`	`setIncludeGroupDetail(java.lang.String includeGroupDetail1)` T or F as to if the group detail should be returned
`void`	`setIncludeLimits(java.lang.String includeLimits1)` includeLimits T or F (default to F) for if limits should be returned with the results.
`void`	`setIncludePermissionAssignDetail(java.lang.String includePermissionAssignDetail1)` T or F for if the permission details should be returned
`void`	`setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)` T\|F, for if the extended subject information should be returned (anything more than just the id)
`void`	`setLimitEnvVars(WsPermissionEnvVar[] limitEnvVars1)` limitEnvVars limitEnvVars if processing limits, pass in a set of limits.
`void`	`setParams(WsParam[] params1)` optional: reserved for future use
`void`	`setPermissionProcessor(java.lang.String permissionProcessor1)` if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set).
`void`	`setPermissionType(java.lang.String permissionType1)` are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
`void`	`setPointInTimeFrom(java.lang.String pointInTimeFrom1)` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
`void`	`setPointInTimeTo(java.lang.String pointInTimeTo1)` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
`void`	`setRoleLookups(WsGroupLookup[] wsOwnerGroupLookups1)` are roles to look in
`void`	`setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)` are the additional subject attributes (data) to return.
`void`	`setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)` find assignments in these attribute defs (optional)
`void`	`setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)` find assignments in these attribute def names (optional)
`void`	`setWsSubjectLookups(WsSubjectLookup[] wsOwnerSubjectLookups1)` are subjects to look in

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WsRestGetPermissionAssignmentsRequest
```
public WsRestGetPermissionAssignmentsRequest()
```
- Method Detail
  - getIncludeLimits
```
public java.lang.String getIncludeLimits()
```
    includeLimits T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists
    
    Returns:
    
    the includeLimits
  - setIncludeLimits
```
public void setIncludeLimits(java.lang.String includeLimits1)
```
    includeLimits T or F (default to F) for if limits should be returned with the results. Note that the attributeDefs, attributeDefNames, and attributeAssignments will be added to those lists
    
    Parameters:
    
    includeLimits1 - the includeLimits to set
  - getImmediateOnly
```
public java.lang.String getImmediateOnly()
```
    immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
    
    Returns:
    
    the immediateOnly
  - setImmediateOnly
```
public void setImmediateOnly(java.lang.String immediateOnly1)
```
    immediateOnly T of F (defaults to F) if we should filter out non immediate permissions
    
    Parameters:
    
    immediateOnly1 - the immediateOnly to set
  - getPermissionType
```
public java.lang.String getPermissionType()
```
    are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions
    
    Returns:
    
    the permissionType
  - setPermissionType
```
public void setPermissionType(java.lang.String permissionType1)
```
    are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions
    
    Parameters:
    
    permissionType1 - the permissionType to set
  - getLimitEnvVars
```
public WsPermissionEnvVar[] getLimitEnvVars()
```
    limitEnvVars limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50
    
    Returns:
    
    the limitEnvVars
  - setLimitEnvVars
```
public void setLimitEnvVars(WsPermissionEnvVar[] limitEnvVars1)
```
    limitEnvVars limitEnvVars if processing limits, pass in a set of limits. The name is the name of the variable, and the value is the value. Note, you can typecast the values by putting a valid type in parens in front of the param name. e.g. name: (int)amount, value: 50
    
    Parameters:
    
    limitEnvVars1 - the limitEnvVars to set
  - getPermissionProcessor
```
public java.lang.String getPermissionProcessor()
```
    if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set). This is the PermissionProcessor enum. e.g. FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS. If null, then just get all permissions and process on the client.
    
    Returns:
    
    processor
  - setPermissionProcessor
```
public void setPermissionProcessor(java.lang.String permissionProcessor1)
```
    if processing permissions, you can filter out either redundant permissions (find best in set), or do that and filter out redundant roles (if flattening roles) (find best in set). This is the PermissionProcessor enum. e.g. FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS. If null, then just get all permissions and process on the client.
    
    Parameters:
    
    permissionProcessor1 -
  - getIncludeAttributeDefNames
```
public java.lang.String getIncludeAttributeDefNames()
```
    T or F for if attributeDefName objects should be returned
    
    Returns:
    
    the attributeDefName
  - setIncludeAttributeDefNames
```
public void setIncludeAttributeDefNames(java.lang.String includeAttributeDefNames1)
```
    T or F for if attributeDefName objects should be returned
    
    Parameters:
    
    includeAttributeDefNames1 -
  - getIncludePermissionAssignDetail
```
public java.lang.String getIncludePermissionAssignDetail()
```
    T or F for if the permission details should be returned
    
    Returns:
    
    T or F
  - setIncludePermissionAssignDetail
```
public void setIncludePermissionAssignDetail(java.lang.String includePermissionAssignDetail1)
```
    T or F for if the permission details should be returned
    
    Parameters:
    
    includePermissionAssignDetail1 -
  - getIncludeAttributeAssignments
```
public java.lang.String getIncludeAttributeAssignments()
```
    T or F for it attribute assignments should be returned
    
    Returns:
    
    include attribute assignments
  - setIncludeAttributeAssignments
```
public void setIncludeAttributeAssignments(java.lang.String includeAttributeAssignments1)
```
    T or F for it attribute assignments should be returned
    
    Parameters:
    
    includeAttributeAssignments1 -
  - 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:
    
    WsRequestBean.retrieveRestHttpMethod()
  - getClientVersion
```
public java.lang.String getClientVersion()
```
    is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
    
    Returns:
    
    version
  - setClientVersion
```
public void setClientVersion(java.lang.String clientVersion1)
```
    is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
    
    Parameters:
    
    clientVersion1 -
  - getWsAttributeDefLookups
```
public WsAttributeDefLookup[] getWsAttributeDefLookups()
```
    find assignments in these attribute defs (optional)
    
    Returns:
    
    defs
  - setWsAttributeDefLookups
```
public void setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
```
    find assignments in these attribute defs (optional)
    
    Parameters:
    
    wsAttributeDefLookups1 -
  - getWsAttributeDefNameLookups
```
public WsAttributeDefNameLookup[] getWsAttributeDefNameLookups()
```
    find assignments in these attribute def names (optional)
    
    Returns:
    
    def name lookups
  - setWsAttributeDefNameLookups
```
public void setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
```
    find assignments in these attribute def names (optional)
    
    Parameters:
    
    wsAttributeDefNameLookups1 -
  - getRoleLookups
```
public WsGroupLookup[] getRoleLookups()
```
    are roles to look in
    
    Returns:
    
    owner group lookups
  - setRoleLookups
```
public void setRoleLookups(WsGroupLookup[] wsOwnerGroupLookups1)
```
    are roles to look in
    
    Parameters:
    
    wsOwnerGroupLookups1 -
  - getWsSubjectLookups
```
public WsSubjectLookup[] getWsSubjectLookups()
```
    are subjects to look in
    
    Returns:
    
    subject
  - setWsSubjectLookups
```
public void setWsSubjectLookups(WsSubjectLookup[] wsOwnerSubjectLookups1)
```
    are subjects to look in
    
    Parameters:
    
    wsOwnerSubjectLookups1 -
  - getActions
```
public java.lang.String[] getActions()
```
    actions to query, or none to query all actions
    
    Returns:
    
    actions
  - setActions
```
public void setActions(java.lang.String[] actions1)
```
    actions to query, or none to query all actions
    
    Parameters:
    
    actions1 -
  - getIncludeAssignmentsOnAssignments
```
public java.lang.String getIncludeAssignmentsOnAssignments()
```
    if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
    
    Returns:
    
    if include assignments on assignments
  - setIncludeAssignmentsOnAssignments
```
public void setIncludeAssignmentsOnAssignments(java.lang.String includeAssignmentsOnAssignments1)
```
    if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.
    
    Parameters:
    
    includeAssignmentsOnAssignments1 -
  - getActAsSubjectLookup
```
public WsSubjectLookup getActAsSubjectLookup()
```
    if acting as someone else
    
    Returns:
    
    act as subject
  - setActAsSubjectLookup
```
public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
```
    if acting as someone else
    
    Parameters:
    
    actAsSubjectLookup1 -
  - getIncludeSubjectDetail
```
public java.lang.String getIncludeSubjectDetail()
```
    T|F, for if the extended subject information should be returned (anything more than just the id)
    
    Returns:
    
    T|F
  - setIncludeSubjectDetail
```
public void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
```
    T|F, for if the extended subject information should be returned (anything more than just the id)
    
    Parameters:
    
    includeSubjectDetail1 -
  - getSubjectAttributeNames
```
public java.lang.String[] getSubjectAttributeNames()
```
    are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent
    
    Returns:
    
    subject attribute names
  - setSubjectAttributeNames
```
public void setSubjectAttributeNames(java.lang.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 -
  - getIncludeGroupDetail
```
public java.lang.String getIncludeGroupDetail()
```
    T or F as to if the group detail should be returned
    
    Returns:
    
    T|F
  - setIncludeGroupDetail
```
public void setIncludeGroupDetail(java.lang.String includeGroupDetail1)
```
    T or F as to if the group detail should be returned
    
    Parameters:
    
    includeGroupDetail1 -
  - getParams
```
public WsParam[] getParams()
```
    optional: reserved for future use
    
    Returns:
    
    params
  - setParams
```
public void setParams(WsParam[] params1)
```
    optional: reserved for future use
    
    Parameters:
    
    params1 -
  - getEnabled
```
public java.lang.String getEnabled()
```
    A for all, T or null for enabled only, F for disabled
    
    Returns:
    
    enabled
  - setEnabled
```
public void setEnabled(java.lang.String enabled1)
```
    A for all, T or null for enabled only, F for disabled
    
    Parameters:
    
    enabled1 -
  - getPointInTimeFrom
```
public java.lang.String getPointInTimeFrom()
```
    To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSS
    
    Returns:
    
    the pointInTimeFrom
  - setPointInTimeFrom
```
public void setPointInTimeFrom(java.lang.String pointInTimeFrom1)
```
    To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSS
    
    Parameters:
    
    pointInTimeFrom1 - the pointInTimeFrom to set
  - getPointInTimeTo
```
public java.lang.String getPointInTimeTo()
```
    To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
    
    Returns:
    
    the pointInTimeTo
  - setPointInTimeTo
```
public void setPointInTimeTo(java.lang.String pointInTimeTo1)
```
    To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
    
    Parameters:
    
    pointInTimeTo1 - the pointInTimeTo to set

Class WsRestGetPermissionAssignmentsRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WsRestGetPermissionAssignmentsRequest

Method Detail

getIncludeLimits

setIncludeLimits

getImmediateOnly

setImmediateOnly

getPermissionType

setPermissionType

getLimitEnvVars

setLimitEnvVars

getPermissionProcessor

setPermissionProcessor

getIncludeAttributeDefNames

setIncludeAttributeDefNames

getIncludePermissionAssignDetail

setIncludePermissionAssignDetail

getIncludeAttributeAssignments

setIncludeAttributeAssignments

retrieveRestHttpMethod

getClientVersion

setClientVersion

getWsAttributeDefLookups

setWsAttributeDefLookups

getWsAttributeDefNameLookups

setWsAttributeDefNameLookups

getRoleLookups

setRoleLookups

getWsSubjectLookups

setWsSubjectLookups

getActions

setActions

getIncludeAssignmentsOnAssignments

setIncludeAssignmentsOnAssignments

getActAsSubjectLookup

setActAsSubjectLookup

getIncludeSubjectDetail

setIncludeSubjectDetail

getSubjectAttributeNames

setSubjectAttributeNames

getIncludeGroupDetail

setIncludeGroupDetail

getParams

setParams

getEnabled

setEnabled

getPointInTimeFrom

setPointInTimeFrom

getPointInTimeTo

setPointInTimeTo