Package de.xima.fc.prompt.ms.impl.service.generic_oai.client.model

Class BaseOutput

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.client.model.BaseOutput

Direct Known Subclasses:

AskOutput, ListModelsOutput, TestConnectionOutput

public abstract class BaseOutput
extends Object

Base class for outputs from API calls, with the ability to represent errors. Subclasses should add specific fields for successful outputs.

Since:

8.5.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseOutput()
protected	BaseOutput(GenericOaiErrorType errorType, String errorMessage, Throwable cause)

Method Summary

Modifier and Type	Method	Description
Throwable	errorCause()	Gets the exception that caused the error, if there was an error.
String	errorMessage()	Gets the error message, if there was an error.
GenericOaiErrorType	errorType()	Gets the type of error, if there was an error.
boolean	hasError()	Checks if the output represents an error.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseOutput

protected BaseOutput()

BaseOutput

protected BaseOutput(GenericOaiErrorType errorType,
                     String errorMessage,
                     Throwable cause)

Method Detail

errorCause

public final Throwable errorCause()

Gets the exception that caused the error, if there was an error.

Returns:

The exception, or null if synthesis was successful.

errorMessage

public final String errorMessage()

Gets the error message, if there was an error.

Returns:

The error message, or null if synthesis was successful.

errorType

public final GenericOaiErrorType errorType()

Gets the type of error, if there was an error.

Returns:

The error type, or null if synthesis was successful.

hasError

public final boolean hasError()

Checks if the output represents an error.

Returns:

true if there was an error, false otherwise.