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

Class ApiResult.ApiUpdateResponse

java.lang.Object

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

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

Enclosing class:

ApiResult

public static class ApiResult.ApiUpdateResponse
extends ApiResult.ApiResponse

Represents an API response for an update operation.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	created	Whether the item was created (true) or updated (false).
protected String	id	The ID of the updated item.

Fields inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status, version

Constructor Summary

Constructors

Constructor	Description
ApiUpdateResponse()	Default constructor for ApiUpdateResponse.

Method Summary

Modifier and Type	Method	Description
ApiResult.ApiUpdateResponse	created(boolean created)	Sets whether the item was created or updated.
ApiResult.ApiUpdateResponse	id(String id)	Sets the ID of the updated item.
ApiResult	result()	Returns a new ApiResult instance with this ApiResponse.

Methods inherited from class org.codelibs.fess.app.web.api.ApiResult.ApiResponse

status

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

The ID of the updated item.

created

protected boolean created

Whether the item was created (true) or updated (false).

Constructor Details

ApiUpdateResponse

public ApiUpdateResponse()

Default constructor for ApiUpdateResponse.

Method Details

id

public ApiResult.ApiUpdateResponse id(String id)

Sets the ID of the updated item.

Parameters:

id - The ID to set.

Returns:

This ApiUpdateResponse instance.

created

public ApiResult.ApiUpdateResponse created(boolean created)

Sets whether the item was created or updated.

Parameters:

created - True if created, false if updated.

Returns:

This ApiUpdateResponse instance.

result

public ApiResult result()

Description copied from class: ApiResult.ApiResponse

Returns a new ApiResult instance with this ApiResponse.

Overrides:

result in class ApiResult.ApiResponse

Returns:

A new ApiResult instance.