com.appiancorp.suiteapi.process

Class PaletteItem

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.process.PaletteItem

All Implemented Interfaces:

LocalId, XMLable, java.io.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:

Serialized Form

Field Summary

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
PaletteItem()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAcSchemaId() Returns the ID of the activity class schema associated with this palette item
java.lang.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)
java.lang.Long	getAppianType() Gets the related Appian type ID.
java.lang.Long	getCanvasIcon() Returns the ID of the canvas icon
java.lang.Long	getEventProducer() Gets the type code for the event producer
boolean	getIsCustomPlugin() Returns whether this palette item is a custom plugin Returns: whether this palette item is a custom plugin
java.lang.Long	getPaletteIcon() Returns the ID of the palette icon
java.lang.Long	getPostTrigger() Gets the type code for the post-trigger
java.lang.Long	getPreTrigger() Gets the type code for the pre-trigger
java.lang.String	getStaticResourcePrefix() Returns the relative URL prefix for all static web resources.
boolean	isEnabled()
void	setAcSchemaId(java.lang.Long acSchemaId_) Sets the associated activity class schema ID
void	setAcSchemaLocalId(java.lang.String acSchemaLocalId_) Sets the local ID of the activity class schema associated with this palette item
void	setAppianType(java.lang.Long appianType_) Sets the related Appian type ID.
void	setCanvasIcon(java.lang.Long canvasIcon_) Sets the ID of the canvas icon
void	setEnabled(boolean enabled)
void	setEventProducer(java.lang.Long eventProducer_) Sets the type code for the event producer
void	setIsCustomPlugin(boolean isCustomPlugin) Sets whether this palette item is a custom plugin
void	setPaletteIcon(java.lang.Long paletteIcon_) Sets the ID of the palette icon
void	setPostTrigger(java.lang.Long postTrigger_) Sets the type code for the post-trigger
void	setPreTrigger(java.lang.Long preTrigger_) Sets the type code for the pre-trigger
java.lang.String	toXML() Converts this palette item to xml and returns it as a string.
void	toXML(java.lang.StringBuilder buffer_) Converts the palette item to XML and stores it in a StringBuffer

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, getUuid, hashCode, setId, setName, setUuid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Constructor Detail

PaletteItem

public PaletteItem()

Method Detail

getStaticResourcePrefix

public java.lang.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 java.lang.Long getEventProducer()

Gets the type code for the event producer

Returns:

the type code for the event producer

setEventProducer

public void setEventProducer(java.lang.Long eventProducer_)

Sets the type code for the event producer

Parameters:

eventProducer_ - the type code for the event producer

getPreTrigger

public java.lang.Long getPreTrigger()

Gets the type code for the pre-trigger

Returns:

the type code for the pre-trigger

setPreTrigger

public void setPreTrigger(java.lang.Long preTrigger_)

Sets the type code for the pre-trigger

Parameters:

preTrigger_ - the type code for the pre-trigger

getPostTrigger

public java.lang.Long getPostTrigger()

Gets the type code for the post-trigger

Returns:

the type code for the post-trigger

setPostTrigger

public void setPostTrigger(java.lang.Long postTrigger_)

Sets the type code for the post-trigger

Parameters:

postTrigger_ - the type code for the post-trigger

getAppianType

public java.lang.Long getAppianType()

Gets the related Appian type ID.

Returns:

the related Appian type ID.

setAppianType

public void setAppianType(java.lang.Long appianType_)

Sets the related Appian type ID.

Parameters:

appianType_ - the related Appian type ID.

getAcSchemaId

public java.lang.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(java.lang.Long acSchemaId_)

Sets the associated activity class schema ID

Parameters:

acSchemaId_ - the ID of the activity class schema

getCanvasIcon

public java.lang.Long getCanvasIcon()

Returns the ID of the canvas icon

Returns:

the id of the canvas icon

setCanvasIcon

public void setCanvasIcon(java.lang.Long canvasIcon_)

Sets the ID of the canvas icon

Parameters:

canvasIcon_ - the ID of the canvas icon

getPaletteIcon

public java.lang.Long getPaletteIcon()

Returns the ID of the palette icon

Returns:

the ID of the palette icon

setPaletteIcon

public void setPaletteIcon(java.lang.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

toXML

public java.lang.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(java.lang.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 java.lang.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(java.lang.String acSchemaLocalId_)

Sets the local ID of the activity class schema associated with this palette item

Parameters:

acSchemaLocalId_ - The acSchemaLocalId to set.