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

Class AbstractVisualInventoryAction

java.lang.Object

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

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

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

AbstractDeleteAction, AbstractRelationshipManagementAction, AbstractVisualAdvancedAction, AddIpAddrToFolderVisualAction, AddIpAddrToSubnetVisualAction, CopyBusinessObjectToPoolVisualAction, CopyBusinessObjectVisualAction, CopySpecialBusinessObjectVisualAction, DeleteFolderVisualAction, DeleteIpAddrFromFolderVisualAction, ManageAttachmentsVisualAction, ManageSpecialRelationshipsVisualAction, MoveBusinessObjectToPoolVisualAction, MoveBusinessObjectVisualAction, MoveSpecialBusinessObjectActionVisual, NewBusinessObjectFromTemplateVisualAction, NewBusinessObjectVisualAction, NewFolderVisualAction, NewMultipleBusinessObjectsVisualAction, NewMultipleSpecialBusinessObjectsVisualAction, NewServiceFromTemplateVisualAction, NewSpecialBusinessObjectFromTemplateVisualAction, NewSpecialBusinessObjectVisualAction, NewSpecialRelationshipVisualAction, NewSubnetVisualAction, RelateObjectToFavoritesFolderVisualAction, RelateToVisualAction, RelationshipManagementVisualAction, ReleaseMultipleSpecialRelationshipVisualAction, ReleaseObjectFromFavoritesFolderVisualAction, ReleaseSpecialRelationshipVisualAction, SplitSubnetVisualAction

public abstract class AbstractVisualInventoryAction
extends AbstractVisualAction

Actions applicable to inventory objects must inherit from this class.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

AbstractVisualAction.VisualActionType

Field Summary

Fields

Modifier and Type	Field	Description
static int	SELECTION_ANY_OBJECTS
static int	SELECTION_NO_OBJECTS

Fields inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

childrenActions, formatOptions, icon, listeners, moduleId, type

Constructor Summary

Constructors

Constructor	Description
AbstractVisualInventoryAction(String moduleId)

Method Summary

Modifier and Type	Method	Description
String	appliesTo()	Tells the system what inventory objects support said action.
String	getName()
abstract int	getRequiredSelectedObjects()	How many objects have to be selected so this action is enabled.
String	toString()

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

clearListeners, compareTo, fireActionCompletedEvent, getChildrenActions, getFormatOptions, getIcon, getModuleAction, getModuleId, getVisualComponent, registerActionCompletedLister, setChildrenActions, setFormatOptions, setIcon, setModuleId, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

SELECTION_NO_OBJECTS

public static final int SELECTION_NO_OBJECTS

See Also:

Constant Field Values

SELECTION_ANY_OBJECTS

public static final int SELECTION_ANY_OBJECTS

See Also:

Constant Field Values

Constructor Detail

AbstractVisualInventoryAction

public AbstractVisualInventoryAction(String moduleId)

Method Detail

appliesTo

public String appliesTo()

Tells the system what inventory objects support said action. Superclasses are also allowed. For example, returning GenericCommunicationsElement applies to all devices such as routers, multiplexers or switches, while InventoryObject will apply to any object.

Returns:

The class or superclass whose instances the action applies to. If null, this indicate that while the action is related to inventory, it doesn't apply to a particular type, for example, when creating a Customer pool in the service manager (or any root pool, for that matter). By default, the action will apply to all instances.

getRequiredSelectedObjects

public abstract int getRequiredSelectedObjects()

How many objects have to be selected so this action is enabled. Use -1 for any (-1), 0 if no objects have to be selected (0), or a number greater than 0 for a fixed number.

Returns:

The number of objects that have to be selected so the action is enabled.

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object