org.nuxeo.apidoc.adapters

Class OperationInfoDocAdapter

java.lang.Object

org.nuxeo.apidoc.api.BaseNuxeoArtifact

org.nuxeo.apidoc.adapters.BaseNuxeoArtifactDocAdapter

org.nuxeo.apidoc.adapters.OperationInfoDocAdapter

All Implemented Interfaces:

Comparable<OperationInfo>, NuxeoArtifact, OperationInfo

public class OperationInfoDocAdapter
extends BaseNuxeoArtifactDocAdapter
implements OperationInfo

Adapter from a Nuxeo document to the OperationInfo interface.

Field Summary

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

ARTIFACT_PREFIX, PROP_CATEGORY, PROP_DESCRIPTION, PROP_LABEL, PROP_NAME, 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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(OperationInfo o)
static OperationInfo	create(OperationInfo oi, CoreSession session, String containerPath) Creates an actual document from the OperationInfo.
String	getArtifactType()
String	getCategory()
String	getDescription()
String	getId()
String	getLabel()
String	getName() Actual operation id.
List<OperationDocumentation.Param>	getParams()
String	getRequires()
String[]	getSignature()
String	getSince()
String	getUrl()
String	getVersion()

Methods inherited from class org.nuxeo.apidoc.adapters.BaseNuxeoArtifactDocAdapter

getDoc, getHierarchyPath, hashCode, releaseLocalCoreSession, setLocalCoreSession

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

getAssociatedDocuments

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, toString, wait, wait, wait

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

getAssociatedDocuments, getHierarchyPath

Method Detail

getArtifactType

public String getArtifactType()

Specified by:

getArtifactType in interface NuxeoArtifact

getId

public String getId()

Specified by:

getId in interface NuxeoArtifact

Specified by:

getId in class BaseNuxeoArtifact

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

getVersion

public String getVersion()

Specified by:

getVersion in interface NuxeoArtifact

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

compareTo

public int compareTo(OperationInfo o)

Specified by:

compareTo in interface Comparable<OperationInfo>

create

public static OperationInfo create(OperationInfo oi,
                   CoreSession session,
                   String containerPath)
                            throws Exception

Creates an actual document from the OperationInfo.

Throws:

Exception