edu.internet2.middleware.grouperClient.api

Class GcAssignAttributes

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcAssignAttributes

public class GcAssignAttributes
extends Object

class to run an assign attributes web service call

Constructor Summary

Constructors

Constructor and Description
GcAssignAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
GcAssignAttributes	addAction(String action)
GcAssignAttributes	addActionToReplace(String action) actions to replace
GcAssignAttributes	addAttributeAssignId(String attributeAssignId) add a attribute assign id lookup
GcAssignAttributes	addAttributeDefIdIndexToReplace(Long theAttributeDefIdIndex) set the attributeDef id index to replace
GcAssignAttributes	addAttributeDefNameIdIndex(Long theAttributeDefNameIdIndex) set the attributeDefName id index
GcAssignAttributes	addAttributeDefNameName(String theAttributeDefNameName) set the attributeDefName name
GcAssignAttributes	addAttributeDefNameToReplace(String theAttributeDefName) set the attributeDef name to replace
GcAssignAttributes	addAttributeDefNameUuid(String theAttributeDefNameUuid) set the attributeDefName uuid
GcAssignAttributes	addAttributeDefTypeToReplace(String attributeDefTypeToReplace) attribute def types to replace
GcAssignAttributes	addAttributeDefUuidToReplace(String theAttributeDefUuid) set the attributeDef uuid to replace
GcAssignAttributes	addOwnerAttributeAssignLookup(WsAttributeAssignLookup wsAttributeAssignLookup) for assignments on assignments
GcAssignAttributes	addOwnerAttributeDefIdIndex(Long theAttributeDefIdIndex) set the attribute def id index
GcAssignAttributes	addOwnerAttributeDefName(String theAttributeDefName) set the attribute def name
GcAssignAttributes	addOwnerAttributeDefUuid(String theAttributeDefUuid) set the attribute def uuid
GcAssignAttributes	addOwnerGroupIdIndex(Long theGroupIdIndex) set the group id index
GcAssignAttributes	addOwnerGroupName(String theGroupName) set the group name
GcAssignAttributes	addOwnerGroupUuid(String theGroupUuid) set the group uuid
GcAssignAttributes	addOwnerMembershipAnyLookup(WsMembershipAnyLookup wsMembershipAnyLookup) add a membership any lookup
GcAssignAttributes	addOwnerMembershipId(String membershipId) add a membership id lookup for owner
GcAssignAttributes	addOwnerStemIdIndex(Long theStemIdIndex) set the stem id index
GcAssignAttributes	addOwnerStemName(String theStemName) set the stem name
GcAssignAttributes	addOwnerStemUuid(String theStemUuid) set the stem uuid
GcAssignAttributes	addOwnerSubjectLookup(WsSubjectLookup wsSubjectLookup) set the subject lookup
GcAssignAttributes	addParam(String paramName, String paramValue) add a param to the list
GcAssignAttributes	addParam(WsParam wsParam) add a param to the list
GcAssignAttributes	addSubjectAttributeName(String subjectAttributeName)
GcAssignAttributes	addValue(WsAttributeAssignValue wsAttributeAssignValue) add a membership any lookup
GcAssignAttributes	assignActAsSubject(WsSubjectLookup theActAsSubject) assign the act as subject if any
GcAssignAttributes	assignAssignmentNotes(String theAssignmentNotes) notes on the assignment (optional)
GcAssignAttributes	assignAttributeAssignOperation(String theAttributeAssignOperation) operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr
GcAssignAttributes	assignAttributeAssignType(String theAttributeAssignType) Type of owner, from enum AttributeAssignType, e.g.
GcAssignAttributes	assignAttributeAssignValueOperation(String theAttributeAssignValueOperation) operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values
GcAssignAttributes	assignClientVersion(String theClientVersion) assign client version
GcAssignAttributes	assignDelegatable(String theDelegatable) really only for permissions, if the assignee can delegate to someone else.
GcAssignAttributes	assignDisabledTime(Timestamp theDisabledTime) disabled time, or null for not disabled
GcAssignAttributes	assignEnabledTime(Timestamp theEnabledTime) enabled time, or null for enabled
GcAssignAttributes	assignIncludeGroupDetail(Boolean theIncludeGroupDetail) assign if the group detail should be included
GcAssignAttributes	assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail) if should include subject detail
WsAssignAttributesResults	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

GcAssignAttributes

public GcAssignAttributes()

Method Detail

assignAttributeAssignType

public GcAssignAttributes assignAttributeAssignType(String theAttributeAssignType)

Type of owner, from enum AttributeAssignType, e.g. group, member, stem, any_mem, imm_mem, attr_def, group_asgn, mem_asgn, stem_asgn, any_mem_asgn, imm_mem_asgn, attr_def_asgn

Parameters:

theAttributeAssignType -

Returns:

this for chaining

addAction

public GcAssignAttributes addAction(String action)

Parameters:

action -

Returns:

this for chaining

assignClientVersion

public GcAssignAttributes assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

addOwnerGroupName

public GcAssignAttributes addOwnerGroupName(String theGroupName)

set the group name

Parameters:

theGroupName -

Returns:

this for chaining

addOwnerGroupIdIndex

public GcAssignAttributes addOwnerGroupIdIndex(Long theGroupIdIndex)

set the group id index

Parameters:

theGroupIdIndex -

Returns:

this for chaining

addOwnerSubjectLookup

public GcAssignAttributes addOwnerSubjectLookup(WsSubjectLookup wsSubjectLookup)

set the subject lookup

Parameters:

wsSubjectLookup -

Returns:

this for chaining

addOwnerGroupUuid

public GcAssignAttributes addOwnerGroupUuid(String theGroupUuid)

set the group uuid

Parameters:

theGroupUuid -

Returns:

this for chaining

addParam

public GcAssignAttributes addParam(String paramName,
                          String paramValue)

add a param to the list

Parameters:

paramName -

paramValue -

Returns:

this for chaining

addParam

public GcAssignAttributes addParam(WsParam wsParam)

add a param to the list

Parameters:

wsParam -

Returns:

this for chaining

assignActAsSubject

public GcAssignAttributes assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

addOwnerMembershipAnyLookup

public GcAssignAttributes addOwnerMembershipAnyLookup(WsMembershipAnyLookup wsMembershipAnyLookup)

add a membership any lookup

Parameters:

wsMembershipAnyLookup -

Returns:

this for chaining

addOwnerMembershipId

public GcAssignAttributes addOwnerMembershipId(String membershipId)

add a membership id lookup for owner

Parameters:

membershipId - id (uuid or immediate)

Returns:

this for chaining

addAttributeAssignId

public GcAssignAttributes addAttributeAssignId(String attributeAssignId)

add a attribute assign id lookup

Parameters:

attributeAssignId - id

Returns:

this for chaining

addSubjectAttributeName

public GcAssignAttributes addSubjectAttributeName(String subjectAttributeName)

Parameters:

subjectAttributeName -

Returns:

this for chaining

assignIncludeGroupDetail

public GcAssignAttributes assignIncludeGroupDetail(Boolean theIncludeGroupDetail)

assign if the group detail should be included

Parameters:

theIncludeGroupDetail -

Returns:

this for chaining

assignIncludeSubjectDetail

public GcAssignAttributes assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)

if should include subject detail

Parameters:

theIncludeSubjectDetail -

Returns:

this for chaining

execute

public WsAssignAttributesResults execute()

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

Returns:

the results

addOwnerStemName

public GcAssignAttributes addOwnerStemName(String theStemName)

set the stem name

Parameters:

theStemName -

Returns:

this for chaining

addOwnerStemUuid

public GcAssignAttributes addOwnerStemUuid(String theStemUuid)

set the stem uuid

Parameters:

theStemUuid -

Returns:

this for chaining

addOwnerStemIdIndex

public GcAssignAttributes addOwnerStemIdIndex(Long theStemIdIndex)

set the stem id index

Parameters:

theStemIdIndex -

Returns:

this for chaining

addOwnerAttributeDefName

public GcAssignAttributes addOwnerAttributeDefName(String theAttributeDefName)

set the attribute def name

Parameters:

theAttributeDefName -

Returns:

this for chaining

addOwnerAttributeDefUuid

public GcAssignAttributes addOwnerAttributeDefUuid(String theAttributeDefUuid)

set the attribute def uuid

Parameters:

theAttributeDefUuid -

Returns:

this for chaining

addOwnerAttributeDefIdIndex

public GcAssignAttributes addOwnerAttributeDefIdIndex(Long theAttributeDefIdIndex)

set the attribute def id index

Parameters:

theAttributeDefIdIndex -

Returns:

this for chaining

addAttributeDefNameName

public GcAssignAttributes addAttributeDefNameName(String theAttributeDefNameName)

set the attributeDefName name

Parameters:

theAttributeDefNameName -

Returns:

this for chaining

addAttributeDefNameUuid

public GcAssignAttributes addAttributeDefNameUuid(String theAttributeDefNameUuid)

set the attributeDefName uuid

Parameters:

theAttributeDefNameUuid -

Returns:

this for chaining

addAttributeDefNameIdIndex

public GcAssignAttributes addAttributeDefNameIdIndex(Long theAttributeDefNameIdIndex)

set the attributeDefName id index

Parameters:

theAttributeDefNameIdIndex -

Returns:

this for chaining

assignDisabledTime

public GcAssignAttributes assignDisabledTime(Timestamp theDisabledTime)

disabled time, or null for not disabled

Parameters:

theDisabledTime -

Returns:

this for chaining

assignEnabledTime

public GcAssignAttributes assignEnabledTime(Timestamp theEnabledTime)

enabled time, or null for enabled

Parameters:

theEnabledTime -

Returns:

this for chaining

assignAssignmentNotes

public GcAssignAttributes assignAssignmentNotes(String theAssignmentNotes)

notes on the assignment (optional)

Parameters:

theAssignmentNotes -

Returns:

this for chaining

assignAttributeAssignOperation

public GcAssignAttributes assignAttributeAssignOperation(String theAttributeAssignOperation)

operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr

Parameters:

theAttributeAssignOperation -

Returns:

this for chaining

assignAttributeAssignValueOperation

public GcAssignAttributes assignAttributeAssignValueOperation(String theAttributeAssignValueOperation)

operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values

Parameters:

theAttributeAssignValueOperation -

Returns:

this for chaining

assignDelegatable

public GcAssignAttributes assignDelegatable(String theDelegatable)

really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT

Parameters:

theDelegatable -

Returns:

this for chaining

addValue

public GcAssignAttributes addValue(WsAttributeAssignValue wsAttributeAssignValue)

add a membership any lookup

Parameters:

wsAttributeAssignValue -

Returns:

this for chaining

addOwnerAttributeAssignLookup

public GcAssignAttributes addOwnerAttributeAssignLookup(WsAttributeAssignLookup wsAttributeAssignLookup)

for assignments on assignments

Parameters:

wsAttributeAssignLookup -

Returns:

this for chaining

addAttributeDefNameToReplace

public GcAssignAttributes addAttributeDefNameToReplace(String theAttributeDefName)

set the attributeDef name to replace

Parameters:

theAttributeDefName -

Returns:

this for chaining

addAttributeDefUuidToReplace

public GcAssignAttributes addAttributeDefUuidToReplace(String theAttributeDefUuid)

set the attributeDef uuid to replace

Parameters:

theAttributeDefUuid -

Returns:

this for chaining

addAttributeDefIdIndexToReplace

public GcAssignAttributes addAttributeDefIdIndexToReplace(Long theAttributeDefIdIndex)

set the attributeDef id index to replace

Parameters:

theAttributeDefIdIndex -

Returns:

this for chaining

addActionToReplace

public GcAssignAttributes addActionToReplace(String action)

actions to replace

Parameters:

action -

Returns:

this for chaining

addAttributeDefTypeToReplace

public GcAssignAttributes addAttributeDefTypeToReplace(String attributeDefTypeToReplace)

attribute def types to replace

Parameters:

attributeDefTypeToReplace -

Returns:

this for chaining