edu.internet2.middleware.grouper.ws.coresoap

Class WsGetSubjectsResults

java.lang.Object

edu.internet2.middleware.grouper.ws.coresoap.WsGetSubjectsResults

All Implemented Interfaces:

WsResponseBean, ResultMetadataHolder

public class WsGetSubjectsResults
extends Object
implements WsResponseBean, ResultMetadataHolder

 results for the get memberships call, or the get memberships lite call
 
 result code:
 code of the result for this group overall
 SUCCESS: means everything ok
 GROUP_NOT_FOUND: cant find the group
 INVALID_QUERY: bad inputs
 EXCEPTION: something bad happened
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WsGetSubjectsResults.WsGetSubjectsResultsCode result code of a request

Constructor Summary

Constructors

Constructor and Description
WsGetSubjectsResults()

Method Summary

Modifier and Type	Method and Description
void	assignResult(Set<edu.internet2.middleware.subject.Subject> subjectSet, boolean includeGroupDetail, boolean includeSubjectDetail, String[] theSubjectAttributeNames, Set<WsSubjectLookup> wsSubjectLookups) convert members to subject results
void	assignResultCode(WsGetSubjectsResults.WsGetSubjectsResultsCode getMembersResultCode) assign the code from the enum
void	assignResultCodeException(WsGetSubjectsResults.WsGetSubjectsResultsCode wsGetMembershipsResultsCodeOverride, 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
WsGroup	getWsGroup()
WsSubject[]	getWsSubjects() subjects that are in the results
void	setResponseMetadata(WsResponseMeta responseMetadata1)
void	setResultMetadata(WsResultMeta resultMetadata1) result metadata
void	setSubjectAttributeNames(String[] attributeNamesa) attributes of subjects returned, in same order as the data
void	setWsGroup(WsGroup wsGroup1)
void	setWsSubjects(WsSubject[] wsSubjects1) subjects that are in the results

Methods inherited from class java.lang.Object

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

Constructor Detail

WsGetSubjectsResults

public WsGetSubjectsResults()

Method Detail

setResultMetadata

public void setResultMetadata(WsResultMeta resultMetadata1)

result metadata

Parameters:

resultMetadata1 -

assignResultCode

public void assignResultCode(WsGetSubjectsResults.WsGetSubjectsResultsCode getMembersResultCode)

assign the code from the enum

Parameters:

getMembersResultCode -

getWsSubjects

public WsSubject[] getWsSubjects()

subjects that are in the results

Returns:

the subjects

setWsSubjects

public void setWsSubjects(WsSubject[] wsSubjects1)

subjects that are in the results

Parameters:

wsSubjects1 -

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

assignResult

public void assignResult(Set<edu.internet2.middleware.subject.Subject> subjectSet,
                         boolean includeGroupDetail,
                         boolean includeSubjectDetail,
                         String[] theSubjectAttributeNames,
                         Set<WsSubjectLookup> wsSubjectLookups)

convert members to subject results

Parameters:

subjectSet -

includeGroupDetail -

includeSubjectDetail -

theSubjectAttributeNames -

wsSubjectLookups -

assignResultCodeException

public void assignResultCodeException(WsGetSubjectsResults.WsGetSubjectsResultsCode wsGetMembershipsResultsCodeOverride,
                                      String theError,
                                      Exception e)

process an exception, log, etc

Parameters:

wsGetMembershipsResultsCodeOverride -

theError -

e -

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

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()

setResponseMetadata

public void setResponseMetadata(WsResponseMeta responseMetadata1)

Parameters:

responseMetadata1 - the responseMetadata to set

getWsGroup

public WsGroup getWsGroup()

Returns:

the wsGroups

setWsGroup

public void setWsGroup(WsGroup wsGroup1)

Parameters:

wsGroup1 - the wsGroups to set