Package com.mayam.wf.config.shared

Enum Class UiActivity

java.lang.Object
java.lang.Enum<UiActivity>
com.mayam.wf.config.shared.UiActivity
All Implemented Interfaces:
Activity, Serializable, Comparable<UiActivity>, Constable
public enum UiActivity extends Enum<UiActivity> implements Activity
Describes UI activities availble in the Tasks UI.
Author:
Markus Mårtensson

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface com.mayam.wf.config.shared.Activity

    Activity.InputAttributes, Activity.Interactive, Activity.Internal, Activity.OutputAttributes

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADD_PEER_TO_ADOBE_PROJECT
    Adds peer item media in the current task to a project in Adobe Premiere Pro or Photoshop
    ADD_TO_ADOBE_PROJECT
    Adds media in the current task to a project in Adobe Premiere Pro or Photoshop
    ASSIGN_VALUES
    Assigns values to the subject(s).
    ATTACH
    Allows the user to upload file attachments.
    BPMS_VIEW
    Displays a view of the current BPMS state.
    DIALOG
     
    DISCUSSION
    Allows the user to take an active part in a discussion.
    FILTER_CHILDREN
    Causes tasks to be filtered by a given set of values for PARENT_TASK_ID.
    FILTER_RELATED
    Causes tasks to be filtered using a set of attributes, values of which are taken from the currently selected task.
    FORM
    Displays the form specified in Attribute.FORM_ID, merging any changed made to the subjects.
    GET_MAM_BOOKMARKS
    Causes MAM_BOOKMARKS to be set based on the Viz One stack or equivalent.
    GET_SEARCH_VIEW
    Sets SEARCH_VIEW to the current search view, including changes made since last save.
    HIGHLIGHT_TASK
    Ensures that a task is visible in the task list and makes it stand out temporarily.
    INVOKE
    Invokes an external application for the primary asset.
    INVOKE_ACCURATE_PLAYER
    Invokes the Accurate Player.
    INVOKE_ADOBE_EXPORT
    Invoke a media export operation in Adobe Premiere or Photoshop.
    INVOKE_BIRT
    Invoke the BIRT viewer, allowing reports to be viewed and/or exported.
    INVOKE_EXCEL_EXPORT
    Invoke the synchronous Excel export with http download to from browser
    MATCHBOX_ADD_ENTRIES
    Causes task(s) to be added to the matchbox.
    MATCHBOX_CONTENTS
    Causes MATCHBOX_CONTENTS to be set to full list of tasks currently in the match box, full attribute maps as received by the client.
    MATCHBOX_GET_ENTRY
    Causes TASK_PEER_ID to be set to the focused task in the matchbox.
    MATCHBOX_REMOVE_ENTRY
    Causes TASK_PEER_ID to be set to the focused task of the matchbox, which is then removed.
    NAVIGATE
    Navigates to the specified screen.
    OMS_HOST_VALUES
    Fetching host values from the Pilot, transforming them into a fixed set of attributes.
    OMS_NOTIFY_CREATE
    Notifies the Pilot that an order has been created.
    PEER_INVOKE
    Invokes an external application for the peer asset.
    PRINT
    Displays the print view
    RAW_EDIT
    Raw editing, meaning the user is presented with an editable JSON view of the task.
    REFRESH_TASKLIST
    Updates the current tasklist.
    RIO_PARK
    Parks the current timeline clip and produces a BOM (Bill of Materials) for the clip.
    RIO_PUBLISH_FILE
    The timeline clip will be published to the configured SQ server and produces a BOM for the clip.
    RIO_PUBLISH_SQ
    The timeline clip will be published to the configured SQ server and produces a BOM for the clip.
    RIO_TAKE
    Timeline will be setup with a blank 1 minute clip of the specified resolution and all sources placed into a project folder in the RIO Editor’s clips bin
    SPLIT_VIEW
    Splits the view, showing Viz One asset to the right.
    TABLE_SUBSET
    Allows the user to define a subset of the rows of one table which will then make up the rows of a second table.
    TASK_HISTORY
    Displays the history view
    TEMPORARY_SEARCH_VIEW
    If SEARCH_VIEW is set, creates a temporary search view.
    UPLOAD
    Allows the user to upload files to a ManagedFolder.

  • Method Summary

    Modifier and Type
    Method
    Description
    static UiActivity
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static UiActivity[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ASSIGN_VALUES

      public static final UiActivity ASSIGN_VALUES
      Assigns values to the subject(s). Can thought of as having an Activity.InputAttributes.value() set to all of Attribute.values().

    • BPMS_VIEW

      @Interactive public static final UiActivity BPMS_VIEW
      Displays a view of the current BPMS state.

    • DIALOG

      @Interactive @InputAttributes({DLG_TITLE,DLG_STATIC_MESSAGE}) public static final UiActivity DIALOG

    • FORM

      @Interactive @InputAttributes(FORM_ID) public static final UiActivity FORM
      Displays the form specified in Attribute.FORM_ID, merging any changed made to the subjects.

    • TASK_HISTORY

      @Interactive public static final UiActivity TASK_HISTORY
      Displays the history view

    • PRINT

      @Interactive public static final UiActivity PRINT
      Displays the print view

    • HIGHLIGHT_TASK

      public static final UiActivity HIGHLIGHT_TASK
      Ensures that a task is visible in the task list and makes it stand out temporarily.

    • REFRESH_TASKLIST

      public static final UiActivity REFRESH_TASKLIST
      Updates the current tasklist. Use after creating new task if you want it to show instantly

    • INVOKE

      public static final UiActivity INVOKE
      Invokes an external application for the primary asset. The choice will be made based on the value of Attribute.LAST_USER_ACTION which is set upon clicking a user action button. Supported are only the values of UserAction that begin with INVOKE_.

    • PEER_INVOKE

      public static final UiActivity PEER_INVOKE
      Invokes an external application for the peer asset. The choice will be made based on the value of Attribute.LAST_USER_ACTION which is set upon clicking a user action button. Supported are only the values of UserAction that begin with PEER_INVOKE_.

    • ATTACH

      @Interactive public static final UiActivity ATTACH
      Allows the user to upload file attachments. Prior to 2.6, this functionality was called UPLOAD.
      See Also:

    • UPLOAD

      @Interactive public static final UiActivity UPLOAD
      Allows the user to upload files to a ManagedFolder. The specific folder is specified by its attribute name (eg. MANAGED_FOLDER_3) in ACTIVITY_PARAM.

    • ADD_TO_ADOBE_PROJECT

      public static final UiActivity ADD_TO_ADOBE_PROJECT
      Adds media in the current task to a project in Adobe Premiere Pro or Photoshop

    • ADD_PEER_TO_ADOBE_PROJECT

      public static final UiActivity ADD_PEER_TO_ADOBE_PROJECT
      Adds peer item media in the current task to a project in Adobe Premiere Pro or Photoshop

    • INVOKE_ADOBE_EXPORT

      public static final UiActivity INVOKE_ADOBE_EXPORT
      Invoke a media export operation in Adobe Premiere or Photoshop. The target is the ASSET_SITE_ID of the selected task

    • INVOKE_BIRT

      public static final UiActivity INVOKE_BIRT
      Invoke the BIRT viewer, allowing reports to be viewed and/or exported.

    • INVOKE_EXCEL_EXPORT

      public static final UiActivity INVOKE_EXCEL_EXPORT
      Invoke the synchronous Excel export with http download to from browser

    • INVOKE_ACCURATE_PLAYER

      public static final UiActivity INVOKE_ACCURATE_PLAYER
      Invokes the Accurate Player.

    • FILTER_CHILDREN

      @InputAttributes(TASK_LIST_ID) public static final UiActivity FILTER_CHILDREN
      Causes tasks to be filtered by a given set of values for PARENT_TASK_ID.

    • DISCUSSION

      public static final UiActivity DISCUSSION
      Allows the user to take an active part in a discussion.

    • SPLIT_VIEW

      public static final UiActivity SPLIT_VIEW
      Splits the view, showing Viz One asset to the right.

    • RIO_TAKE

      public static final UiActivity RIO_TAKE
      Timeline will be setup with a blank 1 minute clip of the specified resolution and all sources placed into a project folder in the RIO Editor’s clips bin

    • RIO_PARK

      public static final UiActivity RIO_PARK
      Parks the current timeline clip and produces a BOM (Bill of Materials) for the clip.

    • RIO_PUBLISH_SQ

      public static final UiActivity RIO_PUBLISH_SQ
      The timeline clip will be published to the configured SQ server and produces a BOM for the clip.

    • RIO_PUBLISH_FILE

      public static final UiActivity RIO_PUBLISH_FILE
      The timeline clip will be published to the configured SQ server and produces a BOM for the clip.

    • MATCHBOX_ADD_ENTRIES

      public static final UiActivity MATCHBOX_ADD_ENTRIES
      Causes task(s) to be added to the matchbox.

    • MATCHBOX_GET_ENTRY

      public static final UiActivity MATCHBOX_GET_ENTRY
      Causes TASK_PEER_ID to be set to the focused task in the matchbox.

    • MATCHBOX_REMOVE_ENTRY

      public static final UiActivity MATCHBOX_REMOVE_ENTRY
      Causes TASK_PEER_ID to be set to the focused task of the matchbox, which is then removed. Matchbox is closed if no entries remain.

    • MATCHBOX_CONTENTS

      public static final UiActivity MATCHBOX_CONTENTS
      Causes MATCHBOX_CONTENTS to be set to full list of tasks currently in the match box, full attribute maps as received by the client. Note that this typically does not include UnmanagedMetadata. Also note that the currently focused entry, if required, needs to be fetched separately with a MATCHBOX_GET_ENTRY activity.

    • GET_MAM_BOOKMARKS

      public static final UiActivity GET_MAM_BOOKMARKS
      Causes MAM_BOOKMARKS to be set based on the Viz One stack or equivalent.

    • GET_SEARCH_VIEW

      public static final UiActivity GET_SEARCH_VIEW
      Sets SEARCH_VIEW to the current search view, including changes made since last save.

    • TEMPORARY_SEARCH_VIEW

      public static final UiActivity TEMPORARY_SEARCH_VIEW
      If SEARCH_VIEW is set, creates a temporary search view. Should only be used with task multiplicity of ZERO or EXACTLY_ONE.

    • TABLE_SUBSET

      @InputAttributes(ACTIVITY_PARAM) public static final UiActivity TABLE_SUBSET
      Allows the user to define a subset of the rows of one table which will then make up the rows of a second table. The attributes of the two tables are to be provided, separated by comma, in ACTIVITY_PARAM, e.g. "TABLE8,TEMP_TABLE_1".

    • RAW_EDIT

      public static final UiActivity RAW_EDIT
      Raw editing, meaning the user is presented with an editable JSON view of the task.

    • OMS_HOST_VALUES

      @OutputAttributes({REQ_KEYWORDS,REQ_TEMPLATE,REQ_TEMPLATE_CONCEPT,REQ_WIDTH,REQ_HEIGHT}) public static final UiActivity OMS_HOST_VALUES
      Fetching host values from the Pilot, transforming them into a fixed set of attributes.

    • OMS_NOTIFY_CREATE

      public static final UiActivity OMS_NOTIFY_CREATE
      Notifies the Pilot that an order has been created.

  • Method Details

    • values

      public static UiActivity[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static UiActivity valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null