Class WsRestFindAttributeDefNamesLiteRequest
java.lang.Object
edu.internet2.middleware.grouper.ws.rest.attribute.WsRestFindAttributeDefNamesLiteRequest
- All Implemented Interfaces:
WsRequestBean
request bean in body of rest request
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionif acting as another userif acting as another userif acting as another userascending or null for ascending, F for descending.where can the attribute definition be assigned, e.g.to lookup an attribute def name by name, mutually exclusive with attributeDefNameIdto lookup an attribute def name by id, mutually exclusive with attributeDefNameNametype of attribute definition, e.g.is the version of the client.find names associated with this attribute definition, mutually exclusive with idOfAttributeDefpage number 1 indexed if paging on a sort filter or parentpage size if paging on a sort filter or parentreserved for future usereserved for future usereserved for future usereserved for future usegetScope()
search string with % as wildcards will search name, display name, descriptionserviceRole to filter attributes that a user has a certain rolemust be an hql query field, e.g.splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.subjectId subject id if looking for privileges or service rolesubjectIdentifier subject identifier if looking for privileges or service rolesubjectSourceId subject source id if looking for privileges or service rolefind names associated with this attribute definition, mutually exclusive with nameOfAttributeDefwsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g.see which http method this is supposed to be associated with, and override whatever was passed invoid
setActAsSubjectId
(String actAsSubjectId1) if acting as another uservoid
setActAsSubjectIdentifier
(String actAsSubjectIdentifier1) if acting as another uservoid
setActAsSubjectSourceId
(String actAsSubjectSourceId1) if acting as another uservoid
setAscending
(String ascending1) ascending or null for ascending, F for descending.void
setAttributeAssignType
(String attributeAssignType1) where can the attribute definition be assigned, e.g.void
setAttributeDefNameName
(String attributeDefNameName1) to lookup an attribute def name by name, mutually exclusive with attributeDefNameIdvoid
setAttributeDefNameUuid
(String attributeDefNameUuid1) to lookup an attribute def name by id, mutually exclusive with attributeDefNameNamevoid
setAttributeDefType
(String attributeDefType1) type of attribute definition, e.g.void
setClientVersion
(String clientVersion1) is the version of the client.void
setNameOfAttributeDef
(String nameOfAttributeDef1) find names associated with this attribute definition, mutually exclusive with idOfAttributeDefvoid
setPageCursorFieldIncludesLastRetrieved
(String pageCursorFieldIncludesLastRetrieved1) void
setPageIsCursor
(String pageIsCursor1) void
setPageLastCursorField
(String pageLastCursorField1) void
setPageLastCursorFieldType
(String pageLastCursorFieldType1) void
setPageNumber
(String pageNumber1) page number 1 indexed if paging on a sort filter or parentvoid
setPageSize
(String pageSize1) page size if paging on a sort filter or parentvoid
setParamName0
(String _paramName0) reserved for future usevoid
setParamName1
(String _paramName1) reserved for future usevoid
setParamValue0
(String _paramValue0) reserved for future usevoid
setParamValue1
(String _paramValue1) reserved for future usevoid
search string with % as wildcards will search name, display name, descriptionvoid
setServiceRole
(String serviceRole1) serviceRole to filter attributes that a user has a certain rolevoid
setSortString
(String sortString1) must be an hql query field, e.g.void
setSplitScope
(String splitScope1) splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.void
setSubjectId
(String subjectId1) subjectId subject id if looking for privileges or service rolevoid
setSubjectIdentifier
(String subjectIdentifier1) subjectIdentifier subject identifier if looking for privileges or service rolevoid
setSubjectSourceId
(String subjectSourceId1) subjectSourceId subject source id if looking for privileges or service rolevoid
setUuidOfAttributeDef
(String uuidOfAttributeDef1) find names associated with this attribute definition, mutually exclusive with nameOfAttributeDefvoid
setWsInheritanceSetRelation
(String wsInheritanceSetRelation1) wsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g.
-
Constructor Details
-
WsRestFindAttributeDefNamesLiteRequest
public WsRestFindAttributeDefNamesLiteRequest()
-
-
Method Details
-
getSubjectId
subjectId subject id if looking for privileges or service role- Returns:
- subjectId
-
setSubjectId
subjectId subject id if looking for privileges or service role- Parameters:
subjectId1
-
-
getSubjectSourceId
subjectSourceId subject source id if looking for privileges or service role- Returns:
- subject source id
-
setSubjectSourceId
subjectSourceId subject source id if looking for privileges or service role- Parameters:
subjectSourceId1
-
-
getSubjectIdentifier
subjectIdentifier subject identifier if looking for privileges or service role- Returns:
- subjectIdentifier
-
setSubjectIdentifier
subjectIdentifier subject identifier if looking for privileges or service role- Parameters:
subjectIdentifier1
-
-
getServiceRole
serviceRole to filter attributes that a user has a certain role- Returns:
- serviceRole
-
setServiceRole
serviceRole to filter attributes that a user has a certain role- Parameters:
serviceRole1
-
-
getScope
search string with % as wildcards will search name, display name, description- Returns:
- the scope
-
setScope
search string with % as wildcards will search name, display name, description- Parameters:
scope1
- the scope to set
-
getSplitScope
splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever- Returns:
- the splitScope
-
setSplitScope
splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever- Parameters:
splitScope1
- the splitScope to set
-
getAttributeAssignType
where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn- Returns:
- the attributeAssignType
-
setAttributeAssignType
where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn- Parameters:
attributeAssignType1
- the attributeAssignType to set
-
getAttributeDefType
type of attribute definition, e.g. attr, domain, limit, perm, type- Returns:
- the attributeDefType
-
setAttributeDefType
type of attribute definition, e.g. attr, domain, limit, perm, type- Parameters:
attributeDefType1
- the attributeDefType to set
-
getPageSize
page size if paging on a sort filter or parent- Returns:
- the pageSize
-
setPageSize
page size if paging on a sort filter or parent- Parameters:
pageSize1
- the pageSize to set
-
getPageNumber
page number 1 indexed if paging on a sort filter or parent- Returns:
- the pageNumber
-
setPageNumber
page number 1 indexed if paging on a sort filter or parent- Parameters:
pageNumber1
- the pageNumber to set
-
getSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Returns:
- the sortString
-
setSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
sortString1
- the sortString to set
-
getAscending
ascending or null for ascending, F for descending.- Returns:
- the ascending
-
setAscending
ascending or null for ascending, F for descending.- Parameters:
ascending1
- the ascending to set
-
getWsInheritanceSetRelation
wsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE- Returns:
- the wsInheritanceSetRelation
-
setWsInheritanceSetRelation
wsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE- Parameters:
wsInheritanceSetRelation1
- the wsInheritanceSetRelation to set
-
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 interfaceWsRequestBean
- Returns:
- the method
- See Also:
-
getClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Returns:
- version
-
setClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Parameters:
clientVersion1
-
-
getUuidOfAttributeDef
find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef- Returns:
- the uuidOfAttributeDef
-
setUuidOfAttributeDef
find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef- Parameters:
uuidOfAttributeDef1
- the uuidOfAttributeDef to set
-
getNameOfAttributeDef
find names associated with this attribute definition, mutually exclusive with idOfAttributeDef- Returns:
- the nameOfAttributeDef
-
setNameOfAttributeDef
find names associated with this attribute definition, mutually exclusive with idOfAttributeDef- Parameters:
nameOfAttributeDef1
- the nameOfAttributeDef to set
-
getAttributeDefNameUuid
to lookup an attribute def name by id, mutually exclusive with attributeDefNameName- Returns:
- the attributeDefNameUuid
-
setAttributeDefNameUuid
to lookup an attribute def name by id, mutually exclusive with attributeDefNameName- Parameters:
attributeDefNameUuid1
- the attributeDefNameUuid to set
-
getAttributeDefNameName
to lookup an attribute def name by name, mutually exclusive with attributeDefNameId- Returns:
- the attributeDefNameName
-
setAttributeDefNameName
to lookup an attribute def name by name, mutually exclusive with attributeDefNameId- Parameters:
attributeDefNameName1
- the attributeDefNameName to set
-
getActAsSubjectId
if acting as another user- Returns:
- id
-
getActAsSubjectIdentifier
if acting as another user- Returns:
- subject identifier
-
getActAsSubjectSourceId
if acting as another user- Returns:
- source id
-
getParamName0
reserved for future use- Returns:
- param name 0
-
getParamName1
reserved for future use- Returns:
- paramname1
-
getParamValue0
reserved for future use- Returns:
- param value 0
-
getParamValue1
reserved for future use- Returns:
- param value 1
-
setActAsSubjectId
if acting as another user- Parameters:
actAsSubjectId1
-
-
setActAsSubjectIdentifier
if acting as another user- Parameters:
actAsSubjectIdentifier1
-
-
setActAsSubjectSourceId
if acting as another user- Parameters:
actAsSubjectSourceId1
-
-
setParamName0
reserved for future use- Parameters:
_paramName0
-
-
setParamName1
reserved for future use- Parameters:
_paramName1
-
-
setParamValue0
reserved for future use- Parameters:
_paramValue0
-
-
setParamValue1
reserved for future use- Parameters:
_paramValue1
-
-
getPageIsCursor
- Returns:
- the pageIsCursor
-
setPageIsCursor
- Parameters:
pageIsCursor1
- the pageIsCursor to set
-
getPageLastCursorField
- Returns:
- the pageLastCursorField
-
setPageLastCursorField
- Parameters:
pageLastCursorField1
- the pageLastCursorField to set
-
getPageLastCursorFieldType
- Returns:
- the pageLastCursorFieldType
-
setPageLastCursorFieldType
- Parameters:
pageLastCursorFieldType1
- the pageLastCursorFieldType to set
-
getPageCursorFieldIncludesLastRetrieved
- Returns:
- the pageCursorFieldIncludesLastRetrieved
-
setPageCursorFieldIncludesLastRetrieved
- Parameters:
pageCursorFieldIncludesLastRetrieved1
- the pageCursorFieldIncludesLastRetrieved to set
-