edu.internet2.middleware.grouper.ws.rest.attribute
Class WsRestFindAttributeDefNamesLiteRequest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.attribute.WsRestFindAttributeDefNamesLiteRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestFindAttributeDefNamesLiteRequest
extends Object
implements WsRequestBean

request bean in body of rest request


Constructor Summary
WsRestFindAttributeDefNamesLiteRequest()
           
 
Method Summary
 String getActAsSubjectId()
          if acting as another user
 String getActAsSubjectIdentifier()
          if acting as another user
 String getActAsSubjectSourceId()
          if acting as another user
 String getAscending()
          ascending or null for ascending, F for descending.
 String getAttributeAssignType()
          where can the attribute definition be assigned, e.g.
 String getAttributeDefNameName()
          to lookup an attribute def name by name, mutually exclusive with attributeDefNameId
 String getAttributeDefNameUuid()
          to lookup an attribute def name by id, mutually exclusive with attributeDefNameName
 String getAttributeDefType()
          type of attribute definition, e.g.
 String getClientVersion()
          is the version of the client.
 String getNameOfAttributeDef()
          find names associated with this attribute definition, mutually exclusive with idOfAttributeDef
 String getPageNumber()
          page number 1 indexed if paging on a sort filter or parent
 String getPageSize()
          page size if paging on a sort filter or parent
 String getParamName0()
          reserved for future use
 String getParamName1()
          reserved for future use
 String getParamValue0()
          reserved for future use
 String getParamValue1()
          reserved for future use
 String getScope()
          search string with % as wildcards will search name, display name, description
 String getServiceRole()
          serviceRole to filter attributes that a user has a certain role
 String getSortString()
          must be an hql query field, e.g.
 String getSplitScope()
          splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.
 String getSubjectId()
          subjectId subject id if looking for privileges or service role
 String getSubjectIdentifier()
          subjectIdentifier subject identifier if looking for privileges or service role
 String getSubjectSourceId()
          subjectSourceId subject source id if looking for privileges or service role
 String getUuidOfAttributeDef()
          find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef
 String 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.
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectId(String actAsSubjectId1)
          if acting as another user
 void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
          if acting as another user
 void setActAsSubjectSourceId(String actAsSubjectSourceId1)
          if acting as another user
 void 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 attributeDefNameId
 void setAttributeDefNameUuid(String attributeDefNameUuid1)
          to lookup an attribute def name by id, mutually exclusive with attributeDefNameName
 void 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 idOfAttributeDef
 void setPageNumber(String pageNumber1)
          page number 1 indexed if paging on a sort filter or parent
 void setPageSize(String pageSize1)
          page size if paging on a sort filter or parent
 void setParamName0(String _paramName0)
          reserved for future use
 void setParamName1(String _paramName1)
          reserved for future use
 void setParamValue0(String _paramValue0)
          reserved for future use
 void setParamValue1(String _paramValue1)
          reserved for future use
 void setScope(String scope1)
          search string with % as wildcards will search name, display name, description
 void setServiceRole(String serviceRole1)
          serviceRole to filter attributes that a user has a certain role
 void 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 role
 void setSubjectIdentifier(String subjectIdentifier1)
          subjectIdentifier subject identifier if looking for privileges or service role
 void setSubjectSourceId(String subjectSourceId1)
          subjectSourceId subject source id if looking for privileges or service role
 void setUuidOfAttributeDef(String uuidOfAttributeDef1)
          find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef
 void 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.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestFindAttributeDefNamesLiteRequest

public WsRestFindAttributeDefNamesLiteRequest()
Method Detail

getSubjectId

public String getSubjectId()
subjectId subject id if looking for privileges or service role

Returns:
subjectId

setSubjectId

public void setSubjectId(String subjectId1)
subjectId subject id if looking for privileges or service role

Parameters:
subjectId1 -

getSubjectSourceId

public String getSubjectSourceId()
subjectSourceId subject source id if looking for privileges or service role

Returns:
subject source id

setSubjectSourceId

public void setSubjectSourceId(String subjectSourceId1)
subjectSourceId subject source id if looking for privileges or service role

Parameters:
subjectSourceId1 -

getSubjectIdentifier

public String getSubjectIdentifier()
subjectIdentifier subject identifier if looking for privileges or service role

Returns:
subjectIdentifier

setSubjectIdentifier

public void setSubjectIdentifier(String subjectIdentifier1)
subjectIdentifier subject identifier if looking for privileges or service role

Parameters:
subjectIdentifier1 -

getServiceRole

public String getServiceRole()
serviceRole to filter attributes that a user has a certain role

Returns:
serviceRole

setServiceRole

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

Parameters:
serviceRole1 -

getScope

public String getScope()
search string with % as wildcards will search name, display name, description

Returns:
the scope

setScope

public void setScope(String scope1)
search string with % as wildcards will search name, display name, description

Parameters:
scope1 - the scope to set

getSplitScope

public String 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

public void setSplitScope(String splitScope1)
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

public String 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

public void setAttributeAssignType(String attributeAssignType1)
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

public String getAttributeDefType()
type of attribute definition, e.g. attr, domain, limit, perm, type

Returns:
the attributeDefType

setAttributeDefType

public void setAttributeDefType(String attributeDefType1)
type of attribute definition, e.g. attr, domain, limit, perm, type

Parameters:
attributeDefType1 - the attributeDefType to set

getPageSize

public String getPageSize()
page size if paging on a sort filter or parent

Returns:
the pageSize

setPageSize

public void setPageSize(String pageSize1)
page size if paging on a sort filter or parent

Parameters:
pageSize1 - the pageSize to set

getPageNumber

public String getPageNumber()
page number 1 indexed if paging on a sort filter or parent

Returns:
the pageNumber

setPageNumber

public void setPageNumber(String pageNumber1)
page number 1 indexed if paging on a sort filter or parent

Parameters:
pageNumber1 - the pageNumber to set

getSortString

public String getSortString()
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Returns:
the sortString

setSortString

public void setSortString(String sortString1)
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:
sortString1 - the sortString to set

getAscending

public String getAscending()
ascending or null for ascending, F for descending.

Returns:
the ascending

setAscending

public void setAscending(String ascending1)
ascending or null for ascending, F for descending.

Parameters:
ascending1 - the ascending to set

getWsInheritanceSetRelation

public String 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

public void 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. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE

Parameters:
wsInheritanceSetRelation1 - the wsInheritanceSetRelation to set

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 String getClientVersion()
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Returns:
version

setClientVersion

public void setClientVersion(String clientVersion1)
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Parameters:
clientVersion1 -

getUuidOfAttributeDef

public String getUuidOfAttributeDef()
find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef

Returns:
the uuidOfAttributeDef

setUuidOfAttributeDef

public void setUuidOfAttributeDef(String uuidOfAttributeDef1)
find names associated with this attribute definition, mutually exclusive with nameOfAttributeDef

Parameters:
uuidOfAttributeDef1 - the uuidOfAttributeDef to set

getNameOfAttributeDef

public String getNameOfAttributeDef()
find names associated with this attribute definition, mutually exclusive with idOfAttributeDef

Returns:
the nameOfAttributeDef

setNameOfAttributeDef

public void setNameOfAttributeDef(String nameOfAttributeDef1)
find names associated with this attribute definition, mutually exclusive with idOfAttributeDef

Parameters:
nameOfAttributeDef1 - the nameOfAttributeDef to set

getAttributeDefNameUuid

public String getAttributeDefNameUuid()
to lookup an attribute def name by id, mutually exclusive with attributeDefNameName

Returns:
the attributeDefNameUuid

setAttributeDefNameUuid

public void setAttributeDefNameUuid(String attributeDefNameUuid1)
to lookup an attribute def name by id, mutually exclusive with attributeDefNameName

Parameters:
attributeDefNameUuid1 - the attributeDefNameUuid to set

getAttributeDefNameName

public String getAttributeDefNameName()
to lookup an attribute def name by name, mutually exclusive with attributeDefNameId

Returns:
the attributeDefNameName

setAttributeDefNameName

public void setAttributeDefNameName(String attributeDefNameName1)
to lookup an attribute def name by name, mutually exclusive with attributeDefNameId

Parameters:
attributeDefNameName1 - the attributeDefNameName to set

getActAsSubjectId

public String getActAsSubjectId()
if acting as another user

Returns:
id

getActAsSubjectIdentifier

public String getActAsSubjectIdentifier()
if acting as another user

Returns:
subject identifier

getActAsSubjectSourceId

public String getActAsSubjectSourceId()
if acting as another user

Returns:
source id

getParamName0

public String getParamName0()
reserved for future use

Returns:
param name 0

getParamName1

public String getParamName1()
reserved for future use

Returns:
paramname1

getParamValue0

public String getParamValue0()
reserved for future use

Returns:
param value 0

getParamValue1

public String getParamValue1()
reserved for future use

Returns:
param value 1

setActAsSubjectId

public void setActAsSubjectId(String actAsSubjectId1)
if acting as another user

Parameters:
actAsSubjectId1 -

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
if acting as another user

Parameters:
actAsSubjectIdentifier1 -

setActAsSubjectSourceId

public void setActAsSubjectSourceId(String actAsSubjectSourceId1)
if acting as another user

Parameters:
actAsSubjectSourceId1 -

setParamName0

public void setParamName0(String _paramName0)
reserved for future use

Parameters:
_paramName0 -

setParamName1

public void setParamName1(String _paramName1)
reserved for future use

Parameters:
_paramName1 -

setParamValue0

public void setParamValue0(String _paramValue0)
reserved for future use

Parameters:
_paramValue0 -

setParamValue1

public void setParamValue1(String _paramValue1)
reserved for future use

Parameters:
_paramValue1 -