Class LayerCustomAction

    • Method Detail

      • customActionId

        public final String customActionId()

        The ID of the custom action.

        Returns:
        The ID of the custom action.
      • name

        public final String name()

        The name of the custom action.

        Returns:
        The name of the custom action.
      • statusAsString

        public final String statusAsString()

        The status of the LayerCustomAction.

        If the service returns an enum value that is not available in the current SDK version, status will return WidgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the LayerCustomAction.
        See Also:
        WidgetStatus
      • trigger

        public final LayerCustomActionTrigger trigger()

        The trigger of the LayerCustomAction.

        Valid values are defined as follows:

        • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

        • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

        If the service returns an enum value that is not available in the current SDK version, trigger will return LayerCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerAsString().

        Returns:
        The trigger of the LayerCustomAction.

        Valid values are defined as follows:

        • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

        • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

        See Also:
        LayerCustomActionTrigger
      • triggerAsString

        public final String triggerAsString()

        The trigger of the LayerCustomAction.

        Valid values are defined as follows:

        • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

        • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

        If the service returns an enum value that is not available in the current SDK version, trigger will return LayerCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from triggerAsString().

        Returns:
        The trigger of the LayerCustomAction.

        Valid values are defined as follows:

        • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

        • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

        See Also:
        LayerCustomActionTrigger
      • hasActionOperations

        public final boolean hasActionOperations()
        For responses, this returns true if the service returned a value for the ActionOperations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • actionOperations

        public final List<LayerCustomActionOperation> actionOperations()

        A list of LayerCustomActionOperations.

        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActionOperations() method.

        Returns:
        A list of LayerCustomActionOperations.

        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)