com.appiancorp.suiteapi.process

Class Note

java.lang.Object

com.appiancorp.suiteapi.process.NoteMetadata

com.appiancorp.suiteapi.process.Note

All Implemented Interfaces:

XMLable, AppianTypeHolder, java.io.Serializable

public class Note
extends NoteMetadata
implements XMLable, AppianTypeHolder

This class represents the Note that can be attached to ProcessModel, Process, ProcessNode or Task. This bean is used for communication between the Java and User Interface layers.

See Also:

Note, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	RESULT_CODE_CANCELLED_PROCESS Result Code constant representing Cancelled Process
static java.lang.Integer	RESULT_CODE_CANCELLED_TASK Result Code constant representing Cancelled Task
static java.lang.Integer	RESULT_CODE_INVALID Result Code constant representing Invalid Attachment
static java.lang.Integer	RESULT_CODE_NO_PRIV Result Code constant representing Insufficient Privileges
static java.lang.Integer	RESULT_CODE_SUCCESS Result Code constant representing success
static java.lang.Integer	RESULT_CODE_TOO_MANY_NOTES Result Code constant representing configured Notes Limit Reached.
static java.lang.Integer	RESULT_CODE_UNATTENDED_TASK Result Code constant representing Unattended Task

Fields inherited from class com.appiancorp.suiteapi.process.NoteMetadata

NOTE_TYPE_DELETED, NOTE_TYPE_EXCEPTION, NOTE_TYPE_NORMAL, NOTE_TYPE_REASSIGN_TASK, NOTE_TYPE_REJECT_TASK, SORT_BY_AUTHOR, SORT_BY_CONTENT, SORT_BY_CREATE_DATE, SORT_BY_ID, SORT_BY_LOCATION, SORT_BY_TYPE, SORT_BY_UPDATE_DATE

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

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
void	fillInAppianTypes(AppianTypeCache cache_) This method is called to populate the AppianTypeCache for LocalObject that are referenced in Note
java.lang.String	getContent() Returns the String contents of the Note.
void	setContent(java.lang.String content_) Sets the String contents of Note.
java.lang.String	toString()
java.lang.String	toXML() Returns an XML representation of the Note
void	toXML(java.lang.StringBuilder buffer_) Appends the XML representation of the Note to the given buffer.

Methods inherited from class com.appiancorp.suiteapi.process.NoteMetadata

getAttachedTo, getAuthor, getCreateTimestamp, getId, getLocation, getPermissions, getType, getTypeAsString, getUpdateTimestamp, setAttachedTo, setAuthor, setCreateTimestamp, setId, setLocation, setPermissions, setType, setUpdateTimestamp

Methods inherited from class java.lang.Object

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

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

toXML

Field Detail

RESULT_CODE_SUCCESS

public static final java.lang.Integer RESULT_CODE_SUCCESS

Result Code constant representing success

RESULT_CODE_NO_PRIV

public static final java.lang.Integer RESULT_CODE_NO_PRIV

Result Code constant representing Insufficient Privileges

RESULT_CODE_INVALID

public static final java.lang.Integer RESULT_CODE_INVALID

Result Code constant representing Invalid Attachment

RESULT_CODE_TOO_MANY_NOTES

public static final java.lang.Integer RESULT_CODE_TOO_MANY_NOTES

Result Code constant representing configured Notes Limit Reached.

RESULT_CODE_CANCELLED_TASK

public static final java.lang.Integer RESULT_CODE_CANCELLED_TASK

Result Code constant representing Cancelled Task

RESULT_CODE_CANCELLED_PROCESS

public static final java.lang.Integer RESULT_CODE_CANCELLED_PROCESS

Result Code constant representing Cancelled Process

RESULT_CODE_UNATTENDED_TASK

public static final java.lang.Integer RESULT_CODE_UNATTENDED_TASK

Result Code constant representing Unattended Task

Constructor Detail

Note

public Note()

Method Detail

getContent

public java.lang.String getContent()

Returns the String contents of the Note.

Returns:

String contents of Note

setContent

public void setContent(java.lang.String content_)

Sets the String contents of Note.

Parameters:

content_ - note contents to set.

toXML

public java.lang.String toXML()

Returns an XML representation of the Note

Specified by:

toXML in interface XMLable

Returns:

String value of XML representation of Note

toXML

public void toXML(java.lang.StringBuilder buffer_)

Appends the XML representation of the Note to the given buffer.

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - StringBuffer to add the XML representation of Note

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache cache_)

This method is called to populate the AppianTypeCache for LocalObject that are referenced in Note

Specified by:

fillInAppianTypes in interface AppianTypeHolder

Parameters:

cache_ - cache of Appian-typed objects.

toString

public java.lang.String toString()

Overrides:

toString in class NoteMetadata