microsoft.hawaii.hawaiiClientLibraryBase.DataContract

Class ServiceResult

java.lang.Object

microsoft.hawaii.hawaiiClientLibraryBase.DataContract.ServiceResult

Direct Known Subclasses:

DeleteResult, EndpointResult, GetByKeyResult, GetByKeysResult, GetLanguagesForSpeakResponse, GetLanguagesForTranslateResponse, GetResult, GroupResult, MessageResult, NameRegistrationResult, OcrServiceResult, PredictLocationResult, SetResult, SpeakResponse, SpeechServiceResult, TranslateResponse

public abstract class ServiceResult
extends java.lang.Object

Base class for all Hawaii service result classes. Various Hawaii service result classes will represent the result corresponding to different type of Hawaii service calls. This class contains functionality common to all Hawaii service result classes.

Constructor Summary

Constructors

Constructor and Description
ServiceResult() Initializes an instance of the ServiceResult class
ServiceResult(java.lang.Object stateObject) Initializes an instance of the ServiceResult class
ServiceResult(java.lang.Object stateObject, Status status) Initializes an instance of the ServiceResult class
ServiceResult(java.lang.Object stateObject, Status status, java.lang.Exception exception) Initializes an instance of the ServiceResult class

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Exception	getException() Gets the associated exception
java.lang.Object	getStateObject() Gets the user-defined state object
Status	getStatus() Gets the status of service response
void	setException(java.lang.Exception value) Sets the associated exception
void	setStateObject(java.lang.Object value) Sets the user defined state object
void	setStatus(Status value) Sets the status of service response
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceResult

public ServiceResult()

Initializes an instance of the ServiceResult class

ServiceResult

public ServiceResult(java.lang.Object stateObject)

Initializes an instance of the ServiceResult class

Parameters:

stateObject - user-defined state object

ServiceResult

public ServiceResult(java.lang.Object stateObject,
             Status status)

Initializes an instance of the ServiceResult class

Parameters:

stateObject - user-defined state object

status - status of the service response

ServiceResult

public ServiceResult(java.lang.Object stateObject,
             Status status,
             java.lang.Exception exception)

Initializes an instance of the ServiceResult class

Parameters:

stateObject - user-defined state object

status - status of the service response

exception - associated exception

Method Detail

getStatus

public Status getStatus()

Gets the status of service response

Returns:

Status

getException

public java.lang.Exception getException()

Gets the associated exception

Returns:

Exception

getStateObject

public java.lang.Object getStateObject()

Gets the user-defined state object

Returns:

Object

setStatus

public void setStatus(Status value)

Sets the status of service response

Parameters:

value - void

setException

public void setException(java.lang.Exception value)

Sets the associated exception

Parameters:

value - void

setStateObject

public void setStateObject(java.lang.Object value)

Sets the user defined state object

Parameters:

value - user defined state object void

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object