org.adroitlogic.x.annotation.config

Annotation Type ConnectorOperation

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface ConnectorOperation

This annotation is used to indicate a class as a Connector Operation. Any class that is annotated using this should adhere to the following guidelines.

1. The element must be a class type element. 2. The class must be public. 3. The class should not be an abstract class. 4. The class or at least one of its super classes must implement XConnectorOperationElement interface. 5. The display name should be unique.

This annotation represents a connector operation used as an operation for an egress connector annotated with EgressConnector annotation. The configurations in this annotation are used to render the respective connector operation once it is dragged into the pallet

Since:

17.01

Author:

Ruwan Linton

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends XEgressConnectorElement>[]	belongsTo The set of connectors annotated with EgressConnector which can use the operation annotated with this annotation as it's operations
String	description The description of the connector operation to be shown in the pallet
String	displayName The display name of the connector operation to be used in the pallet

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	documentationURL The location of the documentation page for the particular Connector Operation
String	iconFileName The icon file name to be used for rendering the icon representing the operation
boolean	requireConfiguration The property to decide whether to show the configuration view when it is dropped in the pallet.
ScopeType	scope The scope of this element defining the positions where elements annotated with this annotation can be placed

Element Detail

displayName

public abstract String displayName

The display name of the connector operation to be used in the pallet

Returns:

the display name of the operation

belongsTo

public abstract Class<? extends XEgressConnectorElement>[] belongsTo

The set of connectors annotated with EgressConnector which can use the operation annotated with this annotation as it's operations

Returns:

the list of egress connector identifiers to which this operation can belong to

description

public abstract String description

The description of the connector operation to be shown in the pallet

Returns:

the description of the connector operation

iconFileName

public abstract String iconFileName

The icon file name to be used for rendering the icon representing the operation

Returns:

the icon file name of the operation

Default:

"default"

scope

public abstract ScopeType scope

The scope of this element defining the positions where elements annotated with this annotation can be placed

Returns:

the scope of the connector operation

Default:

org.adroitlogic.x.api.config.ScopeType.ALL

requireConfiguration

public abstract boolean requireConfiguration

The property to decide whether to show the configuration view when it is dropped in the pallet. If true, when processing element is added, the property pane will be visible automatically and if false, property pane will not be visible when element is added.

Returns:

whether the configuration window should be visible or not

Default:

true

documentationURL

public abstract String documentationURL

The location of the documentation page for the particular Connector Operation

Returns:

the URL of the documentation page

Default:

"https://developer.adroitlogic.com"