org.gcube.informationsystem.model.entity.facet

Interface ActionFacet

All Superinterfaces:

org.gcube.informationsystem.model.entity.Entity, org.gcube.informationsystem.model.ER, org.gcube.informationsystem.model.entity.Facet, org.gcube.informationsystem.model.ISManageable, NameProperty, Serializable

All Known Implementing Classes:

ActionFacetImpl

public interface ActionFacet
extends org.gcube.informationsystem.model.entity.Facet, NameProperty

This facet is expected to capture information on how to instantiate a SoftwareFacet.

Author:

Manuele Simi (ISTI-CNR) https://wiki.gcube-system.org/gcube/Facet_Based_Resource_Model#Action_Facet

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActionFacet.TYPE
static class	ActionFacet.WHEN

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
static String	NAME
static String	TYPE_PROPERTY
static String	VERSION
static String	WHEN_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.ER

HEADER_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.ISManageable

CLASS_PROPERTY, SUPERCLASSES_PROPERTY

Fields inherited from interface org.gcube.informationsystem.model.entity.facet.NameProperty

NAME_PROPERTY

Method Summary

Modifier and Type	Method and Description
String	getCommand() Gets the command to execute.
String	getOptions() The options/params to use when executing the action.
String	getSource() From where to download the action.
ActionFacet.TYPE	getType() Type of action.
ActionFacet.WHEN	getWhen() When the action is triggered.
void	setCommand(String command) Sets the command to execute.
void	setOptions(String options) The options for the actions.
void	setSource(String source) A remote source used by the command.
void	setType(ActionFacet.TYPE type)
void	setWhen(ActionFacet.WHEN when)

Methods inherited from interface org.gcube.informationsystem.model.entity.Facet

getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty

Methods inherited from interface org.gcube.informationsystem.model.entity.Entity

getHeader

Methods inherited from interface org.gcube.informationsystem.model.ER

setHeader

Methods inherited from interface org.gcube.informationsystem.model.entity.facet.NameProperty

getName, setName

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

VERSION

static final String VERSION

See Also:

Constant Field Values

TYPE_PROPERTY

static final String TYPE_PROPERTY

See Also:

Constant Field Values

WHEN_PROPERTY

static final String WHEN_PROPERTY

See Also:

Constant Field Values

Method Detail

getWhen

ActionFacet.WHEN getWhen()

When the action is triggered.

Returns:

an instance of ActionFacet.WHEN

setWhen

void setWhen(ActionFacet.WHEN when)

Parameters:

when -

getType

ActionFacet.TYPE getType()

Type of action.

Returns:

an instance of ActionFacet.TYPE

setType

void setType(ActionFacet.TYPE type)

Parameters:

type -

getSource

String getSource()

From where to download the action.

Returns:

URL or Endpoint

setSource

void setSource(String source)

A remote source used by the command. Could be the endpoint of a service, the location of a remote ansible playbook, etc.

Parameters:

source -

getOptions

String getOptions()

The options/params to use when executing the action.

Returns:

the command to execute to lauch the action

setOptions

void setOptions(String options)

The options for the actions.

Parameters:

options -

setCommand

void setCommand(String command)

Sets the command to execute.

Parameters:

command -

getCommand

String getCommand()

Gets the command to execute.

Returns:

the command