Package org.forgerock.api.models

Class Operation

java.lang.Object

org.forgerock.api.models.Operation

Direct Known Subclasses:

Action, Create, Delete, Patch, Query, Read, Update

public abstract class Operation
extends Object

Class that represents the Operation type in API descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Operation.Builder<T extends Operation.Builder<T>>	Builder to help construct the Operation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Operation(Operation.Builder builder)	Protected constructor of the Operation.

Method Summary

Modifier and Type	Method	Description
protected abstract void	allocateToResource(Resource.Builder resourceBuilder)	Allocates the operation by operation type to the given Resource Builder by calling the corresonding method by type.
boolean	equals(Object o)
ApiError[]	getApiErrors()	Getter of the error array.
LocalizableString	getDescription()	Getter of the description.
Parameter[]	getParameters()	Getter of the parameters array.
Stability	getStability()	Getter of Operation stability.
String[]	getSupportedLocales()	Getter of the supported locales array.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

Operation

protected Operation(Operation.Builder builder)

Protected constructor of the Operation.

Parameters:

builder - Operation Builder

Method Details

getDescription

public LocalizableString getDescription()

Getter of the description.

Returns:

Description

getSupportedLocales

public String[] getSupportedLocales()

Getter of the supported locales array.

Returns:

Supported locales

getApiErrors

public ApiError[] getApiErrors()

Getter of the error array.

Returns:

ApiError array

getParameters

public Parameter[] getParameters()

Getter of the parameters array.

Returns:

Parameters

getStability

public Stability getStability()

Getter of Operation stability.

Returns:

Stability or null which suggests Stability.STABLE (default).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

allocateToResource

protected abstract void allocateToResource(Resource.Builder resourceBuilder)

Allocates the operation by operation type to the given Resource Builder by calling the corresonding method by type.

Parameters:

resourceBuilder - - Resource Builder to add the operation