edu.internet2.middleware.grouper.ws.coresoap

Class WsAssignAttributesBatchResults

java.lang.Object

edu.internet2.middleware.grouper.ws.coresoap.WsAssignAttributesBatchResults

All Implemented Interfaces:

WsResponseBean, ResultMetadataHolder

public class WsAssignAttributesBatchResults
extends Object
implements WsResponseBean, ResultMetadataHolder

 results for assigning attributes call.
 
 result code:
 code of the result for this attribute assignment overall
 SUCCESS: means everything ok
 INSUFFICIENT_PRIVILEGES: problem with some input where privileges are not sufficient
 INVALID_QUERY: bad inputs
 EXCEPTION: something bad happened
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WsAssignAttributesBatchResults.WsAssignAttributesBatchResultsCode result code of a request.

Constructor Summary

Constructors

Constructor and Description
WsAssignAttributesBatchResults()

Method Summary

Modifier and Type	Method and Description
void	addResult(WsAssignAttributesResults wsAssignAttributesResults, String theError, Exception e, int index) add a result to the list of results, and keep track of all the related objects
void	assignResult(List<WsAssignAttributeBatchResult> attributeAssignBatchResults, String[] theSubjectAttributeNames) assign results
void	assignResultCode(WsAssignAttributesBatchResults.WsAssignAttributesBatchResultsCode getAttributeAssignmentsResultCode) assign the code from the enum
void	assignResultCodeException(WsAssignAttributesBatchResults.WsAssignAttributesBatchResultsCode wsAssignAttributesBatchResultsCode, String theError, Exception e) process an exception, log, etc
WsResponseMeta	getResponseMetadata() get the response metadata
WsResultMeta	getResultMetadata() get the result metadata
String[]	getSubjectAttributeNames() attributes of subjects returned, in same order as the data
WsAssignAttributeBatchResult[]	getWsAssignAttributeBatchResultArray() the assignment results being queried
WsAttributeDefName[]	getWsAttributeDefNames() attribute def names referenced in the assignments or inputs (and able to read)
WsAttributeDef[]	getWsAttributeDefs() attribute def references in the assignments or inputs (and able to be read)
WsGroup[]	getWsGroups()
WsMembership[]	getWsMemberships() results for each assignment sent in
WsStem[]	getWsStems() stems that are in the results
WsSubject[]	getWsSubjects() subjects that are in the results
void	setResponseMetadata(WsResponseMeta responseMetadata1)
void	setResultMetadata(WsResultMeta resultMetadata1)
void	setSubjectAttributeNames(String[] attributeNamesa) attributes of subjects returned, in same order as the data
void	setWsAssignAttributeBatchResultArray(WsAssignAttributeBatchResult[] wsAttributeAssignResults1) the assignment results being queried
void	setWsAttributeDefNames(WsAttributeDefName[] wsAttributeDefNames1) attribute def names referenced in the assignments or inputs (and able to read)
void	setWsAttributeDefs(WsAttributeDef[] wsAttributeDefs1) attribute def references in the assignments or inputs (and able to be read)
void	setWsGroups(WsGroup[] wsGroup1)
void	setWsMemberships(WsMembership[] results1) results for each assignment sent in
void	setWsStems(WsStem[] wsStems1) stems that are in the results
void	setWsSubjects(WsSubject[] wsSubjects1) subjects that are in the results
void	sortResults() sort the results by assignment
boolean	tallyResults(edu.internet2.middleware.grouper.hibernate.GrouperTransactionType grouperTransactionType, String theSummary) make sure if there is an error, to record that as an error

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WsAssignAttributesBatchResults

public WsAssignAttributesBatchResults()

Method Detail

tallyResults

public boolean tallyResults(edu.internet2.middleware.grouper.hibernate.GrouperTransactionType grouperTransactionType,
                            String theSummary)

make sure if there is an error, to record that as an error

Parameters:

grouperTransactionType - for request

theSummary -

Returns:

true if success, false if not

assignResultCodeException

public void assignResultCodeException(WsAssignAttributesBatchResults.WsAssignAttributesBatchResultsCode wsAssignAttributesBatchResultsCode,
                                      String theError,
                                      Exception e)

process an exception, log, etc

Parameters:

wsAssignAttributesBatchResultsCode -

theError -

e -

getWsAttributeDefs

public WsAttributeDef[] getWsAttributeDefs()

attribute def references in the assignments or inputs (and able to be read)

Returns:

attribute defs

setWsAttributeDefs

public void setWsAttributeDefs(WsAttributeDef[] wsAttributeDefs1)

attribute def references in the assignments or inputs (and able to be read)

Parameters:

wsAttributeDefs1 -

getWsAttributeDefNames

public WsAttributeDefName[] getWsAttributeDefNames()

attribute def names referenced in the assignments or inputs (and able to read)

Returns:

attribute def names

setWsAttributeDefNames

public void setWsAttributeDefNames(WsAttributeDefName[] wsAttributeDefNames1)

attribute def names referenced in the assignments or inputs (and able to read)

Parameters:

wsAttributeDefNames1 -

getWsAssignAttributeBatchResultArray

public WsAssignAttributeBatchResult[] getWsAssignAttributeBatchResultArray()

the assignment results being queried

Returns:

the assignments being queried

setWsAssignAttributeBatchResultArray

public void setWsAssignAttributeBatchResultArray(WsAssignAttributeBatchResult[] wsAttributeAssignResults1)

the assignment results being queried

Parameters:

wsAttributeAssignResults1 -

assignResultCode

public void assignResultCode(WsAssignAttributesBatchResults.WsAssignAttributesBatchResultsCode getAttributeAssignmentsResultCode)

assign the code from the enum

Parameters:

getAttributeAssignmentsResultCode -

getSubjectAttributeNames

public String[] getSubjectAttributeNames()

attributes of subjects returned, in same order as the data

Returns:

the attributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(String[] attributeNamesa)

attributes of subjects returned, in same order as the data

Parameters:

attributeNamesa - the attributeNames to set

getResultMetadata

public WsResultMeta getResultMetadata()

Description copied from interface: WsResponseBean

get the result metadata

Specified by:

getResultMetadata in interface WsResponseBean

Specified by:

getResultMetadata in interface ResultMetadataHolder

Returns:

the resultMetadata

getWsStems

public WsStem[] getWsStems()

stems that are in the results

Returns:

stems

setWsStems

public void setWsStems(WsStem[] wsStems1)

stems that are in the results

Parameters:

wsStems1 -

getResponseMetadata

public WsResponseMeta getResponseMetadata()

Description copied from interface: WsResponseBean

get the response metadata

Specified by:

getResponseMetadata in interface WsResponseBean

Returns:

the response metadata

See Also:

WsResponseBean.getResponseMetadata()

setResultMetadata

public void setResultMetadata(WsResultMeta resultMetadata1)

Parameters:

resultMetadata1 - the resultMetadata to set

setResponseMetadata

public void setResponseMetadata(WsResponseMeta responseMetadata1)

Parameters:

responseMetadata1 - the responseMetadata to set

getWsGroups

public WsGroup[] getWsGroups()

Returns:

the wsGroups

getWsMemberships

public WsMembership[] getWsMemberships()

results for each assignment sent in

Returns:

the results

getWsSubjects

public WsSubject[] getWsSubjects()

subjects that are in the results

Returns:

the subjects

setWsGroups

public void setWsGroups(WsGroup[] wsGroup1)

Parameters:

wsGroup1 - the wsGroups to set

setWsMemberships

public void setWsMemberships(WsMembership[] results1)

results for each assignment sent in

Parameters:

results1 - the results to set

setWsSubjects

public void setWsSubjects(WsSubject[] wsSubjects1)

subjects that are in the results

Parameters:

wsSubjects1 -

assignResult

public void assignResult(List<WsAssignAttributeBatchResult> attributeAssignBatchResults,
                         String[] theSubjectAttributeNames)

assign results

Parameters:

attributeAssignBatchResults -

theSubjectAttributeNames -

sortResults

public void sortResults()

sort the results by assignment

addResult

public void addResult(WsAssignAttributesResults wsAssignAttributesResults,
                      String theError,
                      Exception e,
                      int index)

add a result to the list of results, and keep track of all the related objects

Parameters:

wsAssignAttributesResults -

theError -

e -

index -