org.nuxeo.ecm.automation
Class OperationDocumentation

java.lang.Object
  org.nuxeo.ecm.automation.OperationDocumentation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OperationDocumentation>

public class OperationDocumentation
extends java.lang.Object
implements java.lang.Comparable<OperationDocumentation>, java.io.Serializable

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Nested Class Summary

static class

OperationDocumentation.Param

Field Summary

java.lang.String	category
java.lang.String	description
java.lang.String	id
java.lang.String	label
java.util.List<OperationDocumentation.Param>	params
java.lang.String	requires
java.lang.String[]	signature an array of size multiple of 2.
java.lang.String	since
java.lang.String	url

Constructor Summary

OperationDocumentation(java.lang.String id)

Method Summary

int	compareTo(OperationDocumentation o)
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getLabel()
java.util.List<OperationDocumentation.Param>	getParams()
java.lang.String	getRequires()
java.lang.String[]	getSignature()
java.lang.String	getUrl()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public java.lang.String id

signature

public java.lang.String[] signature

an array of size multiple of 2. Each pair in the array is the input and output type of a method

category

public java.lang.String category

label

public java.lang.String label

requires

public java.lang.String requires

since

public java.lang.String since

description

public java.lang.String description

params

public java.util.List<OperationDocumentation.Param> params

url

public java.lang.String url

Constructor Detail

OperationDocumentation

public OperationDocumentation(java.lang.String id)

Method Detail

compareTo

public int compareTo(OperationDocumentation o)

Specified by:

compareTo in interface java.lang.Comparable<OperationDocumentation>

getDescription

public java.lang.String getDescription()

getSignature

public java.lang.String[] getSignature()

getCategory

public java.lang.String getCategory()

getId

public java.lang.String getId()

getUrl

public java.lang.String getUrl()

getLabel

public java.lang.String getLabel()

getRequires

public java.lang.String getRequires()

getParams

public java.util.List<OperationDocumentation.Param> getParams()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object