io.javadog.cws.api.responses

Class CwsResponse

java.lang.Object

io.javadog.cws.api.responses.CwsResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FetchCircleResponse, FetchDataResponse, FetchDataTypeResponse, FetchMemberResponse, FetchSignatureResponse, FetchTrusteeResponse, MasterKeyResponse, ProcessCircleResponse, ProcessDataResponse, ProcessDataTypeResponse, ProcessMemberResponse, ProcessTrusteeResponse, SanityResponse, SettingResponse, SignResponse, VerifyResponse, VersionResponse

public class CwsResponse
extends Object
implements Serializable

General Response Object, embedded in all other Response Objects, as it contains the processing result, i.e. return code & message. If everything went good, the return code will the code 200, same as the HTTP protocol will return if everything went well. The return message will simple be 'Ok' in this case.

If a problem occurred, either a warning (problem which can be corrected by the invoking system/member), or an error (internal problem, most likely a resource issue). The return code & message should hopefully provide enough information for the System Administrator to correct the problem.

The class ReturnCode for more information, and clarification of the individual warnings or errors which may occur.

Since:

CWS 1.0

Author:

Kim Jensen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CwsResponse() Empty Constructor, to use if the setters are invoked.
CwsResponse(ReturnCode returnCode, String returnMessage) Error Constructor, used if an error occurred, and the request could not complete successfully.

Method Summary

Modifier and Type	Method and Description
int	getReturnCode()
String	getReturnMessage()
boolean	isOk()
void	setReturnCode(ReturnCode returnCode)
void	setReturnMessage(String returnMessage)

Methods inherited from class java.lang.Object

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

Constructor Detail

CwsResponse

public CwsResponse()

Empty Constructor, to use if the setters are invoked. This is required for WebServices to work properly.

CwsResponse

public CwsResponse(ReturnCode returnCode,
                   String returnMessage)

Error Constructor, used if an error occurred, and the request could not complete successfully.

Parameters:

returnCode - The CWS Return Code

returnMessage - The CWS Return Message

Method Detail

setReturnCode

public final void setReturnCode(ReturnCode returnCode)

getReturnCode

public final int getReturnCode()

setReturnMessage

public final void setReturnMessage(String returnMessage)

getReturnMessage

public final String getReturnMessage()

isOk

public final boolean isOk()