Package org.codelibs.fess.app.web.api

Class ApiResult.ApiResponse

java.lang.Object

org.codelibs.fess.app.web.api.ApiResult.ApiResponse

Direct Known Subclasses:

ApiResult.ApiBackupFilesResponse, ApiResult.ApiBulkResponse, ApiResult.ApiConfigResponse, ApiResult.ApiConfigsResponse, ApiResult.ApiDeleteResponse, ApiResult.ApiDocResponse, ApiResult.ApiDocsResponse, ApiResult.ApiErrorResponse, ApiResult.ApiLogFilesResponse, ApiResult.ApiLogResponse, ApiResult.ApiLogsResponse, ApiResult.ApiPluginResponse, ApiResult.ApiStartJobResponse, ApiResult.ApiStatsResponse, ApiResult.ApiStorageResponse, ApiResult.ApiSystemInfoResponse, ApiResult.ApiUpdateResponse

Enclosing class:

ApiResult

public static class ApiResult.ApiResponse
extends Object

Represents the base API response structure.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	status	The status code of the response.
protected String	version	The version of the product.

Constructor Summary

Constructors

Constructor	Description
ApiResponse()	Default constructor for ApiResponse.

Method Summary

Modifier and Type	Method	Description
ApiResult	result()	Returns a new ApiResult instance with this ApiResponse.
ApiResult.ApiResponse	status(ApiResult.Status status)	Sets the status of the response.

Methods inherited from class java.lang.Object

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

Field Details

version

protected String version

The version of the product.

status

protected int status

The status code of the response.

Constructor Details

ApiResponse

public ApiResponse()

Default constructor for ApiResponse.

Method Details

status

public ApiResult.ApiResponse status(ApiResult.Status status)

Sets the status of the response.

Parameters:

status - The status to set.

Returns:

This ApiResponse instance.

result

public ApiResult result()

Returns a new ApiResult instance with this ApiResponse.

Returns:

A new ApiResult instance.