edu.internet2.middleware.grouperClient.api

Class GcStemDelete

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcStemDelete

public class GcStemDelete
extends Object

class to run a stem delete service call

Constructor Summary

Constructors

Constructor and Description
GcStemDelete()

Method Summary

Modifier and Type	Method and Description
GcStemDelete	addGroupLookup(WsStemLookup wsStemLookup) Deprecated. use addStemLookup instead
GcStemDelete	addParam(String paramName, String paramValue) add a param to the list
GcStemDelete	addParam(WsParam wsParam) add a param to the list
GcStemDelete	addStemLookup(WsStemLookup wsStemLookup) add group lookup
GcStemDelete	assignActAsSubject(WsSubjectLookup theActAsSubject) assign the act as subject if any
GcStemDelete	assignClientVersion(String theClientVersion) assign client version
GcStemDelete	assignTxType(GcTransactionType gcTransactionType) assign the tx type
GcStemDelete	assignWsEndpoint(String theWsEndpoint) endpoint to grouper WS, e.g.
GcStemDelete	assignWsPass(String theWsPass) ws pass
GcStemDelete	assignWsPassEncrypted(String theWsPassEncrypted) ws pass
GcStemDelete	assignWsPassFile(File theFile) ws pass
GcStemDelete	assignWsPassFileEncrypted(File theFile) ws pass
GcStemDelete	assignWsUser(String theWsUser) ws user
WsStemDeleteResults	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

GcStemDelete

public GcStemDelete()

Method Detail

assignWsEndpoint

public GcStemDelete assignWsEndpoint(String theWsEndpoint)

endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest

Parameters:

theWsEndpoint -

Returns:

this for chaining

assignWsUser

public GcStemDelete assignWsUser(String theWsUser)

ws user

Parameters:

theWsUser -

Returns:

this for chaining

assignWsPass

public GcStemDelete assignWsPass(String theWsPass)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassEncrypted

public GcStemDelete assignWsPassEncrypted(String theWsPassEncrypted)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassFile

public GcStemDelete assignWsPassFile(File theFile)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

assignWsPassFileEncrypted

public GcStemDelete assignWsPassFileEncrypted(File theFile)

ws pass

Parameters:

theWsPass -

Returns:

this for chaining

addGroupLookup

@Deprecated
public GcStemDelete addGroupLookup(WsStemLookup wsStemLookup)

Deprecated. use addStemLookup instead

add group lookup

Parameters:

wsStemLookup -

Returns:

this for chaining

addStemLookup

public GcStemDelete addStemLookup(WsStemLookup wsStemLookup)

add group lookup

Parameters:

wsStemLookup -

Returns:

this for chaining

addParam

public GcStemDelete addParam(String paramName,
                             String paramValue)

add a param to the list

Parameters:

paramName -

paramValue -

Returns:

this for chaining

addParam

public GcStemDelete addParam(WsParam wsParam)

add a param to the list

Parameters:

wsParam -

Returns:

this for chaining

assignActAsSubject

public GcStemDelete assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

assignTxType

public GcStemDelete assignTxType(GcTransactionType gcTransactionType)

assign the tx type

Parameters:

gcTransactionType -

Returns:

self for chaining

assignClientVersion

public GcStemDelete assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

execute

public WsStemDeleteResults execute()

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

Returns:

the results