Package org.openiam.base.ws

Class Response

java.lang.Object

org.openiam.base.ws.Response

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractConnectorResponse, AbstractMapResponse, AbstractResponse, AbstractWorkflowResponse, AccessRightListResponse, AccessRightResponse, AccessViewResponse, ApproveAuthParamResponse, AuditLogResponse, AuthAttributeListResponse, AuthenticationDetailsResponse, AuthenticationResponse, AuthorizationMenuResponse, AuthorizationUserSetResponse, AuthProviderTypeListResponse, AuthProviderTypeResponse, AuthResourceAMAttributeListResponse, AuthResourceAttributeMapResponse, AuthStateListResponse, BaseDataResponse, BaseListResponse, BaseMapResponse, BusinessRuleEvaluationResponse, BusinessRuleUserRecalculationListResponse, CampaignStatsResponse, CSVConfigListResponse, CSVConfigResponse, EntityOwnerResponse, GetAllReportsResponse, GetAllSubCriteriaParamReportsResponse, GetAllSubscribedReportsResponse, GetReportDataResponse, GetReportInfoResponse, GetReportParameterMetaTypesResponse, GetReportParametersResponse, GetReportParameterTypesResponse, GetSubCriteriaParamReportResponse, GetSubscribedReportResponse, GroupAuthorizationRightSetResponse, IdServiceResponse, LanguageResponse, LoginResponse, LoginUserConnectorResponse, LookupObjectResponse, ManagedSystemViewerResponse, MenuSaveResponse, NewHireResponse, OrganizationAuthorizationRightSetResponse, PageTemplateWithErrorCodeResponse, PasswordChangeResponse, PasswordResetTokenResponse, ProfilePictureUserMapResponse, ReconciliationConfigListResponse, ReconciliationConfigResponse, ResourceAuthorizationRightSetResponse, ResourceEntitlementsListResponse, ResourceSelectAccess, RoleAuthorizationRightSetResponse, SSOAttributeListResponse, SSOLoginResponse, SSOTokenResponse, SupervisorResponse, SynchConfigListResponse, SynchConfigResponse, SyncResponse, TerminatedUserListResponse, TreeObjectIdListServiceResponse, URIFederationResponse, UserEntitlementsMatrixResponse, UserITPolicyHistoryListResponse, UserITPolicyHistoryResponse, UserResponse, ValidatePasswordResetTokenResponse

public class Response
extends Object
implements Serializable

Base class that is used for responses from a web service.

Author:

Suneet Shah

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ResponseCode	errorCode
protected String	errorText
protected Object	responseValue	Use inherited classes to return expected value to the caller
protected ResponseStatus	status

Constructor Summary

Constructors

Constructor	Description
Response(ResponseStatus s)

Method Summary

Modifier and Type	Method	Description
void	addErrorToken(EsbErrorToken errorToken)
void	addFieldMapping(String field, String value)
Response	convertToBase()
Response	fail()
String	getFieldMapping(String field)
protected Object	getValueInternal()
boolean	isFailure()
boolean	isSuccess()
Response	succeed()

Methods inherited from class java.lang.Object

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

Field Detail

status

protected ResponseStatus status

errorCode

protected ResponseCode errorCode

errorText

protected String errorText

responseValue

protected Object responseValue

Use inherited classes to return expected value to the caller

Constructor Detail

Response

public Response(ResponseStatus s)

Method Detail

succeed

public Response succeed()

fail

public Response fail()

isSuccess

public boolean isSuccess()

isFailure

public boolean isFailure()

addErrorToken

public void addErrorToken(EsbErrorToken errorToken)

getFieldMapping

public String getFieldMapping(String field)

addFieldMapping

public void addFieldMapping(String field,
                            String value)

convertToBase

public Response convertToBase()

getValueInternal

protected Object getValueInternal()