com.appiancorp.suiteapi.process

Class NoteMetadata

java.lang.Object

com.appiancorp.suiteapi.process.NoteMetadata

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Note

public class NoteMetadata
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	NOTE_TYPE_DELETED Constant representing the DELETED NoteMetadata type
static java.lang.Integer	NOTE_TYPE_EXCEPTION Constant representing the Note added on exception type
static java.lang.Integer	NOTE_TYPE_NORMAL Constant representing the NORMAL NoteMetadata type
static java.lang.Integer	NOTE_TYPE_REASSIGN_TASK Constant representing the REASSIGN_TASK NoteMetadata type
static java.lang.Integer	NOTE_TYPE_REJECT_TASK Constant representing the REJECT_TASK NoteMetadata type
static java.lang.Integer	SORT_BY_AUTHOR Constant representing sorting by NoteMetadata author field
static java.lang.Integer	SORT_BY_CONTENT Constant representing sorting by NoteMetadata contents field
static java.lang.Integer	SORT_BY_CREATE_DATE Constant representing sorting by NoteMetadata createTimestamp field
static java.lang.Integer	SORT_BY_ID Constant representing sorting by NoteMetadata ID field
static java.lang.Integer	SORT_BY_LOCATION Constant representing sorting by NoteMetadata location(Where note is saved) field
static java.lang.Integer	SORT_BY_TYPE Constant representing sorting by NoteMetadata Type field
static java.lang.Integer	SORT_BY_UPDATE_DATE Constant representing sorting by NoteMetadata updateTimestamp field

Constructor Summary

Constructors

Constructor and Description
NoteMetadata()

Method Summary

Modifier and Type	Method and Description
LocalObject	getAttachedTo()
java.lang.String	getAuthor()
java.sql.Timestamp	getCreateTimestamp()
java.lang.Long	getId()
java.lang.String	getLocation()
NotePermissions	getPermissions()
java.lang.Integer	getType()
protected java.lang.String	getTypeAsString()
java.sql.Timestamp	getUpdateTimestamp()
void	setAttachedTo(LocalObject attachedTo_) Sets the LocalObject that the Note is attached to.
void	setAuthor(java.lang.String author_) Sets the author of the Note
void	setCreateTimestamp(java.sql.Timestamp createTimestamp_) Sets the creation timestamp of Note
void	setId(java.lang.Long id_) Sets the Id of Note Object
void	setLocation(java.lang.String location_) Sets the location where note contents are stored.
void	setPermissions(NotePermissions permissions_) Sets the Note permissions
void	setType(java.lang.Integer type_) Sets the type of Note
void	setUpdateTimestamp(java.sql.Timestamp updateTimestamp_) Sets the timestamp when Note was updated.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Constant representing sorting by NoteMetadata ID field

SORT_BY_TYPE

public static final java.lang.Integer SORT_BY_TYPE

Constant representing sorting by NoteMetadata Type field

SORT_BY_CREATE_DATE

public static final java.lang.Integer SORT_BY_CREATE_DATE

Constant representing sorting by NoteMetadata createTimestamp field

SORT_BY_UPDATE_DATE

public static final java.lang.Integer SORT_BY_UPDATE_DATE

Constant representing sorting by NoteMetadata updateTimestamp field

SORT_BY_AUTHOR

public static final java.lang.Integer SORT_BY_AUTHOR

Constant representing sorting by NoteMetadata author field

SORT_BY_LOCATION

public static final java.lang.Integer SORT_BY_LOCATION

Constant representing sorting by NoteMetadata location(Where note is saved) field

SORT_BY_CONTENT

public static final java.lang.Integer SORT_BY_CONTENT

Constant representing sorting by NoteMetadata contents field

NOTE_TYPE_NORMAL

public static final java.lang.Integer NOTE_TYPE_NORMAL

Constant representing the NORMAL NoteMetadata type

NOTE_TYPE_REASSIGN_TASK

public static final java.lang.Integer NOTE_TYPE_REASSIGN_TASK

Constant representing the REASSIGN_TASK NoteMetadata type

NOTE_TYPE_REJECT_TASK

public static final java.lang.Integer NOTE_TYPE_REJECT_TASK

Constant representing the REJECT_TASK NoteMetadata type

NOTE_TYPE_DELETED

public static final java.lang.Integer NOTE_TYPE_DELETED

Constant representing the DELETED NoteMetadata type

NOTE_TYPE_EXCEPTION

public static final java.lang.Integer NOTE_TYPE_EXCEPTION

Constant representing the Note added on exception type

Constructor Detail

NoteMetadata

public NoteMetadata()

Method Detail

getAttachedTo

public LocalObject getAttachedTo()

Returns:

Returns the LocalObject that the note is attached to. It can either be ProcessModel, Process, Node or Task

setAttachedTo

public void setAttachedTo(LocalObject attachedTo_)

Sets the LocalObject that the Note is attached to.

Parameters:

attachedTo_ - The attachedTo to set.

getAuthor

public java.lang.String getAuthor()

Returns:

Returns the author, who added this note.

setAuthor

public void setAuthor(java.lang.String author_)

Sets the author of the Note

Parameters:

author_ - author to set.

getCreateTimestamp

public java.sql.Timestamp getCreateTimestamp()

Returns:

Returns the timestamp when the Note was created.

setCreateTimestamp

public void setCreateTimestamp(java.sql.Timestamp createTimestamp_)

Sets the creation timestamp of Note

Parameters:

createTimestamp_ - Note creation timestamp.

getId

public java.lang.Long getId()

Returns:

Returns the Id of Note Object.

setId

public void setId(java.lang.Long id_)

Sets the Id of Note Object

Parameters:

id_ - ID to set.

getLocation

public java.lang.String getLocation()

Returns:

Returns the location where the Note contents are stored.

setLocation

public void setLocation(java.lang.String location_)

Sets the location where note contents are stored.

Parameters:

location_ - Note location to set.

getPermissions

public NotePermissions getPermissions()

Returns:

Returns the Note permissions

setPermissions

public void setPermissions(NotePermissions permissions_)

Sets the Note permissions

Parameters:

permissions_ - permissions to set.

getType

public java.lang.Integer getType()

Returns:

Returns the type of Note which can be any one of the NOTE_TYPE_XXX constants

setType

public void setType(java.lang.Integer type_)

Sets the type of Note

Parameters:

type_ - type to set.

getUpdateTimestamp

public java.sql.Timestamp getUpdateTimestamp()

Returns:

Returns the timestamp when Note was updated

setUpdateTimestamp

public void setUpdateTimestamp(java.sql.Timestamp updateTimestamp_)

Sets the timestamp when Note was updated.

Parameters:

updateTimestamp_ - Note update timestamp to set.

getTypeAsString

protected java.lang.String getTypeAsString()

Returns:

Returns the Note type As String representation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object