Package com.adobe.aem.dermis.model

Class Operation

java.lang.Object

com.adobe.aem.dermis.model.AbstractAsset

com.adobe.aem.dermis.model.Operation

All Implemented Interfaces:

IAsset, IOperation, java.io.Serializable

public class Operation
extends AbstractAsset
implements IOperation

Basic implementation of Operation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.aem.dermis.model.IOperation

IOperation.MethodType

Constructor Summary

Constructors

Constructor	Description
Operation()
Operation(java.lang.String name, java.lang.String description, IOperation.MethodType method, IProperty targetSchema, IProperty schema)
Operation(java.lang.String name, java.lang.String description, IOperation.MethodType method, IProperty targetSchema, IProperty schema, boolean genericOperation)
Operation(java.lang.String name, java.lang.String description, IOperation.MethodType method, IProperty targetSchema, IProperty schema, boolean genericOperation, boolean isHidden)
Operation(java.lang.String name, java.lang.String description, IOperation.MethodType method, IProperty targetSchema, IProperty schema, java.lang.String href)
Operation(java.lang.String name, java.lang.String title, java.lang.String description, IOperation.MethodType method, IProperty targetSchema, IProperty schema, boolean genericOperation, boolean isHidden)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHref()	Gets the href of this Operation
boolean	getIsHidden()	Represent whether a operation is Hidden on UI or not.
IOperation.MethodType	getMethod()	gets the method type of operation
java.lang.String	getRel()	Gets the rel of this Operation
IProperty	getSchema()	gets the lists of input arguments
java.lang.String	getSource()	Gets the source of Operation
IProperty	getTargetSchema()	gets the type of the returned object
boolean	hasMultipleArguments()	Utility method to check if operation have multiple arguments
boolean	isGenericOperation()	Represent if operation is generic in nature, which means it allow FDM author to add/remove argument of operation.
void	setGenericOperation(boolean genericOperation)	Sets true if this is generic operation
void	setIsHidden(boolean isHidden)	Set true if this operation should be Hidden on UI
void	setRel(java.lang.String rel)
void	setSource(java.lang.String source)	sets the source of Operation

Methods inherited from class com.adobe.aem.dermis.model.AbstractAsset

getDescription, getId, getName, getTitle, setDescription, setId, setName, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.aem.dermis.model.IAsset

getDescription, getId, getName, getTitle

Constructor Detail

Operation

public Operation()

Operation

public Operation(java.lang.String name,
                 java.lang.String description,
                 IOperation.MethodType method,
                 IProperty targetSchema,
                 IProperty schema)

Operation

public Operation(java.lang.String name,
                 java.lang.String description,
                 IOperation.MethodType method,
                 IProperty targetSchema,
                 IProperty schema,
                 boolean genericOperation)

Operation

public Operation(java.lang.String name,
                 java.lang.String description,
                 IOperation.MethodType method,
                 IProperty targetSchema,
                 IProperty schema,
                 boolean genericOperation,
                 boolean isHidden)

Operation

public Operation(java.lang.String name,
                 java.lang.String title,
                 java.lang.String description,
                 IOperation.MethodType method,
                 IProperty targetSchema,
                 IProperty schema,
                 boolean genericOperation,
                 boolean isHidden)

Operation

public Operation(java.lang.String name,
                 java.lang.String description,
                 IOperation.MethodType method,
                 IProperty targetSchema,
                 IProperty schema,
                 java.lang.String href)

Method Detail

getRel

public java.lang.String getRel()

Gets the rel of this Operation

Specified by:

getRel in interface IOperation

Returns:

the rel of this Operation

setRel

public void setRel(java.lang.String rel)

getHref

public java.lang.String getHref()

Gets the href of this Operation

Specified by:

getHref in interface IOperation

Returns:

the href of this Operation

getMethod

public IOperation.MethodType getMethod()

gets the method type of operation

Specified by:

getMethod in interface IOperation

Returns:

IOperation.MethodType

getTargetSchema

public IProperty getTargetSchema()

gets the type of the returned object

Specified by:

getTargetSchema in interface IOperation

Returns:

type of returned object

getSchema

public IProperty getSchema()

gets the lists of input arguments

Specified by:

getSchema in interface IOperation

hasMultipleArguments

public boolean hasMultipleArguments()

Utility method to check if operation have multiple arguments

Specified by:

hasMultipleArguments in interface IOperation

Returns:

- Returns true if operation takes more than one argument.

getSource

public java.lang.String getSource()

Gets the source of Operation

Specified by:

getSource in interface IOperation

Returns:

the source

setSource

public void setSource(java.lang.String source)

Description copied from interface: IOperation

sets the source of Operation

Specified by:

setSource in interface IOperation

isGenericOperation

public boolean isGenericOperation()

Represent if operation is generic in nature, which means it allow FDM author to add/remove argument of operation.

Specified by:

isGenericOperation in interface IOperation

Returns:

- Returns true if operation is generic.

setGenericOperation

public void setGenericOperation(boolean genericOperation)

Sets true if this is generic operation

Parameters:

genericOperation -

getIsHidden

public boolean getIsHidden()

Represent whether a operation is Hidden on UI or not.

Returns:

Returns true if operation is Hidden.

setIsHidden

public void setIsHidden(boolean isHidden)

Set true if this operation should be Hidden on UI

Parameters:

isHidden -