org.forgerock.api.transform

Class LocalizableOperation

java.lang.Object

io.swagger.models.Operation

org.forgerock.api.transform.LocalizableOperation

public class LocalizableOperation
extends io.swagger.models.Operation

Localizable Operation.

Constructor Summary

Constructors

Constructor and Description
LocalizableOperation()

Method Summary

Modifier and Type	Method and Description
void	addTag(LocalizableString tag) Adds a Tag, a String value that is metadata related to the Operation.
void	addTag(String tag)
LocalizableOperation	description(LocalizableString desc) Set the localizable description.
LocalizableOperation	description(String description) Set the plain string description.
String	getDescription()
LocalizableString	getLocalizableDescription() Get the localizable title for Jackson.
List<LocalizableString>	getLocalizableTags() Returns the localizable tags for this operation.
List<String>	getTags()
void	setDescription(String description)
void	setTags(List<String> tags)

Methods inherited from class io.swagger.models.Operation

addConsumes, addParameter, addProduces, addResponse, addScheme, addSecurity, consumes, consumes, defaultResponse, deprecated, equals, externalDocs, getConsumes, getDescription, getExternalDocs, getOperationId, getParameters, getProduces, getResponses, getSchemes, getSecurity, getSummary, getVendorExtensions, hashCode, isDeprecated, operationId, parameter, produces, produces, response, scheme, schemes, security, setConsumes, setDeprecated, setExternalDocs, setOperationId, setParameters, setProduces, setResponses, setSchemes, setSecurity, setSummary, setVendorExtension, setVendorExtensions, summary, tag, tags, toString, vendorExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizableOperation

public LocalizableOperation()

Method Detail

description

public LocalizableOperation description(LocalizableString desc)

Set the localizable description.

Parameters:

desc - The title.

Returns:

This model object.

description

public LocalizableOperation description(String description)

Set the plain string description.

Overrides:

description in class io.swagger.models.Operation

Parameters:

description - The title.

Returns:

This model object.

setDescription

public void setDescription(String description)

Overrides:

setDescription in class io.swagger.models.Operation

getLocalizableDescription

public LocalizableString getLocalizableDescription()

Get the localizable title for Jackson.

Returns:

The title.

addTag

public void addTag(String tag)

Overrides:

addTag in class io.swagger.models.Operation

addTag

public void addTag(LocalizableString tag)

Adds a Tag, a String value that is metadata related to the Operation.

Parameters:

tag - a LocalizableString

setTags

public void setTags(List<String> tags)

Overrides:

setTags in class io.swagger.models.Operation

getLocalizableTags

public List<LocalizableString> getLocalizableTags()

Returns the localizable tags for this operation.

Returns:

the localizable tags for this operation

getTags

public List<String> getTags()

Overrides:

getTags in class io.swagger.models.Operation

getDescription

public String getDescription()