Package org.neotropic.kuwaiba.core.apis.integration.modules.actions

Class AbstractAction

java.lang.Object

org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractAction

Direct Known Subclasses:

AddIpAddrToFolderAction, AddIpAddrToSubnetAction, AssociateObjectToProjectAction, AssociateObjectToProxyAction, AssociateObjectToServiceAction, AssociateProjectAction, ConnectivityManagerAction, CopyBusinessObjectAction, DeleteAttributeAction, DeleteBusinessObjectAction, DeleteClassAction, DeleteConfigurationVariableAction, DeleteConfigurationVariablesPoolAction, DeleteContactAction, DeleteContractAction, DeleteContractsPoolAction, DeleteCustomerAction, DeleteCustomerPoolAction, DeleteFavoriteAction, DeleteFilterDefinitionAction, DeleteFolderAction, DeleteGroupAction, DeleteIpAddrFromFolderAction, DeleteLayoutViewAction, DeleteListTypeItemAction, DeleteMplsViewAction, DeleteParameterAction, DeletePoolAction, DeleteProjectAction, DeleteProjectActivityAction, DeleteProjectsPoolAction, DeleteProxiesPoolAction, DeleteProxyAction, DeleteReportAction, DeleteScriptAction, DeleteScriptedQueryPoolAction, DeleteSdhViewAction, DeleteServiceAction, DeleteServicePoolAction, DeleteSparePoolAction, DeleteSubnetAction, DeleteSyncDataSourceConfigurationAction, DeleteSynchronizationGroupAction, DeleteTaskAction, DeleteTaskParameterAction, DeleteTaskUserAction, DeleteTemplateAction, DeleteTemplateItemAction, DeleteTemplateSubItemAction, DeleteTopologyViewAction, DeleteUserAction, DeleteValidatorDefinitionAction, DeleteWarehouseAction, DetachFileAction, FavoritesAction, ManagePortMirroringAction, MoveBusinessObjectAction, NewAttributeAction, NewBulkTemplateItemAction, NewBulkTemplateSpecialItemAction, NewBusinessObjectAction, NewBusinessObjectFromTemplateAction, NewClassAction, NewClassReportAction, NewConfigurationVariableAction, NewConfigurationVariablesPoolAction, NewContactAction, NewContractAction, NewContractsPoolAction, NewCustomerAction, NewCustomerPoolAction, NewFavoriteAction, NewFilterDefinitionAction, NewFolderAction, NewGroupAction, NewInventoryReportAction, NewLayoutViewAction, NewListTypeItemAction, NewMplsViewAction, NewMultipleBusinessObjectsAction, NewParameterAction, NewPoolAction, NewPoolItemAction, NewProjectAction, NewProjectActivityAction, NewProjectsPoolAction, NewProxiesPoolAction, NewProxyAction, NewScriptedQueryAction, NewScriptedQueryPoolAction, NewSdhViewAction, NewServiceAction, NewServicePoolAction, NewSparePartAction, NewSparePoolAction, NewSubnetAction, NewSyncDataSourceConfigurationAction, NewSynchronizationGroupAction, NewTaskAction, NewTaskParameterAction, NewTaskUserAction, NewTemplateAction, NewTemplateItemAction, NewTemplateSpecialItemAction, NewTopologyViewAction, NewUserAction, NewValidatorDefinitionAction, NewWarehouseAction, ReleaseObjectAction, ReleaseObjectFromProjectAction, ReleaseObjectFromServiceAction, ReleaseProjectAction, ReleaseSyncDataSourceConfigurationAction, RunSynchronizationAction, SplitSubnetAction, TerminateSessionAction, UpdateFilterDefinitionAction, UpdateIpAddrAction, UpdateTaskAction, UpdateTaskParameterAction, UpdateValidatorDefinitionAction

public abstract class AbstractAction
extends Object

All actions in a module must extend from this class, no matter if the are business, application or metadata related.

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractAction.ModuleActionCallback	A functional interface callback code to be executed once the action is triggered.

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractAction.ModuleActionCallback	callback	What is to be execute once the action is triggered.
protected String	description	A short description of what the action does, mainly to be used as tool text tip.
protected String	displayName	The label to be used in menus or buttons.
protected com.vaadin.flow.component.icon.Icon	icon	An icon to represent the action.
protected String	id	A unique identifier for the action within the module .
protected int	order	This number will be used to position the action in menus (0 is the highest priority/importance).

Constructor Summary

Constructors

Constructor	Description
AbstractAction()

Method Summary

Modifier and Type	Method	Description
AbstractAction.ModuleActionCallback	getCallback()
String	getDescription()
String	getDisplayName()
com.vaadin.flow.component.icon.Icon	getIcon()
String	getId()
int	getOrder()
abstract int	getRequiredAccessLevel()	Returns the privilege needed to execute the current action.
abstract boolean	requiresConfirmation()	Does this action requires confirmation before executing it? This is typically true for actions that will delete or otherwise dispose of some resources.
void	setCallback(AbstractAction.ModuleActionCallback callback)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setIcon(com.vaadin.flow.component.icon.Icon icon)
void	setId(String id)
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

A unique identifier for the action within the module .

displayName

protected String displayName

The label to be used in menus or buttons.

description

protected String description

A short description of what the action does, mainly to be used as tool text tip.

icon

protected com.vaadin.flow.component.icon.Icon icon

An icon to represent the action.

order

protected int order

This number will be used to position the action in menus (0 is the highest priority/importance). The default value is 1000.

callback

protected AbstractAction.ModuleActionCallback callback

What is to be execute once the action is triggered.

Constructor Detail

AbstractAction

public AbstractAction()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

getIcon

public com.vaadin.flow.component.icon.Icon getIcon()

setIcon

public void setIcon(com.vaadin.flow.component.icon.Icon icon)

setCallback

public void setCallback(AbstractAction.ModuleActionCallback callback)

getCallback

public AbstractAction.ModuleActionCallback getCallback()

getRequiredAccessLevel

public abstract int getRequiredAccessLevel()

Returns the privilege needed to execute the current action. This access level should be matched with the permissions granted to the user and the renderer must decide if it will gray-out the action or simply not show it.

Returns:

The access level needed to execute this action. See Privilege.ACCESS_LEVEL_XXX for possible values.

requiresConfirmation

public abstract boolean requiresConfirmation()

Does this action requires confirmation before executing it? This is typically true for actions that will delete or otherwise dispose of some resources. The consumer of the action might ignore this flag and simply execute the action.

Returns: