edu.internet2.middleware.grouperClient.api
Class GcGetPermissionAssignments

java.lang.Object
  extended by edu.internet2.middleware.grouperClient.api.GcGetPermissionAssignments

public class GcGetPermissionAssignments
extends java.lang.Object

class to run a get permission assignments web service call


Constructor Summary
GcGetPermissionAssignments()
           
 
Method Summary
 GcGetPermissionAssignments addAction(java.lang.String action)
           
 GcGetPermissionAssignments addAttributeDefIdIndex(java.lang.Long theAttributeDefIdIndex)
          set the attributedef id index
 GcGetPermissionAssignments addAttributeDefName(java.lang.String theAttributeDefName)
          set the attributedef name
 GcGetPermissionAssignments addAttributeDefNameIdIndex(java.lang.Long theAttributeDefNameIdIndex)
          set the attributeDefName id index
 GcGetPermissionAssignments addAttributeDefNameName(java.lang.String theAttributeDefNameName)
          set the attributeDefName name
 GcGetPermissionAssignments addAttributeDefNameUuid(java.lang.String theAttributeDefNameUuid)
          set the attributeDefName uuid
 GcGetPermissionAssignments addAttributeDefUuid(java.lang.String theAttributeDefUuid)
          set the attributedef uuid
 GcGetPermissionAssignments addParam(java.lang.String paramName, java.lang.String paramValue)
          add a param to the list
 GcGetPermissionAssignments addParam(WsParam wsParam)
          add a param to the list
 GcGetPermissionAssignments addPermissionEnvVar(java.lang.String envVarName, java.lang.String envVarValue, java.lang.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(java.lang.Long theRoleIdIndex)
          set the role id index
 GcGetPermissionAssignments addRoleName(java.lang.String theRoleName)
          set the role name
 GcGetPermissionAssignments addRoleUuid(java.lang.String theRoleUuid)
          set the role uuid
 GcGetPermissionAssignments addSubjectAttributeName(java.lang.String subjectAttributeName)
           
 GcGetPermissionAssignments addSubjectLookup(WsSubjectLookup wsSubjectLookup)
          set the subject lookup
 GcGetPermissionAssignments assignActAsSubject(WsSubjectLookup theActAsSubject)
          assign the act as subject if any
 GcGetPermissionAssignments assignClientVersion(java.lang.String theClientVersion)
          assign client version
 GcGetPermissionAssignments assignEnabled(java.lang.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(java.lang.Boolean theIncludeAssignmentsOnAssignments)
           
 GcGetPermissionAssignments assignIncludeAttributeAssignments(java.lang.Boolean theIncludeAttributeAssignments)
          T or F for it attribute assignments should be returned
 GcGetPermissionAssignments assignIncludeAttributeDefNames(java.lang.Boolean theIncludeAttributeDefNames)
          T or F for if attributeDefName objects should be returned
 GcGetPermissionAssignments assignIncludeGroupDetail(java.lang.Boolean theIncludeGroupDetail)
          assign if the group detail should be included
 GcGetPermissionAssignments assignIncludePermissionAssignDetail(java.lang.Boolean theIncludePermissionAssignDetail)
          T or F for if the permission details should be returned
 GcGetPermissionAssignments assignIncludeSubjectDetail(java.lang.Boolean theIncludeSubjectDetail)
          if should include subject detail
 GcGetPermissionAssignments assignPermissionProcessor(java.lang.String thePermissionProcessor)
          if we should find the best answer, or process limits, etc.
 GcGetPermissionAssignments assignPermissionType(java.lang.String thePermissionType)
          are we looking for role permissions or subject permissions? from enum PermissionType: role, or role_subject.
 GcGetPermissionAssignments assignPointInTimeFrom(java.sql.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(java.sql.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.
 WsGetPermissionAssignmentsResults execute()
          execute the call and return the results.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GcGetPermissionAssignments

public GcGetPermissionAssignments()
Method Detail

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(java.lang.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(java.lang.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(java.lang.String envVarName,
                                                      java.lang.String envVarValue,
                                                      java.lang.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(java.sql.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(java.sql.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(java.lang.Boolean theIncludeAssignmentsOnAssignments)
Parameters:
theIncludeAssignmentsOnAssignments -
Returns:
this for chaining

addAction

public GcGetPermissionAssignments addAction(java.lang.String action)
Parameters:
action -
Returns:
this for chaining

assignClientVersion

public GcGetPermissionAssignments assignClientVersion(java.lang.String theClientVersion)
assign client version

Parameters:
theClientVersion -
Returns:
this for chaining

addRoleName

public GcGetPermissionAssignments addRoleName(java.lang.String theRoleName)
set the role name

Parameters:
theRoleName -
Returns:
this for chaining

addRoleIdIndex

public GcGetPermissionAssignments addRoleIdIndex(java.lang.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(java.lang.String theRoleUuid)
set the role uuid

Parameters:
theRoleUuid -
Returns:
this for chaining

addParam

public GcGetPermissionAssignments addParam(java.lang.String paramName,
                                           java.lang.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(java.lang.Boolean theIncludeAttributeAssignments)
T or F for it attribute assignments should be returned

Parameters:
theIncludeAttributeAssignments -
Returns:
this for chaining

assignIncludeAttributeDefNames

public GcGetPermissionAssignments assignIncludeAttributeDefNames(java.lang.Boolean theIncludeAttributeDefNames)
T or F for if attributeDefName objects should be returned

Parameters:
theIncludeAttributeDefNames -
Returns:
this for chaining

assignIncludePermissionAssignDetail

public GcGetPermissionAssignments assignIncludePermissionAssignDetail(java.lang.Boolean theIncludePermissionAssignDetail)
T or F for if the permission details should be returned

Parameters:
theIncludePermissionAssignDetail -
Returns:
this for chaining

addSubjectAttributeName

public GcGetPermissionAssignments addSubjectAttributeName(java.lang.String subjectAttributeName)
Parameters:
subjectAttributeName -
Returns:
this for chaining

assignIncludeGroupDetail

public GcGetPermissionAssignments assignIncludeGroupDetail(java.lang.Boolean theIncludeGroupDetail)
assign if the group detail should be included

Parameters:
theIncludeGroupDetail -
Returns:
this for chaining

assignIncludeSubjectDetail

public GcGetPermissionAssignments assignIncludeSubjectDetail(java.lang.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(java.lang.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(java.lang.String theAttributeDefName)
set the attributedef name

Parameters:
theAttributeDefName -
Returns:
this for chaining

addAttributeDefUuid

public GcGetPermissionAssignments addAttributeDefUuid(java.lang.String theAttributeDefUuid)
set the attributedef uuid

Parameters:
theAttributeDefUuid -
Returns:
this for chaining

addAttributeDefIdIndex

public GcGetPermissionAssignments addAttributeDefIdIndex(java.lang.Long theAttributeDefIdIndex)
set the attributedef id index

Parameters:
theAttributeDefIdIndex -
Returns:
this for chaining

addAttributeDefNameName

public GcGetPermissionAssignments addAttributeDefNameName(java.lang.String theAttributeDefNameName)
set the attributeDefName name

Parameters:
theAttributeDefNameName -
Returns:
this for chaining

addAttributeDefNameUuid

public GcGetPermissionAssignments addAttributeDefNameUuid(java.lang.String theAttributeDefNameUuid)
set the attributeDefName uuid

Parameters:
theAttributeDefNameUuid -
Returns:
this for chaining

addAttributeDefNameIdIndex

public GcGetPermissionAssignments addAttributeDefNameIdIndex(java.lang.Long theAttributeDefNameIdIndex)
set the attributeDefName id index

Parameters:
theAttributeDefNameIdIndex -
Returns:
this for chaining