org.nuxeo.ecm.automation
Class OperationDocumentation

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

All Implemented Interfaces:

Serializable, Comparable<OperationDocumentation>

public class OperationDocumentation
extends Object
implements Comparable<OperationDocumentation>, Serializable

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Nested Class Summary

static class

OperationDocumentation.Param

Field Summary

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

Constructor Summary

OperationDocumentation(String id)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

signature

public 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 String category

label

public String label

requires

public String requires

since

public String since

description

public String description

params

public List<OperationDocumentation.Param> params

url

public String url

Constructor Detail

OperationDocumentation

public OperationDocumentation(String id)

Method Detail

compareTo

public int compareTo(OperationDocumentation o)

Specified by:

compareTo in interface Comparable<OperationDocumentation>

getDescription

public String getDescription()

getSignature

public String[] getSignature()

getCategory

public String getCategory()

getId

public String getId()

getUrl

public String getUrl()

getLabel

public String getLabel()

getRequires

public String getRequires()

getParams

public List<OperationDocumentation.Param> getParams()

toString

public String toString()

Overrides:

toString in class Object