org.nuxeo.apidoc.api

Interface OperationInfo

All Superinterfaces:

Comparable<OperationInfo>, NuxeoArtifact

All Known Implementing Classes:

OperationInfoDocAdapter, OperationInfoImpl

public interface OperationInfo
extends NuxeoArtifact, Comparable<OperationInfo>

Information about an operation

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARTIFACT_PREFIX Prefix for NuxeoArtifact.getId().
static String	BUILT_IN
static String	PROP_ALIASES
static String	PROP_CATEGORY
static String	PROP_CONTRIBUTING_COMPONENT
static String	PROP_DESCRIPTION
static String	PROP_LABEL
static String	PROP_NAME
static String	PROP_OP_CLASS
static String	PROP_PARAM_NAME
static String	PROP_PARAM_ORDER
static String	PROP_PARAM_REQUIRED
static String	PROP_PARAM_TYPE
static String	PROP_PARAM_VALUES
static String	PROP_PARAM_WIDGET
static String	PROP_PARAMS
static String	PROP_REQUIRES
static String	PROP_SIGNATURE
static String	PROP_SINCE
static String	PROP_URL
static String	PROP_VERSION
static String	TYPE_NAME

Method Summary

Modifier and Type	Method and Description
String[]	getAliases()
String	getCategory()
String	getContributingComponent()
String	getDescription()
String	getLabel()
String	getName() Actual operation id.
String	getOperationClass()
List<OperationDocumentation.Param>	getParams()
String	getRequires()
String[]	getSignature()
String	getSince()
String	getUrl()

Methods inherited from interface org.nuxeo.apidoc.api.NuxeoArtifact

getArtifactType, getAssociatedDocuments, getHierarchyPath, getId, getVersion

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TYPE_NAME

static final String TYPE_NAME

See Also:

Constant Field Values

ARTIFACT_PREFIX

static final String ARTIFACT_PREFIX

Prefix for NuxeoArtifact.getId().

See Also:

Constant Field Values

PROP_NAME

static final String PROP_NAME

See Also:

Constant Field Values

PROP_ALIASES

static final String PROP_ALIASES

See Also:

Constant Field Values

PROP_VERSION

static final String PROP_VERSION

See Also:

Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_SIGNATURE

static final String PROP_SIGNATURE

See Also:

Constant Field Values

PROP_CATEGORY

static final String PROP_CATEGORY

See Also:

Constant Field Values

PROP_URL

static final String PROP_URL

See Also:

Constant Field Values

PROP_LABEL

static final String PROP_LABEL

See Also:

Constant Field Values

PROP_REQUIRES

static final String PROP_REQUIRES

See Also:

Constant Field Values

PROP_SINCE

static final String PROP_SINCE

See Also:

Constant Field Values

PROP_PARAMS

static final String PROP_PARAMS

See Also:

Constant Field Values

PROP_PARAM_NAME

static final String PROP_PARAM_NAME

See Also:

Constant Field Values

PROP_PARAM_TYPE

static final String PROP_PARAM_TYPE

See Also:

Constant Field Values

PROP_PARAM_WIDGET

static final String PROP_PARAM_WIDGET

See Also:

Constant Field Values

PROP_PARAM_VALUES

static final String PROP_PARAM_VALUES

See Also:

Constant Field Values

PROP_PARAM_REQUIRED

static final String PROP_PARAM_REQUIRED

See Also:

Constant Field Values

PROP_PARAM_ORDER

static final String PROP_PARAM_ORDER

See Also:

Constant Field Values

PROP_OP_CLASS

static final String PROP_OP_CLASS

See Also:

Constant Field Values

PROP_CONTRIBUTING_COMPONENT

static final String PROP_CONTRIBUTING_COMPONENT

See Also:

Constant Field Values

BUILT_IN

static final String BUILT_IN

See Also:

Constant Field Values

Method Detail

getName

String getName()

Actual operation id. (NuxeoArtifact.getId() is prefixed with ARTIFACT_PREFIX)

getAliases

String[] getAliases()

getUrl

String getUrl()

getSignature

String[] getSignature()

getCategory

String getCategory()

getLabel

String getLabel()

getRequires

String getRequires()

getSince

String getSince()

getDescription

String getDescription()

getParams

List<OperationDocumentation.Param> getParams()

getOperationClass

String getOperationClass()

getContributingComponent

String getContributingComponent()