Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class ManagedUiActionDescription

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.ManagedUiActionDescription

All Implemented Interfaces:

IManagedUiAction, java.io.Serializable

Direct Known Subclasses:

ManagedUiTableActionDescription

public class ManagedUiActionDescription
extends java.lang.Object
implements IManagedUiAction, java.io.Serializable

Object that declaratively describes a UI for an action (e.g. describing UI of a dialog that should be shown after clicking on a button).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ManagedUiActionDescription()
ManagedUiActionDescription(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addInputWidgets(IManagedInputWidgetDescription... widgetDescriptions)	Adds specified input widget descriptions that will be used in user interface for modifcation of a managed property.
java.lang.String	getDescription()	Returns string describing the action behaviour.
java.lang.String	getInputValue(java.lang.String inputLabel)	Convenience method returning value of input widget with given label or null if such widget doesn't exist.
java.util.List<IManagedInputWidgetDescription>	getInputWidgetDescriptions()	Returns list of objects describing input widgets that will be used in user interface for modification of the managed property.
java.lang.String	getName()	Returns string identifier of the action.
IPerson	getPerson()	Returns invoker of the action or null if action wasn't invoked yet.
IManagedUiAction	setDescription(java.lang.String aDescription)	Sets a string describing the action behaviour.
void	setInputWidgetDescriptions(java.util.List<IManagedInputWidgetDescription> widgetDescriptions)
void	setPerson(IPerson person)

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedUiActionDescription

public ManagedUiActionDescription()

ManagedUiActionDescription

public ManagedUiActionDescription(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IManagedUiAction

Returns string identifier of the action.

Specified by:

getName in interface IManagedUiAction

getDescription

public java.lang.String getDescription()

Description copied from interface: IManagedUiAction

Returns string describing the action behaviour.

Specified by:

getDescription in interface IManagedUiAction

setDescription

public IManagedUiAction setDescription(java.lang.String aDescription)

Description copied from interface: IManagedUiAction

Sets a string describing the action behaviour.

Specified by:

setDescription in interface IManagedUiAction

Returns:

this (for method chaining)

getInputWidgetDescriptions

public java.util.List<IManagedInputWidgetDescription> getInputWidgetDescriptions()

Description copied from interface: IManagedUiAction

Returns list of objects describing input widgets that will be used in user interface for modification of the managed property.

Specified by:

getInputWidgetDescriptions in interface IManagedUiAction

setInputWidgetDescriptions

public void setInputWidgetDescriptions(java.util.List<IManagedInputWidgetDescription> widgetDescriptions)

addInputWidgets

public void addInputWidgets(IManagedInputWidgetDescription... widgetDescriptions)

Description copied from interface: IManagedUiAction

Adds specified input widget descriptions that will be used in user interface for modifcation of a managed property.

Specified by:

addInputWidgets in interface IManagedUiAction

getInputValue

public java.lang.String getInputValue(java.lang.String inputLabel)

Description copied from interface: IManagedUiAction

Convenience method returning value of input widget with given label or null if such widget doesn't exist.

Specified by:

getInputValue in interface IManagedUiAction

getPerson

public IPerson getPerson()

Description copied from interface: IManagedUiAction

Returns invoker of the action or null if action wasn't invoked yet.

Specified by:

getPerson in interface IManagedUiAction

setPerson

public void setPerson(IPerson person)