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

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

public class WsRestAssignAttributesBatchRequest
extends Object
implements WsRequestBean

request bean in body of rest request. assign attributes and values to owner objects (groups, stems, etc), doing multiple operations in one batch


Constructor Summary
WsRestAssignAttributesBatchRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
          if acting as someone else
 String getClientVersion()
          is the version of the client.
 String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 WsParam[] getParams()
          optional: reserved for future use
 String[] getSubjectAttributeNames()
          are the additional subject attributes (data) to return.
 String getTxType()
          is the GrouperTransactionType for the request.
 WsAssignAttributeBatchEntry[] getWsAssignAttributeBatchEntries()
          batch of attribute assignments
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
          if acting as someone else
 void setClientVersion(String clientVersion1)
          is the version of the client.
 void setIncludeGroupDetail(String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void setIncludeSubjectDetail(String includeSubjectDetail1)
          T|F, for if the extended subject information should be returned (anything more than just the id)
 void setParams(WsParam[] params1)
          optional: reserved for future use
 void setSubjectAttributeNames(String[] subjectAttributeNames1)
          are the additional subject attributes (data) to return.
 void setTxType(String txType1)
          is the GrouperTransactionType for the request.
 void setWsAssignAttributeBatchEntries(WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries1)
          batch of attribute assignments
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestAssignAttributesBatchRequest

public WsRestAssignAttributesBatchRequest()
Method Detail

getWsAssignAttributeBatchEntries

public WsAssignAttributeBatchEntry[] getWsAssignAttributeBatchEntries()
batch of attribute assignments

Returns:
batch

setWsAssignAttributeBatchEntries

public void setWsAssignAttributeBatchEntries(WsAssignAttributeBatchEntry[] wsAssignAttributeBatchEntries1)
batch of attribute assignments

Parameters:
wsAssignAttributeBatchEntries1 -

getTxType

public String getTxType()
is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.

Returns:
tx type

setTxType

public void setTxType(String txType1)
is the GrouperTransactionType for the request. If blank, defaults to NONE (will finish as much as possible). Generally the only values for this param that make sense are NONE (or blank), and READ_WRITE_NEW.

Parameters:
txType1 -

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 -

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()
if acting as someone else

Returns:
act as subject

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
if acting as someone else

Parameters:
actAsSubjectLookup1 -

getIncludeSubjectDetail

public String getIncludeSubjectDetail()
T|F, for if the extended subject information should be returned (anything more than just the id)

Returns:
T|F

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)
T|F, for if the extended subject information should be returned (anything more than just the id)

Parameters:
includeSubjectDetail1 -

getSubjectAttributeNames

public String[] getSubjectAttributeNames()
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent

Returns:
subject attribute names

setSubjectAttributeNames

public void setSubjectAttributeNames(String[] subjectAttributeNames1)
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent

Parameters:
subjectAttributeNames1 -

getIncludeGroupDetail

public String getIncludeGroupDetail()
T or F as to if the group detail should be returned

Returns:
T|F

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)
T or F as to if the group detail should be returned

Parameters:
includeGroupDetail1 -

getParams

public WsParam[] getParams()
optional: reserved for future use

Returns:
params

setParams

public void setParams(WsParam[] params1)
optional: reserved for future use

Parameters:
params1 -