@Retention(value=RUNTIME) @Target(value=TYPE) public @interface Operation
An operation may provide an ID as the annotation value. If no id is specified the class name will be used as the ID.
The ID is the key used to register the operation.
Make sure you choose a proper ID name to avoid collisions (using the default: ID the class name can be a solution).
Modifier and Type | Optional Element and Description |
---|---|
boolean |
addToStudio
Boolean indicating if this operation should be exposed in Studio (optional), defaults to true.
|
String[] |
aliases
ID Aliases array for a given operation.
|
String |
category
The operation category (optional), useful for documentation.
|
String |
deprecatedSince
Nuxeo version from which this operation is deprecated (optional), useful for documentation.
|
String |
description
Description of this operation (optional), useful for documentation.
|
String |
id
The operation ID (mandatory).
|
String |
label
The operation label (optional), useful for documentation.
|
String |
requires
Name of the context requires by this operation (optional), useful for documentation.
|
String |
since
Nuxeo version from which this operation is available (optional), useful for documentation.
|
public abstract String id
If not specified the absolute name of the annotated class will be used.
public abstract String category
Provide a category to be used by the UI to classify the operations (on the documentation page or in Studio).
public abstract String label
Provide a label for the operation to be used in UI (should not contain any HTML code).
public abstract String requires
Provide the name of the context required by this operation. Example: event, ui, wf, etc..
public abstract String description
Provide a description of the operation (may contain HTML code).
public abstract String since
The default value is the null string "" which means no specific version is required. Examples: "5.4", "5.9.1".
public abstract String deprecatedSince
The default value is the null string "" which means no specific version. Examples: "5.4", "5.9.1".
public abstract boolean addToStudio
This is convenient helper for Studio operations export.
public abstract String[] aliases
Copyright © 2015 Nuxeo SA. All rights reserved.