com.day.cq.wcm.commons.status

Class EditorResourceStatus.Action

java.lang.Object

com.day.cq.wcm.commons.status.EditorResourceStatus.Action

Enclosing class:

EditorResourceStatus

public static class EditorResourceStatus.Action
extends java.lang.Object

Defines an action for an EditorResourceStatus. An action is defined by an id and a label, which are used in the user interface to identify and render the action, respectively.

Actions are created using EditorResourceStatus.Builder.addAction(String, String).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of this action.
java.lang.String	getLabel() Returns the label of this action, which is used in the user interface to render the action.

Methods inherited from class java.lang.Object

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

Method Detail

getId

@Nonnull
public java.lang.String getId()

Returns the id of this action. The action id is used in the user interface to identify this action, such that it can be acted upon when triggered.

In order to ensure that an action id is unique across different statuses, it should generally be prefixed by the status type (see ResourceStatusProvider.getType()).

Returns:

the action id

getLabel

@Nonnull
public java.lang.String getLabel()

Returns the label of this action, which is used in the user interface to render the action.

Returns:

the action label