edu.internet2.middleware.grouperClient.api
Class GcFindAttributeDefNames

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

public class GcFindAttributeDefNames
extends Object

class to run find attributeDefNames


Constructor Summary
GcFindAttributeDefNames()
           
 
Method Summary
 GcFindAttributeDefNames addAttributeDefNameName(String theAttributeDefNameName)
          set the AttributeDefName name
 GcFindAttributeDefNames addAttributeDefNameUuid(String theAttributeDefNameUuid)
          set the AttributeDefName uuid
 GcFindAttributeDefNames addParam(String paramName, String paramValue)
          add a param to the list
 GcFindAttributeDefNames addParam(WsParam wsParam)
          add a param to the list
 GcFindAttributeDefNames assignActAsSubject(WsSubjectLookup theActAsSubject)
          assign the act as subject if any
 GcFindAttributeDefNames assignAscending(Boolean isAscending)
          assign if ascending if sorting
 GcFindAttributeDefNames assignAttributeAssignType(String theAttributeAssignType)
          where can the attribute definition be assigned, e.g.
 GcFindAttributeDefNames assignAttributeDefType(String theAttributeDefType)
          type of attribute definition, e.g.
 GcFindAttributeDefNames assignClientVersion(String theClientVersion)
          assign client version
 GcFindAttributeDefNames assignInheritanceSetRelation(String theInheritanceRelation)
          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.
 GcFindAttributeDefNames assignNameOfAttributeDef(String theNameOfAttributeDef)
          set the AttributeDef name
 GcFindAttributeDefNames assignPageNumber(Integer thePageNumber)
          assign page number if paging
 GcFindAttributeDefNames assignPageSize(Integer thePageSize)
          assign page size if paging
 GcFindAttributeDefNames assignScope(String theScope)
          search string with % as wildcards will search name, display name, description
 GcFindAttributeDefNames assignSortString(String theSortString)
          assign sort string if sorting, e.g.
 GcFindAttributeDefNames assignSplitScope(Boolean theSplitScope)
          T or F, if T will split the scope by whitespace, and find attribute def names with each token.
 GcFindAttributeDefNames assignUuidOfAttributeDef(String theUuidOfAttributeDef)
          set the AttributeDef uuid
 WsFindAttributeDefNamesResults 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

GcFindAttributeDefNames

public GcFindAttributeDefNames()
Method Detail

assignInheritanceSetRelation

public GcFindAttributeDefNames assignInheritanceSetRelation(String theInheritanceRelation)
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:
theInheritanceRelation -
Returns:
inheritance relation

assignAttributeDefType

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

Parameters:
theAttributeDefType -
Returns:
this for chaining

assignAttributeAssignType

public GcFindAttributeDefNames assignAttributeAssignType(String theAttributeAssignType)
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:
theAttributeAssignType -
Returns:
this for chaining

assignScope

public GcFindAttributeDefNames assignScope(String theScope)
search string with % as wildcards will search name, display name, description

Parameters:
theScope -
Returns:
scope

assignSplitScope

public GcFindAttributeDefNames assignSplitScope(Boolean theSplitScope)
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:
theSplitScope -
Returns:
the split scope

assignClientVersion

public GcFindAttributeDefNames assignClientVersion(String theClientVersion)
assign client version

Parameters:
theClientVersion -
Returns:
this for chaining

addParam

public GcFindAttributeDefNames addParam(String paramName,
                                        String paramValue)
add a param to the list

Parameters:
paramName -
paramValue -
Returns:
this for chaining

addParam

public GcFindAttributeDefNames addParam(WsParam wsParam)
add a param to the list

Parameters:
wsParam -
Returns:
this for chaining

assignActAsSubject

public GcFindAttributeDefNames assignActAsSubject(WsSubjectLookup theActAsSubject)
assign the act as subject if any

Parameters:
theActAsSubject -
Returns:
this for chaining

assignAscending

public GcFindAttributeDefNames assignAscending(Boolean isAscending)
assign if ascending if sorting

Parameters:
isAscending -
Returns:
this for paging

assignPageNumber

public GcFindAttributeDefNames assignPageNumber(Integer thePageNumber)
assign page number if paging

Parameters:
thePageNumber -
Returns:
this for chaining

assignPageSize

public GcFindAttributeDefNames assignPageSize(Integer thePageSize)
assign page size if paging

Parameters:
thePageSize -
Returns:
this for chaining

assignSortString

public GcFindAttributeDefNames assignSortString(String theSortString)
assign sort string if sorting, e.g. can sort on name, displayName, extension, displayExtension

Parameters:
theSortString -
Returns:
the sort string

execute

public WsFindAttributeDefNamesResults execute()
execute the call and return the results. If there is a problem calling the service, an exception will be thrown

Returns:
the results

addAttributeDefNameName

public GcFindAttributeDefNames addAttributeDefNameName(String theAttributeDefNameName)
set the AttributeDefName name

Parameters:
theAttributeDefNameName -
Returns:
this for chaining

addAttributeDefNameUuid

public GcFindAttributeDefNames addAttributeDefNameUuid(String theAttributeDefNameUuid)
set the AttributeDefName uuid

Parameters:
theAttributeDefNameUuid -
Returns:
this for chaining

assignNameOfAttributeDef

public GcFindAttributeDefNames assignNameOfAttributeDef(String theNameOfAttributeDef)
set the AttributeDef name

Parameters:
theNameOfAttributeDef -
Returns:
this for chaining

assignUuidOfAttributeDef

public GcFindAttributeDefNames assignUuidOfAttributeDef(String theUuidOfAttributeDef)
set the AttributeDef uuid

Parameters:
theUuidOfAttributeDef -
Returns:
this for chaining