ALBPM Process API (PAPI)

fuego.papi
Interface Note

All Superinterfaces:
NoteInterface

public interface Note
extends NoteInterface

Represents a Note associated with an instance.

To get the Notes associated with an instance, use ProcessServiceNESession.getInstanceNotes(String). To get an individual Note by its Id, use ProcessServiceNESession.getNote(String). To add a Note to an instance, use ProcessServiceSession.instancesAddNote(InstanceStamp[], String).


Method Summary
 Object getContent()
          Gets the content of this note (usually as a String object).
 Time getCreationTime()
          Gets the creation time of this Note.
 String getId()
          Gets the Id of this note.
 int getIn()
          Get the note identification number.
 String getInstanceId()
          Gets the Id of the instance where this note was attached to.
 int getInstanceIn()
          Gets the Id of the instance number where this note was attached to.
 String getName()
          Gets the name of the activity where this note was created.
 String getParticipant()
          Gets the uid of the Participant who created this note.
 int getProcessIn()
          Gets the idenfication number of the associated process.
 

Method Detail

getContent

public Object getContent()
Gets the content of this note (usually as a String object).

Specified by:
getContent in interface NoteInterface
Returns:
Note content.

getCreationTime

public Time getCreationTime()
Gets the creation time of this Note.

Specified by:
getCreationTime in interface NoteInterface
Returns:
Note creation time.

getId

public String getId()
Gets the Id of this note.

Returns:
Note Id

getIn

public int getIn()
Get the note identification number.

Returns:
note identification number.

getInstanceId

public String getInstanceId()
Gets the Id of the instance where this note was attached to.

Returns:
Id of the instance where this note was attached to

getInstanceIn

public int getInstanceIn()
Gets the Id of the instance number where this note was attached to.

Returns:
Id of the instance number where this note was attached to

getName

public String getName()
Gets the name of the activity where this note was created.

Specified by:
getName in interface NoteInterface
Returns:
name of the activity where this note was created.

getParticipant

public String getParticipant()
Gets the uid of the Participant who created this note.

Specified by:
getParticipant in interface NoteInterface
Returns:
Uid of the Participant who created this note.

getProcessIn

public int getProcessIn()
Gets the idenfication number of the associated process.

Returns:
idenfication number of the associated process.

ALBPM Process API (PAPI)

© Copyright 1996/2005 Fuego Inc. All Rights Reserved