GcAddMember (Grouper Client 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouperClient.api.GcAddMember

```
public class GcAddMember
extends Object
```
class to run an add member web service call

Constructor Summary

Constructors
Constructor and Description

GcAddMember()

Constructors
Constructor and Description
`GcAddMember()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GcAddMember`	`addParam(String paramName, String paramValue)` add a param to the list
`GcAddMember`	`addParam(WsParam wsParam)` add a param to the list
`GcAddMember`	`addSubjectAttributeName(String subjectAttributeName)`
`GcAddMember`	`addSubjectId(String subjectId)` add a subject lookup
`GcAddMember`	`addSubjectIdentifier(String subjectIdentifier)` add a subject lookup
`GcAddMember`	`addSubjectLookup(WsSubjectLookup wsSubjectLookup)` add a subject lookup
`GcAddMember`	`assignActAsSubject(WsSubjectLookup theActAsSubject)` assign the act as subject if any
`GcAddMember`	`assignAddExternalSubjectIfNotFound(Boolean theAssignAddExternalSubjectIfNotFound)` addExternalSubjectIfNotFound T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed
`GcAddMember`	`assignClientVersion(String theClientVersion)` assign client version
`void`	`assignDisabledTime(Timestamp theDisabledTime)` date this membership will be disabled, yyyy/MM/dd HH:mm:ss.SSS
`void`	`assignEnabledTime(Timestamp theEnabledTime)` date this membership will be enabled (for future provisioning), yyyy/MM/dd HH:mm:ss.SSS
`GcAddMember`	`assignFieldName(String theFieldName)` assign the field name to the request
`GcAddMember`	`assignGroupIdIndex(Long theGroupIdIndex)` set the group id index
`GcAddMember`	`assignGroupName(String theGroupName)` set the group name
`GcAddMember`	`assignGroupUuid(String theGroupUuid)` set the group uuid
`GcAddMember`	`assignIncludeGroupDetail(Boolean theIncludeGroupDetail)` assign if the group detail should be included
`GcAddMember`	`assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)` if should include subject detail
`GcAddMember`	`assignReplaceAllExisting(Boolean isReplaceAllExisting)` set if we should replace all existing members with new list
`GcAddMember`	`assignTxType(GcTransactionType gcTransactionType)` assign the tx type
`GcAddMember`	`assignWsEndpoint(String theWsEndpoint)` endpoint to grouper WS, e.g.
`GcAddMember`	`assignWsPass(String theWsPass)` ws pass
`GcAddMember`	`assignWsPassEncrypted(String theWsPassEncrypted)` ws pass
`GcAddMember`	`assignWsPassFile(File theFile)` ws pass
`GcAddMember`	`assignWsPassFileEncrypted(File theFile)` ws pass
`GcAddMember`	`assignWsUser(String theWsUser)` ws user
`WsAddMemberResults`	`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
  - GcAddMember
```
public GcAddMember()
```
- Method Detail
  - assignWsEndpoint
```
public GcAddMember assignWsEndpoint(String theWsEndpoint)
```
    endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest
    
    Parameters:
    
    theWsEndpoint -
    
    Returns:
    
    this for chaining
  - assignWsUser
```
public GcAddMember assignWsUser(String theWsUser)
```
    ws user
    
    Parameters:
    
    theWsUser -
    
    Returns:
    
    this for chaining
  - assignWsPass
```
public GcAddMember assignWsPass(String theWsPass)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassEncrypted
```
public GcAddMember assignWsPassEncrypted(String theWsPassEncrypted)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassFile
```
public GcAddMember assignWsPassFile(File theFile)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignWsPassFileEncrypted
```
public GcAddMember assignWsPassFileEncrypted(File theFile)
```
    ws pass
    
    Parameters:
    
    theWsPass -
    
    Returns:
    
    this for chaining
  - assignDisabledTime
```
public void assignDisabledTime(Timestamp theDisabledTime)
```
    date this membership will be disabled, yyyy/MM/dd HH:mm:ss.SSS
    
    Parameters:
    
    theDisabledTime -
  - assignEnabledTime
```
public void assignEnabledTime(Timestamp theEnabledTime)
```
    date this membership will be enabled (for future provisioning), yyyy/MM/dd HH:mm:ss.SSS
    
    Parameters:
    
    theEnabledTime -
  - assignGroupName
```
public GcAddMember assignGroupName(String theGroupName)
```
    set the group name
    
    Parameters:
    
    theGroupName -
    
    Returns:
    
    this for chaining
  - assignGroupUuid
```
public GcAddMember assignGroupUuid(String theGroupUuid)
```
    set the group uuid
    
    Parameters:
    
    theGroupUuid -
    
    Returns:
    
    this for chaining
  - assignGroupIdIndex
```
public GcAddMember assignGroupIdIndex(Long theGroupIdIndex)
```
    set the group id index
    
    Parameters:
    
    theGroupIdIndex -
    
    Returns:
    
    this for chaining
  - addParam
```
public GcAddMember addParam(String paramName,
                            String paramValue)
```
    add a param to the list
    
    Parameters:
    
    paramName -
    
    paramValue -
    
    Returns:
    
    this for chaining
  - addParam
```
public GcAddMember addParam(WsParam wsParam)
```
    add a param to the list
    
    Parameters:
    
    wsParam -
    
    Returns:
    
    this for chaining
  - addSubjectLookup
```
public GcAddMember addSubjectLookup(WsSubjectLookup wsSubjectLookup)
```
    add a subject lookup
    
    Parameters:
    
    wsSubjectLookup -
    
    Returns:
    
    this for chaining
  - addSubjectId
```
public GcAddMember addSubjectId(String subjectId)
```
    add a subject lookup
    
    Parameters:
    
    subjectId -
    
    Returns:
    
    this for chaining
  - addSubjectIdentifier
```
public GcAddMember addSubjectIdentifier(String subjectIdentifier)
```
    add a subject lookup
    
    Parameters:
    
    subjectIdentifier -
    
    Returns:
    
    this for chaining
  - assignReplaceAllExisting
```
public GcAddMember assignReplaceAllExisting(Boolean isReplaceAllExisting)
```
    set if we should replace all existing members with new list
    
    Parameters:
    
    isReplaceAllExisting -
    
    Returns:
    
    this for chaining
  - assignActAsSubject
```
public GcAddMember assignActAsSubject(WsSubjectLookup theActAsSubject)
```
    assign the act as subject if any
    
    Parameters:
    
    theActAsSubject -
    
    Returns:
    
    this for chaining
  - assignFieldName
```
public GcAddMember assignFieldName(String theFieldName)
```
    assign the field name to the request
    
    Parameters:
    
    theFieldName -
    
    Returns:
    
    this for chaining
  - assignTxType
```
public GcAddMember assignTxType(GcTransactionType gcTransactionType)
```
    assign the tx type
    
    Parameters:
    
    gcTransactionType -
    
    Returns:
    
    self for chaining
  - addSubjectAttributeName
```
public GcAddMember addSubjectAttributeName(String subjectAttributeName)
```
    Parameters:
    
    subjectAttributeName -
    
    Returns:
    
    this for chaining
  - assignIncludeGroupDetail
```
public GcAddMember assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
```
    assign if the group detail should be included
    
    Parameters:
    
    theIncludeGroupDetail -
    
    Returns:
    
    this for chaining
  - assignAddExternalSubjectIfNotFound
```
public GcAddMember assignAddExternalSubjectIfNotFound(Boolean theAssignAddExternalSubjectIfNotFound)
```
    addExternalSubjectIfNotFound T or F, if this is a search by id or identifier, with no source, or the external source, and the subject is not found, then add an external subject (if the user is allowed
    
    Parameters:
    
    theAssignAddExternalSubjectIfNotFound -
    
    Returns:
    
    this for chaining
  - assignIncludeSubjectDetail
```
public GcAddMember assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
```
    if should include subject detail
    
    Parameters:
    
    theIncludeSubjectDetail -
    
    Returns:
    
    this for chaining
  - assignClientVersion
```
public GcAddMember assignClientVersion(String theClientVersion)
```
    assign client version
    
    Parameters:
    
    theClientVersion -
    
    Returns:
    
    this for chaining
  - execute
```
public WsAddMemberResults execute()
```
    execute the call and return the results. If there is a problem calling the service, an exception will be thrown
    
    Returns:
    
    the results

Class GcAddMember

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GcAddMember

Method Detail

assignWsEndpoint

assignWsUser

assignWsPass

assignWsPassEncrypted

assignWsPassFile

assignWsPassFileEncrypted

assignDisabledTime

assignEnabledTime

assignGroupName

assignGroupUuid

assignGroupIdIndex

addParam

addParam

addSubjectLookup

addSubjectId

addSubjectIdentifier

assignReplaceAllExisting

assignActAsSubject

assignFieldName

assignTxType

addSubjectAttributeName

assignIncludeGroupDetail

assignAddExternalSubjectIfNotFound

assignIncludeSubjectDetail

assignClientVersion

execute