Package org.xwiki.livedata

Class LiveDataActionDescriptor

  • public class LiveDataActionDescriptor
extends BaseDescriptor
    Describes a live data action.
    Since:
    12.10.1, 13.0
    Version:
    $Id: fcd5d8f986f9e380a164a90fd8e7ce08eff8f495 $

    • Constructor Detail

      • LiveDataActionDescriptor

        public LiveDataActionDescriptor()
        Default constructor.

      • LiveDataActionDescriptor

        public LiveDataActionDescriptor​(String id)
        Creates a new descriptor for the specified action.
        Parameters:
        id - the action id

    • Method Detail

      • getName

        public String getName()
        Returns:
        the action pretty name

      • setName

        public void setName​(String name)
        Sets the action pretty name.
        Parameters:
        name - the new pretty name

      • getDescription

        public String getDescription()
        Returns:
        the action description

      • setDescription

        public void setDescription​(String description)
        Sets the action description.
        Parameters:
        description - the new action description

      • getIcon

        public Map<String,​Object> getIcon()
        Returns:
        the icon meta data

      • setIcon

        public void setIcon​(Map<String,​Object> icon)
        Sets the icon meta data.
        Parameters:
        icon - the new icon meta data

      • getAllowProperty

        public String getAllowProperty()
        Returns:
        the live data property used to determine if the current user is allowed to perform this action on a given live data entry
        Since:
        12.10.4, 13.0

      • setAllowProperty

        public void setAllowProperty​(String allowProperty)
        Sets the live data property to be used to determine if the current user is allowed to perform this action on a given live data entry.
        Parameters:
        allowProperty - the live data property used to determine if the current user is allowed to perform this action on a given live data entry
        Since:
        12.10.4, 13.0

      • getUrlProperty

        public String getUrlProperty()
        Returns:
        the live data property that holds the URL that can be used to perform this action on a given entry
        Since:
        12.10.4, 13.0

      • setUrlProperty

        public void setUrlProperty​(String urlProperty)
        Sets the live data property that holds the URL that can be used to perform this action on a given entry.
        Parameters:
        urlProperty - the live data property that holds the URL that can be used to perform this action on a given entry
        Since:
        12.10.4, 13.0

      • initialize

        public void initialize()
        Prevent null values where it's possible.