org.nuxeo.apidoc.introspection

Class OperationInfoImpl

java.lang.Object

org.nuxeo.apidoc.api.BaseNuxeoArtifact

org.nuxeo.apidoc.introspection.OperationInfoImpl

All Implemented Interfaces:

Comparable<OperationInfo>, NuxeoArtifact, OperationInfo

public class OperationInfoImpl
extends BaseNuxeoArtifact
implements OperationInfo

DTO for an OperationInfo, used for the runtime implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	aliases
protected String	category
protected String	contributingComponent
protected String	description
protected String	label
protected String	name
protected String	operationClass
protected List<OperationDocumentation.Param>	params
protected String	requires
protected String[]	signature
protected String	since
protected String	url
protected String	version

Fields inherited from class org.nuxeo.apidoc.api.BaseNuxeoArtifact

associatedDocuments

Fields inherited from interface org.nuxeo.apidoc.api.OperationInfo

ARTIFACT_PREFIX, BUILT_IN, PROP_ALIASES, PROP_CATEGORY, PROP_CONTRIBUTING_COMPONENT, PROP_DESCRIPTION, PROP_LABEL, PROP_NAME, PROP_OP_CLASS, PROP_PARAM_NAME, PROP_PARAM_ORDER, PROP_PARAM_REQUIRED, PROP_PARAM_TYPE, PROP_PARAM_VALUES, PROP_PARAM_WIDGET, PROP_PARAMS, PROP_REQUIRES, PROP_SIGNATURE, PROP_SINCE, PROP_URL, PROP_VERSION, TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
OperationInfoImpl(OperationDocumentation op, String version, String operationClass, String contributingComponent)
OperationInfoImpl(String name, String version, String[] aliases, String description, String operationClass, String contributingComponent, String[] signature, String category, String url, String label, String requires, String since, List<OperationDocumentation.Param> params)

Method Summary

Modifier and Type	Method and Description
int	compareTo(OperationInfo o)
String[]	getAliases()
String	getArtifactType()
String	getCategory()
String	getContributingComponent()
String	getDescription()
String	getHierarchyPath()
String	getId()
String	getLabel()
String	getName() Actual operation id.
String	getOperationClass()
List<OperationDocumentation.Param>	getParams()
String	getRequires()
String[]	getSignature()
String	getSince()
String	getUrl()
String	getVersion()

Methods inherited from class org.nuxeo.apidoc.api.BaseNuxeoArtifact

getAssociatedDocuments

Methods inherited from class java.lang.Object

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

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

getAssociatedDocuments

Field Detail

name

protected final String name

version

protected final String version

aliases

protected final String[] aliases

operationClass

protected final String operationClass

contributingComponent

protected final String contributingComponent

description

protected final String description

signature

protected final String[] signature

category

protected final String category

url

protected final String url

label

protected final String label

requires

protected final String requires

since

protected final String since

params

protected final List<OperationDocumentation.Param> params

Constructor Detail

OperationInfoImpl

public OperationInfoImpl(String name,
                         String version,
                         String[] aliases,
                         String description,
                         String operationClass,
                         String contributingComponent,
                         String[] signature,
                         String category,
                         String url,
                         String label,
                         String requires,
                         String since,
                         List<OperationDocumentation.Param> params)

OperationInfoImpl

public OperationInfoImpl(OperationDocumentation op,
                         String version,
                         String operationClass,
                         String contributingComponent)

Method Detail

getName

public String getName()

Description copied from interface: OperationInfo

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

Specified by:

getName in interface OperationInfo

getId

public String getId()

Specified by:

getId in interface NuxeoArtifact

Specified by:

getId in class BaseNuxeoArtifact

getAliases

public String[] getAliases()

Specified by:

getAliases in interface OperationInfo

getDescription

public String getDescription()

Specified by:

getDescription in interface OperationInfo

getSignature

public String[] getSignature()

Specified by:

getSignature in interface OperationInfo

getCategory

public String getCategory()

Specified by:

getCategory in interface OperationInfo

getUrl

public String getUrl()

Specified by:

getUrl in interface OperationInfo

getLabel

public String getLabel()

Specified by:

getLabel in interface OperationInfo

getRequires

public String getRequires()

Specified by:

getRequires in interface OperationInfo

getSince

public String getSince()

Specified by:

getSince in interface OperationInfo

getParams

public List<OperationDocumentation.Param> getParams()

Specified by:

getParams in interface OperationInfo

getVersion

public String getVersion()

Specified by:

getVersion in interface NuxeoArtifact

getArtifactType

public String getArtifactType()

Specified by:

getArtifactType in interface NuxeoArtifact

getHierarchyPath

public String getHierarchyPath()

Specified by:

getHierarchyPath in interface NuxeoArtifact

compareTo

public int compareTo(OperationInfo o)

Specified by:

compareTo in interface Comparable<OperationInfo>

getOperationClass

public String getOperationClass()

Specified by:

getOperationClass in interface OperationInfo

getContributingComponent

public String getContributingComponent()

Specified by:

getContributingComponent in interface OperationInfo