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

Class ApiResult

java.lang.Object

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

public class ApiResult
extends Object

This class represents the base response structure for API results. It encapsulates the API response and provides methods to build different types of API responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiResult.ApiBackupFilesResponse	Represents an API response containing a list of backup files.
static class	ApiResult.ApiBulkResponse	Represents an API response for bulk operations, containing a list of processed items.
static class	ApiResult.ApiConfigResponse	Represents an API response for configuration settings.
static class	ApiResult.ApiConfigsResponse<T>	Represents an API response for a list of configuration settings.
static class	ApiResult.ApiDeleteResponse	Represents an API response for a delete operation.
static class	ApiResult.ApiDocResponse	Represents an API response for a single document.
static class	ApiResult.ApiDocsResponse	Represents an API response for search results, including document list, pagination, and facet information.
static class	ApiResult.ApiErrorResponse	Represents an API response for an error.
static class	ApiResult.ApiLogFilesResponse	Represents an API response containing a list of log files.
static class	ApiResult.ApiLogResponse	Represents an API response for a log entry.
static class	ApiResult.ApiLogsResponse<T>	Represents an API response for a list of logs.
static class	ApiResult.ApiPluginResponse	Represents an API response for plugin information.
static class	ApiResult.ApiResponse	Represents the base API response structure.
static class	ApiResult.ApiStartJobResponse	Represents an API response for a start job operation.
static class	ApiResult.ApiStatsResponse	Represents an API response containing statistical information.
static class	ApiResult.ApiStorageResponse	Represents an API response for storage-related operations, typically containing a list of items.
static class	ApiResult.ApiSystemInfoResponse	Represents an API response containing system information.
static class	ApiResult.ApiUpdateResponse	Represents an API response for an update operation.
static enum	ApiResult.Status	Represents the status of an API response.

Field Summary

Fields

Modifier and Type	Field	Description
protected ApiResult.ApiResponse	response	The API response object.

Constructor Summary

Constructors

Constructor	Description
ApiResult(ApiResult.ApiResponse response)	Constructs an ApiResult with the specified ApiResponse.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

response

protected ApiResult.ApiResponse response

The API response object.

Constructor Details

ApiResult

public ApiResult(ApiResult.ApiResponse response)

Constructs an ApiResult with the specified ApiResponse.

Parameters:

response - The API response object.