GcGetPermissionAssignments (Grouper Client 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouperClient.api.GcGetPermissionAssignments

```
public class GcGetPermissionAssignments
extends Object
```
class to run a get permission assignments web service call

Constructor Summary

Constructors
Constructor and Description

GcGetPermissionAssignments()

Constructors
Constructor and Description
`GcGetPermissionAssignments()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GcGetPermissionAssignments`	`addAction(String action)`
`GcGetPermissionAssignments`	`addAttributeDefIdIndex(Long theAttributeDefIdIndex)` set the attributedef id index
`GcGetPermissionAssignments`	`addAttributeDefName(String theAttributeDefName)` set the attributedef name
`GcGetPermissionAssignments`	`addAttributeDefNameIdIndex(Long theAttributeDefNameIdIndex)` set the attributeDefName id index
`GcGetPermissionAssignments`	`addAttributeDefNameName(String theAttributeDefNameName)` set the attributeDefName name
`GcGetPermissionAssignments`	`addAttributeDefNameUuid(String theAttributeDefNameUuid)` set the attributeDefName uuid
`GcGetPermissionAssignments`	`addAttributeDefUuid(String theAttributeDefUuid)` set the attributedef uuid
`GcGetPermissionAssignments`	`addParam(String paramName, String paramValue)` add a param to the list
`GcGetPermissionAssignments`	`addParam(WsParam wsParam)` add a param to the list
`GcGetPermissionAssignments`	`addPermissionEnvVar(String envVarName, String envVarValue, String envVarType)` limitEnvVars if processing limits, pass in a set of limits.
`GcGetPermissionAssignments`	`addPermissionEnvVar(WsPermissionEnvVar wsPermissionEnvVar)` limitEnvVars if processing limits, pass in a set of limits.
`GcGetPermissionAssignments`	`addRoleIdIndex(Long theRoleIdIndex)` set the role id index
`GcGetPermissionAssignments`	`addRoleName(String theRoleName)` set the role name
`GcGetPermissionAssignments`	`addRoleUuid(String theRoleUuid)` set the role uuid
`GcGetPermissionAssignments`	`addSubjectAttributeName(String subjectAttributeName)`
`GcGetPermissionAssignments`	`addSubjectLookup(WsSubjectLookup wsSubjectLookup)` set the subject lookup
`GcGetPermissionAssignments`	`assignActAsSubject(WsSubjectLookup theActAsSubject)` assign the act as subject if any
`GcGetPermissionAssignments`	`assignClientVersion(String theClientVersion)` assign client version
`GcGetPermissionAssignments`	`assignEnabled(String theEnabled)` assign A for all, T or null for enabled only, F for disabled only
`GcGetPermissionAssignments`	`assignImmediateOnly(boolean theImmediateOnly)` T of F (defaults to F) if we should filter out non immediate permissions
`GcGetPermissionAssignments`	`assignIncludeAssignmentsOnAssignments(Boolean theIncludeAssignmentsOnAssignments)`
`GcGetPermissionAssignments`	`assignIncludeAttributeAssignments(Boolean theIncludeAttributeAssignments)` T or F for it attribute assignments should be returned
`GcGetPermissionAssignments`	`assignIncludeAttributeDefNames(Boolean theIncludeAttributeDefNames)` T or F for if attributeDefName objects should be returned
`GcGetPermissionAssignments`	`assignIncludeGroupDetail(Boolean theIncludeGroupDetail)` assign if the group detail should be included
`GcGetPermissionAssignments`	`assignIncludePermissionAssignDetail(Boolean theIncludePermissionAssignDetail)` T or F for if the permission details should be returned
`GcGetPermissionAssignments`	`assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)` if should include subject detail
`GcGetPermissionAssignments`	`assignPermissionProcessor(String thePermissionProcessor)` if we should find the best answer, or process limits, etc.
`GcGetPermissionAssignments`	`assignPermissionType(String thePermissionType)` are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
`GcGetPermissionAssignments`	`assignPointInTimeFrom(Timestamp pointInTimeFrom)` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
`GcGetPermissionAssignments`	`assignPointInTimeTo(Timestamp pointInTimeTo)` To query permissions at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
`GcGetPermissionAssignments`	`assignWsEndpoint(String theWsEndpoint)` endpoint to grouper WS, e.g.
`GcGetPermissionAssignments`	`assignWsPass(String theWsPass)` ws pass
`GcGetPermissionAssignments`	`assignWsPassEncrypted(String theWsPassEncrypted)` ws pass
`GcGetPermissionAssignments`	`assignWsPassFile(File theFile)` ws pass
`GcGetPermissionAssignments`	`assignWsPassFileEncrypted(File theFile)` ws pass
`GcGetPermissionAssignments`	`assignWsUser(String theWsUser)` ws user
`WsGetPermissionAssignmentsResults`	`execute()` execute the call and return the results.

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

- Constructor Detail
  - GcGetPermissionAssignments
```
public GcGetPermissionAssignments()
```
- Method Detail
  - assignWsEndpoint
```
public GcGetPermissionAssignments assignWsEndpoint(String theWsEndpoint)
```
    endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest
    
    Parameters:
    
    theWsEndpoint -
    
    Returns:
    
    this for chaining
  - assignWsUser
```
public GcGetPermissionAssignments assignWsUser(String theWsUser)
```
    ws user
    
    Parameters:
    
    theWsUser -
    
    Returns:
    
    this for chaining
  - assignWsPass
```
public GcGetPermissionAssignments assignWsPass(String theWsPass)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassEncrypted
```
public GcGetPermissionAssignments assignWsPassEncrypted(String theWsPassEncrypted)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassFile
```
public GcGetPermissionAssignments assignWsPassFile(File theFile)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassFileEncrypted
```
public GcGetPermissionAssignments assignWsPassFileEncrypted(File theFile)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignImmediateOnly
```
public GcGetPermissionAssignments assignImmediateOnly(boolean theImmediateOnly)
```
    T of F (defaults to F) if we should filter out non immediate permissions
    
    Parameters:
    
    theImmediateOnly -
    
    Returns:
    
    this for chaining
  - assignPermissionType
```
public GcGetPermissionAssignments assignPermissionType(String thePermissionType)
```
    are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject. defaults to role_subject permissions
    
    Parameters:
    
    thePermissionType -
    
    Returns:
    
    this for chaining
  - assignPermissionProcessor
```
public GcGetPermissionAssignments assignPermissionProcessor(String thePermissionProcessor)
```
    if we should find the best answer, or process limits, etc. From the enum PermissionProcessor. example values are: FILTER_REDUNDANT_PERMISSIONS, FILTER_REDUNDANT_PERMISSIONS_AND_PROCESS_LIMITS, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES, FILTER_REDUNDANT_PERMISSIONS_AND_ROLES_AND_PROCESS_LIMITS, PROCESS_LIMITS
    
    Parameters:
    
    thePermissionProcessor -
    
    Returns:
    
    this for chaining
  - addPermissionEnvVar
```
public GcGetPermissionAssignments addPermissionEnvVar(WsPermissionEnvVar wsPermissionEnvVar)
```
    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:
    
    wsPermissionEnvVar -
    
    Returns:
    
    this for chaining
  - addPermissionEnvVar
```
public GcGetPermissionAssignments addPermissionEnvVar(String envVarName,
                                                      String envVarValue,
                                                      String envVarType)
```
    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:
    
    envVarName -
    
    envVarValue -
    
    envVarType -
    
    Returns:
    
    this for chaining
  - assignPointInTimeFrom
```
public GcGetPermissionAssignments assignPointInTimeFrom(Timestamp pointInTimeFrom)
```
    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.
    
    Parameters:
    
    pointInTimeFrom -
    
    Returns:
    
    this for chaining
  - assignPointInTimeTo
```
public GcGetPermissionAssignments assignPointInTimeTo(Timestamp pointInTimeTo)
```
    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.
    
    Parameters:
    
    pointInTimeTo -
    
    Returns:
    
    this for chaining
  - assignIncludeAssignmentsOnAssignments
```
public GcGetPermissionAssignments assignIncludeAssignmentsOnAssignments(Boolean theIncludeAssignmentsOnAssignments)
```
    Parameters:
    
    theIncludeAssignmentsOnAssignments -
    
    Returns:
    
    this for chaining
  - addAction
```
public GcGetPermissionAssignments addAction(String action)
```
    Parameters:
    
    action -
    
    Returns:
    
    this for chaining
  - assignClientVersion
```
public GcGetPermissionAssignments assignClientVersion(String theClientVersion)
```
    assign client version
    
    Parameters:
    
    theClientVersion -
    
    Returns:
    
    this for chaining
  - addRoleName
```
public GcGetPermissionAssignments addRoleName(String theRoleName)
```
    set the role name
    
    Parameters:
    
    theRoleName -
    
    Returns:
    
    this for chaining
  - addRoleIdIndex
```
public GcGetPermissionAssignments addRoleIdIndex(Long theRoleIdIndex)
```
    set the role id index
    
    Parameters:
    
    theRoleIdIndex -
    
    Returns:
    
    this for chaining
  - addSubjectLookup
```
public GcGetPermissionAssignments addSubjectLookup(WsSubjectLookup wsSubjectLookup)
```
    set the subject lookup
    
    Parameters:
    
    wsSubjectLookup -
    
    Returns:
    
    this for chaining
  - addRoleUuid
```
public GcGetPermissionAssignments addRoleUuid(String theRoleUuid)
```
    set the role uuid
    
    Parameters:
    
    theRoleUuid -
    
    Returns:
    
    this for chaining
  - addParam
```
public GcGetPermissionAssignments addParam(String paramName,
                                           String paramValue)
```
    add a param to the list
    
    Parameters:
    
    paramName -
    
    paramValue -
    
    Returns:
    
    this for chaining
  - addParam
```
public GcGetPermissionAssignments addParam(WsParam wsParam)
```
    add a param to the list
    
    Parameters:
    
    wsParam -
    
    Returns:
    
    this for chaining
  - assignActAsSubject
```
public GcGetPermissionAssignments assignActAsSubject(WsSubjectLookup theActAsSubject)
```
    assign the act as subject if any
    
    Parameters:
    
    theActAsSubject -
    
    Returns:
    
    this for chaining
  - assignIncludeAttributeAssignments
```
public GcGetPermissionAssignments assignIncludeAttributeAssignments(Boolean theIncludeAttributeAssignments)
```
    T or F for it attribute assignments should be returned
    
    Parameters:
    
    theIncludeAttributeAssignments -
    
    Returns:
    
    this for chaining
  - assignIncludeAttributeDefNames
```
public GcGetPermissionAssignments assignIncludeAttributeDefNames(Boolean theIncludeAttributeDefNames)
```
    T or F for if attributeDefName objects should be returned
    
    Parameters:
    
    theIncludeAttributeDefNames -
    
    Returns:
    
    this for chaining
  - assignIncludePermissionAssignDetail
```
public GcGetPermissionAssignments assignIncludePermissionAssignDetail(Boolean theIncludePermissionAssignDetail)
```
    T or F for if the permission details should be returned
    
    Parameters:
    
    theIncludePermissionAssignDetail -
    
    Returns:
    
    this for chaining
  - addSubjectAttributeName
```
public GcGetPermissionAssignments addSubjectAttributeName(String subjectAttributeName)
```
    Parameters:
    
    subjectAttributeName -
    
    Returns:
    
    this for chaining
  - assignIncludeGroupDetail
```
public GcGetPermissionAssignments assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
```
    assign if the group detail should be included
    
    Parameters:
    
    theIncludeGroupDetail -
    
    Returns:
    
    this for chaining
  - assignIncludeSubjectDetail
```
public GcGetPermissionAssignments assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
```
    if should include subject detail
    
    Parameters:
    
    theIncludeSubjectDetail -
    
    Returns:
    
    this for chaining
  - execute
```
public WsGetPermissionAssignmentsResults execute()
```
    execute the call and return the results. If there is a problem calling the service, an exception will be thrown
    
    Returns:
    
    the results
  - assignEnabled
```
public GcGetPermissionAssignments assignEnabled(String theEnabled)
```
    assign A for all, T or null for enabled only, F for disabled only
    
    Parameters:
    
    theEnabled -
    
    Returns:
    
    this for chaining
  - addAttributeDefName
```
public GcGetPermissionAssignments addAttributeDefName(String theAttributeDefName)
```
    set the attributedef name
    
    Parameters:
    
    theAttributeDefName -
    
    Returns:
    
    this for chaining
  - addAttributeDefUuid
```
public GcGetPermissionAssignments addAttributeDefUuid(String theAttributeDefUuid)
```
    set the attributedef uuid
    
    Parameters:
    
    theAttributeDefUuid -
    
    Returns:
    
    this for chaining
  - addAttributeDefIdIndex
```
public GcGetPermissionAssignments addAttributeDefIdIndex(Long theAttributeDefIdIndex)
```
    set the attributedef id index
    
    Parameters:
    
    theAttributeDefIdIndex -
    
    Returns:
    
    this for chaining
  - addAttributeDefNameName
```
public GcGetPermissionAssignments addAttributeDefNameName(String theAttributeDefNameName)
```
    set the attributeDefName name
    
    Parameters:
    
    theAttributeDefNameName -
    
    Returns:
    
    this for chaining
  - addAttributeDefNameUuid
```
public GcGetPermissionAssignments addAttributeDefNameUuid(String theAttributeDefNameUuid)
```
    set the attributeDefName uuid
    
    Parameters:
    
    theAttributeDefNameUuid -
    
    Returns:
    
    this for chaining
  - addAttributeDefNameIdIndex
```
public GcGetPermissionAssignments addAttributeDefNameIdIndex(Long theAttributeDefNameIdIndex)
```
    set the attributeDefName id index
    
    Parameters:
    
    theAttributeDefNameIdIndex -
    
    Returns:
    
    this for chaining

Class GcGetPermissionAssignments

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GcGetPermissionAssignments

Method Detail

assignWsEndpoint

assignWsUser

assignWsPass

assignWsPassEncrypted

assignWsPassFile

assignWsPassFileEncrypted

assignImmediateOnly

assignPermissionType

assignPermissionProcessor

addPermissionEnvVar

addPermissionEnvVar

assignPointInTimeFrom

assignPointInTimeTo

assignIncludeAssignmentsOnAssignments

addAction

assignClientVersion

addRoleName

addRoleIdIndex

addSubjectLookup

addRoleUuid

addParam

addParam

assignActAsSubject

assignIncludeAttributeAssignments

assignIncludeAttributeDefNames

assignIncludePermissionAssignDetail

addSubjectAttributeName

assignIncludeGroupDetail

assignIncludeSubjectDetail

execute

assignEnabled

addAttributeDefName

addAttributeDefUuid

addAttributeDefIdIndex

addAttributeDefNameName

addAttributeDefNameUuid

addAttributeDefNameIdIndex