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
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:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the ID of the activity class schema associated with this palette itemReturns the local ID of the activity class schema associated with this palette item (specified by the local-id attribute in the XML file)Gets the related Appian type ID.Returns the ID of the canvas iconGets the type code for the event producerboolean
Returns whether this palette item is a custom plugin Returns: whether this palette item is a custom pluginReturns the ID of the palette iconGets the type code for the post-triggerGets the type code for the pre-triggerReturns the relative URL prefix for all static web resources.boolean
void
setAcSchemaId
(Long acSchemaId_) Sets the associated activity class schema IDvoid
setAcSchemaLocalId
(String acSchemaLocalId_) Sets the local ID of the activity class schema associated with this palette itemvoid
setAppianType
(Long appianType_) Sets the related Appian type ID.void
setCanvasIcon
(Long canvasIcon_) Sets the ID of the canvas iconvoid
setEnabled
(boolean enabled) void
setEventProducer
(Long eventProducer_) Sets the type code for the event producervoid
setIsCustomPlugin
(boolean isCustomPlugin) Sets whether this palette item is a custom pluginvoid
setPaletteIcon
(Long paletteIcon_) Sets the ID of the palette iconvoid
setPostTrigger
(Long postTrigger_) Sets the type code for the post-triggervoid
setPreTrigger
(Long preTrigger_) Sets the type code for the pre-triggertoXML()
Converts this palette item to xml and returns it as a string.void
toXML
(StringBuilder buffer_) Converts the palette item to XML and stores it in a StringBufferMethods inherited from class com.appiancorp.suiteapi.common.Identity
equals, getId, getName, getUuid, hashCode, setId, setName, setUuid, toString
-
Constructor Details
-
PaletteItem
public PaletteItem()
-
-
Method Details
-
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
Gets the type code for the event producer- Returns:
- the type code for the event producer
-
setEventProducer
Sets the type code for the event producer- Parameters:
eventProducer_
- the type code for the event producer
-
getPreTrigger
Gets the type code for the pre-trigger- Returns:
- the type code for the pre-trigger
-
setPreTrigger
Sets the type code for the pre-trigger- Parameters:
preTrigger_
- the type code for the pre-trigger
-
getPostTrigger
Gets the type code for the post-trigger- Returns:
- the type code for the post-trigger
-
setPostTrigger
Sets the type code for the post-trigger- Parameters:
postTrigger_
- the type code for the post-trigger
-
getAppianType
Gets the related Appian type ID.- Returns:
- the related Appian type ID.
-
setAppianType
Sets the related Appian type ID.- Parameters:
appianType_
- the related Appian type ID.
-
getAcSchemaId
Returns the ID of the activity class schema associated with this palette item- Returns:
- the unique ID of the activity class schema
-
setAcSchemaId
Sets the associated activity class schema ID- Parameters:
acSchemaId_
- the ID of the activity class schema
-
getCanvasIcon
Returns the ID of the canvas icon- Returns:
- the id of the canvas icon
-
setCanvasIcon
Sets the ID of the canvas icon- Parameters:
canvasIcon_
- the ID of the canvas icon
-
getPaletteIcon
Returns the ID of the palette icon- Returns:
- the ID of the palette icon
-
setPaletteIcon
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
-
toXML
Converts this palette item to xml and returns it as a string. -
toXML
Converts the palette item to XML and stores it in a StringBuffer -
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
Sets the local ID of the activity class schema associated with this palette item- Parameters:
acSchemaLocalId_
- The acSchemaLocalId to set.
-