com.appiancorp.suiteapi.process

Interface NotesContentService

public interface NotesContentService

Convenience methods for creating note content. The service is used to retrieve notes from disk and update notes on disk. This service writes and retrieves notes from disk. This must be used in conjunction with the note methods in ProcessExecutionService. When creating a note this service must be called immediately after creating the NoteMetadata using ProcessExecutionService.createNoteMetadata(NoteMetadata)

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

See Also:

ProcessAdministrationService, ProcessAnalyticsService, ProcessDesignService, ProcessExecutionService

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	assembleNote$UPDATES
static boolean	assembleNotes$UPDATES
static boolean	createNoteContent$UPDATES
static boolean	updateNoteContent$UPDATES

Method Summary

Modifier and Type	Method and Description
Note	assembleNote(NoteMetadata nm_) Assembles a note from note metadata.
Note[]	assembleNotes(NoteMetadata[] nms_) Assembles an array of notes from note metadata.
void	createNoteContent(NoteMetadata nm_, java.lang.String content_) Creates note content at the location on disk specified by the note metadata The location refers to the full path of a file on disk.
void	createNoteContent(java.lang.String location_, java.lang.String content_) Creates new note content at the specified location on disk.
void	updateNoteContent(NoteMetadata nm_, java.lang.String content_) Updates the note content at the location on disk specified by the note metadata.
void	updateNoteContent(java.lang.String location_, java.lang.String content_) Updates the note content at the specified location on disk.

Field Detail

assembleNote$UPDATES

static final boolean assembleNote$UPDATES

See Also:

Constant Field Values

assembleNotes$UPDATES

static final boolean assembleNotes$UPDATES

See Also:

Constant Field Values

createNoteContent$UPDATES

static final boolean createNoteContent$UPDATES

See Also:

Constant Field Values

updateNoteContent$UPDATES

static final boolean updateNoteContent$UPDATES

See Also:

Constant Field Values

Method Detail

assembleNote

Note assembleNote(NoteMetadata nm_)
           throws AppianException

Assembles a note from note metadata. The note content will be fetched from disk from the location pointed to by NoteMetadata.getLocation(). The location refers to the full path of a file on disk. If no note content file exists at the location, the returned note will be populated with default content (text indicating that the note could not be found). NoteMetaData fields required for Note creation are: none.

Parameters:

nm_ - the metadata to assemble from which to assemble a note

Returns:

Note object populated from NoteMetadata

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

assembleNotes

Note[] assembleNotes(NoteMetadata[] nms_)
              throws AppianException

Assembles an array of notes from note metadata. This method is the bulk version of assembleNote(com.appiancorp.suiteapi.process.NoteMetadata)

Parameters:

nms_ - an array of metadata from which to assemble the notes

Returns:

an array of notes, populated from the note metadata

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

createNoteContent

void createNoteContent(java.lang.String location_,
                       java.lang.String content_)
                throws WriteException

Creates new note content at the specified location on disk. The location refers to the full path of a file on disk.

Parameters:

location_ - the location on disk where note content is to be stored.

content_ - the content to be stored at the given location

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

WriteException

createNoteContent

void createNoteContent(NoteMetadata nm_,
                       java.lang.String content_)
                throws WriteException

Creates note content at the location on disk specified by the note metadata The location refers to the full path of a file on disk.

Parameters:

nm_ - the note metadata specifying the location on disk where content is to be created (specifically, content will be created at the location specified by NoteMetadata.getLocation())

content_ - the content to be stored at the given location

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

WriteException

updateNoteContent

void updateNoteContent(java.lang.String location_,
                       java.lang.String content_)
                throws WriteException

Updates the note content at the specified location on disk. The location refers to the full path of a file on disk.

Parameters:

location_ - the location on disk of the note content

content_ - the new content to be stored at the given location

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

WriteException

updateNoteContent

void updateNoteContent(NoteMetadata nm_,
                       java.lang.String content_)
                throws WriteException

Updates the note content at the location on disk specified by the note metadata. The location refers to the full path of a file on disk.

Parameters:

nm_ - the note metadata specifying the location on disk where content is to be updated (specifically, content will be updated at the location specified by NoteMetadata.getLocation())

content_ - the content to be stored at the given location

Throws:

AppianException - if any error is encountered executing the method

ServiceException - if any system-level error occurs

WriteException