Package com.appiancorp.suiteapi.process

Class PaletteItem

java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.PaletteItem
All Implemented Interfaces:
LocalId, XMLable, Serializable
public class PaletteItem extends Identity implements XMLable
A node that appears in a palette in the process designer, and can be dropped onto the canvas to add an activity to a process model. There are two icons that must be configured for every Smart Node.
  • Palette Icon: The graphical representation of the Smart Node on a Palette.
  • Canvas Icon: The graphical representation of the Smart Node on the Process Model Design Area.
See Also:

  • Constructor Details

    • PaletteItem

      public PaletteItem()

    • PaletteItem

      public PaletteItem(PaletteItem other)
      Creates a shallow copy of the given PaletteItem.

  • Method Details

    • getStaticResourcePrefix

      public String getStaticResourcePrefix()
      Returns the relative URL prefix for all static web resources. The URL prefix does not contain the application server context. Example, if the absolute URL prefix would be: "http://www.acme.com/suite/s/1268848383871/1/_" Then this method will return the prefix in a format like "/s/1268848383871/1/_"
      Returns:
      The relative URL prefix for static web resources without the application server context.

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean enabled)

    • getEventProducer

      public Long getEventProducer()
      Gets the type code for the event producer
      Returns:
      the type code for the event producer

    • setEventProducer

      public void setEventProducer(Long eventProducer_)
      Sets the type code for the event producer
      Parameters:
      eventProducer_ - the type code for the event producer

    • getPreTrigger

      public Long getPreTrigger()
      Gets the type code for the pre-trigger
      Returns:
      the type code for the pre-trigger

    • setPreTrigger

      public void setPreTrigger(Long preTrigger_)
      Sets the type code for the pre-trigger
      Parameters:
      preTrigger_ - the type code for the pre-trigger

    • getPostTrigger

      public Long getPostTrigger()
      Gets the type code for the post-trigger
      Returns:
      the type code for the post-trigger

    • setPostTrigger

      public void setPostTrigger(Long postTrigger_)
      Sets the type code for the post-trigger
      Parameters:
      postTrigger_ - the type code for the post-trigger

    • getAppianType

      public Long getAppianType()
      Gets the related Appian type ID.
      Returns:
      the related Appian type ID.

    • setAppianType

      public void setAppianType(Long appianType_)
      Sets the related Appian type ID.
      Parameters:
      appianType_ - the related Appian type ID.

    • getAcSchemaId

      public Long getAcSchemaId()
      Returns the ID of the activity class schema associated with this palette item
      Returns:
      the unique ID of the activity class schema

    • setAcSchemaId

      public void setAcSchemaId(Long acSchemaId_)
      Sets the associated activity class schema ID
      Parameters:
      acSchemaId_ - the ID of the activity class schema

    • getCanvasIcon

      public Long getCanvasIcon()
      Returns the ID of the canvas icon
      Returns:
      the id of the canvas icon

    • setCanvasIcon

      public void setCanvasIcon(Long canvasIcon_)
      Sets the ID of the canvas icon
      Parameters:
      canvasIcon_ - the ID of the canvas icon

    • getPaletteIcon

      public Long getPaletteIcon()
      Returns the ID of the palette icon
      Returns:
      the ID of the palette icon

    • setPaletteIcon

      public void setPaletteIcon(Long paletteIcon_)
      Sets the ID of the palette icon
      Parameters:
      paletteIcon_ - the ID of the palette icon

    • getIsCustomPlugin

      public boolean getIsCustomPlugin()
      Returns whether this palette item is a custom plugin Returns: whether this palette item is a custom plugin

    • setIsCustomPlugin

      public void setIsCustomPlugin(boolean isCustomPlugin)
      Sets whether this palette item is a custom plugin
      Parameters:
      isCustomPlugin - - whether this palette item is a custom plugin

    • getResourceKey

      public String getResourceKey()
      Returns the resource bundle key for this palette item's display name. When present, the name should be resolved from the palette resource bundle using this key.
      Returns:
      the resource key, or null if the item uses the raw name

    • setResourceKey

      public void setResourceKey(String resourceKey)
      Sets the resource bundle key for this palette item's display name.
      Parameters:
      resourceKey_ - the resource key

    • getResourceBundleName

      public String getResourceBundleName()
      Returns the base name of the resource bundle used to resolve this palette item's display name. When null, the default palette resource bundle is used.
      Returns:
      the resource bundle base name, or null if using the default palette bundle

    • setResourceBundleName

      public void setResourceBundleName(String resourceBundleName)
      Sets the base name of the resource bundle used to resolve this palette item's display name.
      Parameters:
      resourceBundleName - the resource bundle base name

    • getType

      public String getType()
      Returns the type of this palette item, which determines how its resource bundle is loaded.
      Returns:
      the palette item type name, or null if not set
      See Also:

    • setType

      public void setType(String type)
      Sets the type of this palette item.
      Parameters:
      type - the palette item type name
      See Also:

    • getLocalizedNames

      public Map<String,String> getLocalizedNames()
      Returns a map of locale key to localized display name for this palette item. Used by the client to set the correct name for each language tab when a node is dropped.
      Returns:
      the locale-to-name map, or null if not populated

    • setLocalizedNames

      public void setLocalizedNames(Map<String,String> localizedNames)
      Sets the map of locale key to localized display name.
      Parameters:
      localizedNames_ - the locale-to-name map

    • toXML

      public String toXML()
      Converts this palette item to xml and returns it as a string.
      Specified by:
      toXML in interface XMLable
      Returns:
      a String containing the XML serialization of this palette item

    • toXML

      public void toXML(StringBuilder buffer_)
      Converts the palette item to XML and stores it in a StringBuffer
      Specified by:
      toXML in interface XMLable
      Parameters:
      buffer_ - the StringBuffer to append the XML to

    • getAcSchemaLocalId

      public String getAcSchemaLocalId()
      Returns the local ID of the activity class schema associated with this palette item (specified by the local-id attribute in the XML file)
      Returns:
      the local ID of the activity class schema

    • setAcSchemaLocalId

      public void setAcSchemaLocalId(String acSchemaLocalId_)
      Sets the local ID of the activity class schema associated with this palette item
      Parameters:
      acSchemaLocalId_ - The acSchemaLocalId to set.