Package com.ptc.wvs.common.ui

Class ProcessingAction

java.lang.Object
com.ptc.wvs.common.ui.ProcessingAction
Direct Known Subclasses:
PublisherAction
public abstract class ProcessingAction extends Object
This class provides base functionality for creating action strings. An action string contains specific options for WVS Processing Jobs. The format of the action string is: name1=value1,name2=value2 The use of the toString method will return the action string with the correct format. Note: as "=" and "," are used as separators, name and value can not contain these characters and they will be removed.

Supported API: true

Extendable: true
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    QUEUEPRIORITY
    Action String Name for publish queue priority Value can be: "H" - high priory "M" - medium priority "L" - low priority

    Supported API: true
    static final String
    QUEUESET
    Action String Name for publish queue set to be used Value can be: any queue set that has been defined

    Supported API: true

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    ProcessingAction()
    Create a new ProcessingAction object.
     
    ProcessingAction(String name, String value)
    Create a new ProcessingAction object, specifying an action Neither name or value can be null

    Supported API: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAction(String name, String value)
    Adds a name/value pair to the action string list Neither name or value can be null

    Supported API: true
    Map
    getActions()
    Return the map of actions in the PublisherAction

    Supported API: true
    static boolean
    isSet(String actionString, String key)
    Checks the existence of the key in the actionString

    Supported API: true
    static boolean
    isSynchronous(String _actionString)
    Checks if the given action string is Synchronous.
    static String
    removeSynchronous(String _actionString)
    Remove the Synchronous options from the given actionString.
    String
    toString()
    Format the action for use in the call to Publisher.doPublish

    Supported API: true

    Methods inherited from class java.lang.Object

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

  • Field Details

    • QUEUEPRIORITY

      public static final String QUEUEPRIORITY
      Action String Name for publish queue priority Value can be: "H" - high priory "M" - medium priority "L" - low priority

      Supported API: true
      See Also:

    • QUEUESET

      public static final String QUEUESET
      Action String Name for publish queue set to be used Value can be: any queue set that has been defined

      Supported API: true
      See Also:

  • Constructor Details

    • ProcessingAction

      public ProcessingAction()
      Create a new ProcessingAction object.

      Supported API: true

    • ProcessingAction

      public ProcessingAction(String name, String value)
      Create a new ProcessingAction object, specifying an action Neither name or value can be null

      Supported API: true
      Parameters:
      name - action name
      value - action value

  • Method Details

    • addAction

      public void addAction(String name, String value)
      Adds a name/value pair to the action string list Neither name or value can be null

      Supported API: true
      Parameters:
      name - action name
      value - action value

    • getActions

      public Map getActions()
      Return the map of actions in the PublisherAction

      Supported API: true
      Returns:
      Map of actions

    • isSynchronous

      public static boolean isSynchronous(String _actionString)
      Checks if the given action string is Synchronous.

      Supported API: true
      Parameters:
      _actionString - String - String to evaluate.
      Returns:
      boolean - Returns true if the given string is Synchronous.

    • removeSynchronous

      public static String removeSynchronous(String _actionString)
      Remove the Synchronous options from the given actionString.

      Supported API: true
      Parameters:
      _actionString - String - Action string to remove Synchronous from.
      Returns:
      String - New non-synchronous action string.

    • toString

      public String toString()
      Format the action for use in the call to Publisher.doPublish

      Supported API: true
      Overrides:
      toString in class Object
      Returns:
      stringified action string that starts with <wvsoptions>.

    • isSet

      public static boolean isSet(String actionString, String key)
      Checks the existence of the key in the actionString

      Supported API: true
      Returns:
      boolean