com.stellent.cis.client.api.sis.process
Interface ISISProcessAPI

All Superinterfaces:

ICommandAPI

public interface ISISProcessAPI
extends ICommandAPI

The command API implementation of the process commands. This implementation can be accessed directly via the ICommandFacade class, using the API name process, with the following syntax:

 ISISProcessAPI commandAPI =
       (ISISProcessAPI)m_commandFacade.getCommandAPI ("process", m_commandFacade.getCommandTypeForName ("fixed"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISISCreatePackage	_createPackage()
ISISPackageAttachment	_createPackageAttachment()
ISISPackageField	_createPackageField()
ISISPlaceInFlowRequest	_createPlaceInFlowRequest()
java.util.List	addJournalEntry(ISISContext SISContext, ISISPackage fixedPackage, java.lang.String journalEntry) Allows the user to add a journal entry to a package.
java.util.List	addJournalEntry(ISISContext SISContext, java.util.List fixedPackages, java.lang.String journalEntry) Allows the user to add a journal entry to a package.
java.util.List	completePackage(ISISContext SISContext, ISISPackage fixedPackage, java.lang.String decisionText) Allows the user to complete a package when supplied with the Package object.
ISISCreatePackageResult	createPackage(ISISContext SISContext, ISISCreatePackage createPackage) Allows the user to create a package.
java.util.List	createPackages(ISISContext SISContext, java.util.List fixedPackages) Allows the user to create one or more packages.
java.util.List	getOptionList(ISISContext SISContext, ISISPackageTemplate template) Allows the user to get a list of Field Option Lists based on a template name.
java.util.List	getOptionList(ISISContext SISContext, java.lang.String templateName) Allows the user to get a list of Field Option Lists based on a template name.
ISISPackage	getPackageByID(ISISContext SISContext, int packageID) Allows the user to get a single package by ID.
java.util.List	getPackageDecisions(ISISContext SISContext, int packageID) Allows the user to get the Complete Package decisions for a particular Package as specified by the package object.
java.util.List	getPackageDecisions(ISISContext SISContext, ISISPackage fixedPackage) Allows the user to get the Complete Package decisions for a particular Package as specified by the package object.
java.util.List	getPackageFields(ISISContext SISContext, int packageID) Allows the user to get the field values of a package based on the package record id.
java.util.List	getPackageFields(ISISContext SISContext, ISISPackage fixedPackage) Allows the user to get the field values of a package based on the package record id.
java.util.List	getPackagesByID(ISISContext SISContext, int packageID) Allows the user to get a packages by ID.
java.util.List	getPackagesByProfile(ISISContext SISContext, ISISProcessProfile profile) Allows the user to run a package search based on a named profile.
java.util.List	getPackagesByPrompt(ISISContext SISContext, ISISPromptedProfile promptedProfile) Allows the user to get a list of packages based on a named profile containing prompts.
java.util.List	getPackageTemplates(ISISContext SISContext) Allows the user to get the available package templates.
java.util.List	getProcessProfiles(ISISContext SISContext) Returns available fixed process profiles.
java.util.List	getProfilePrompts(ISISContext SISContext, ISISProcessProfile processProfile) Allows the User to get a list of prompts based on a Profile ID.
java.util.List	getProfilePrompts(ISISContext SISContext, java.util.List processProfiles) Allows the User to get a list of prompts based on a Profile ID.
java.util.List	getTemplateStartEvents(ISISContext SISContext, ISISPackageTemplate template) Allows the user to get the start events for a Package Template when providing a Template Name.
java.util.List	getTemplateStartEvents(ISISContext SISContext, java.lang.String templateName) Allows the user to get the start events for a Package Template when providing a Template Name.
java.util.List	lockPackage(ISISContext SISContext, int packageID) Allows the user to Lock one Package by the Package object.
java.util.List	lockPackage(ISISContext SISContext, ISISPackage fixedPackage) Allows the user to Lock one Package by the Package object.
java.util.List	lockPackageInQueue(ISISContext SISContext, int packageID, java.lang.String queueName) Allows the user to lock a single package only if they are in the specified queue.
java.util.List	lockPackageInQueue(ISISContext SISContext, ISISPackage fixedPackage, java.lang.String queueName) Allows the user to lock a single package only if they are in the specified queue.
java.util.List	placePackageInFlow(ISISContext SISContext, java.util.List placeInFlowReqs) Allows the user to place one or more packages in the process.
java.util.List	setPackageFields(ISISContext SISContext, int packageID, java.util.List packageFields) Allows the user to set the field values of one package by providing both the Package id and the PackageFieldsArray object.
java.util.List	setPackageFields(ISISContext SISContext, ISISPackage fixedPackage, java.util.List packageFields) Allows the user to set the field values of one package by providing both the Package id and the PackageFieldsArray object.
java.util.List	unlockPackage(ISISContext SISContext, int packageID) Allows the user to unlock one Package by the Package object.
java.util.List	unlockPackage(ISISContext SISContext, ISISPackage fixedPackage) Allows the user to unlock one Package by the Package object.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

addJournalEntry

java.util.List addJournalEntry(ISISContext SISContext,
                               ISISPackage fixedPackage,
                               java.lang.String journalEntry)
                               throws CommandException

Allows the user to add a journal entry to a package. Returns a list of package result objects. ISISPackageResult

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to add journal entry to.

journalEntry - The text of the journal entry to add to the package.

Throws:

CommandException

addJournalEntry

java.util.List addJournalEntry(ISISContext SISContext,
                               java.util.List fixedPackages,
                               java.lang.String journalEntry)
                               throws CommandException

Allows the user to add a journal entry to a package. Returns a list of package result objects. ISISPackageResult

Parameters:

SISContext - the context object representing the current user

fixedPackages - A list of packages to add journal entry to.

journalEntry - The text of the journal entry to add to the package.

Throws:

CommandException

completePackage

java.util.List completePackage(ISISContext SISContext,
                               ISISPackage fixedPackage,
                               java.lang.String decisionText)
                               throws CommandException

Allows the user to complete a package when supplied with the Package object. Only one package can be completed at a time through this call. ISISPackageResult

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to complete.

decisionText - The associated text for this completion.

Throws:

CommandException

createPackage

ISISCreatePackageResult createPackage(ISISContext SISContext,
                                      ISISCreatePackage createPackage)
                                      throws CommandException

Allows the user to create a package.

Parameters:

SISContext - the context object representing the current user

createPackage - The package to create

Throws:

CommandException

createPackages

java.util.List createPackages(ISISContext SISContext,
                              java.util.List fixedPackages)
                              throws CommandException

Allows the user to create one or more packages. Returns list of result objects. ISISCreatePackageResult

Parameters:

SISContext - the context object representing the current user

fixedPackages - A list of packages to create

Throws:

CommandException

lockPackage

java.util.List lockPackage(ISISContext SISContext,
                           int packageID)
                           throws CommandException

Allows the user to Lock one Package by the Package object. Returns a list of ISISPackageResult objects.

Parameters:

SISContext - the context object representing the current user

packageID - The package id of the package to lock.

Throws:

CommandException

lockPackage

java.util.List lockPackage(ISISContext SISContext,
                           ISISPackage fixedPackage)
                           throws CommandException

Allows the user to Lock one Package by the Package object. Returns a list of ISISPackageResult objects.

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package object to lock.

Throws:

CommandException

lockPackageInQueue

java.util.List lockPackageInQueue(ISISContext SISContext,
                                  int packageID,
                                  java.lang.String queueName)
                                  throws CommandException

Allows the user to lock a single package only if they are in the specified queue. Returns a list of ISISPackageResult objects.

Parameters:

SISContext - the context object representing the current user

packageID - The package id of the package to lock.

queueName - The queue that the package must be in.

Throws:

CommandException

lockPackageInQueue

java.util.List lockPackageInQueue(ISISContext SISContext,
                                  ISISPackage fixedPackage,
                                  java.lang.String queueName)
                                  throws CommandException

Allows the user to lock a single package only if they are in the specified queue. Returns a list of ISISPackageResult objects.

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package object to lock.

queueName - The queue that the package must be in.

Throws:

CommandException

getOptionList

java.util.List getOptionList(ISISContext SISContext,
                             java.lang.String templateName)
                             throws CommandException

Allows the user to get a list of Field Option Lists based on a template name. Returns a list of ISISPackageFieldOptionList objects.

Parameters:

SISContext - the context object representing the current user

templateName - The name of template to retrieve option lists from.

Throws:

CommandException

getOptionList

java.util.List getOptionList(ISISContext SISContext,
                             ISISPackageTemplate template)
                             throws CommandException

Allows the user to get a list of Field Option Lists based on a template name. Returns a list of ISISPackageFieldOptionList objects.

Parameters:

SISContext - the context object representing the current user

template - The template to retrieve option lists from.

Throws:

CommandException

getPackageByID

ISISPackage getPackageByID(ISISContext SISContext,
                           int packageID)
                           throws CommandException

Allows the user to get a single package by ID.

Parameters:

SISContext - the context object representing the current user

packageID - The id of the package to retrieve.

Throws:

CommandException

getPackageDecisions

java.util.List getPackageDecisions(ISISContext SISContext,
                                   int packageID)
                                   throws CommandException

Allows the user to get the Complete Package decisions for a particular Package as specified by the package object. Returns a list of package decision objects. ISISPackageDecision

Parameters:

SISContext - the context object representing the current user

packageID - The package id to get decisions for.

Throws:

CommandException

getPackageDecisions

java.util.List getPackageDecisions(ISISContext SISContext,
                                   ISISPackage fixedPackage)
                                   throws CommandException

Allows the user to get the Complete Package decisions for a particular Package as specified by the package object. Returns a list of package decision objects. ISISPackageDecision

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to get decisions for.

Throws:

CommandException

getPackageFields

java.util.List getPackageFields(ISISContext SISContext,
                                int packageID)
                                throws CommandException

Allows the user to get the field values of a package based on the package record id. ISISPackageField

Parameters:

SISContext - the context object representing the current user

packageID - The ID of a Package.

Throws:

CommandException

getPackageFields

java.util.List getPackageFields(ISISContext SISContext,
                                ISISPackage fixedPackage)
                                throws CommandException

Allows the user to get the field values of a package based on the package record id. ISISPackageField

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to complete.

Throws:

CommandException

getPackagesByID

java.util.List getPackagesByID(ISISContext SISContext,
                               int packageID)
                               throws CommandException

Allows the user to get a packages by ID. ISISPackage

Parameters:

SISContext - the context object representing the current user

packageID - The id of the package to retrieve.

Throws:

CommandException

getPackagesByProfile

java.util.List getPackagesByProfile(ISISContext SISContext,
                                    ISISProcessProfile profile)
                                    throws CommandException

Allows the user to run a package search based on a named profile. ISISPackage

Parameters:

SISContext - the context object representing the current user

profile - The process profile to perform search with.

Throws:

CommandException

getPackagesByPrompt

java.util.List getPackagesByPrompt(ISISContext SISContext,
                                   ISISPromptedProfile promptedProfile)
                                   throws CommandException

Allows the user to get a list of packages based on a named profile containing prompts. ISISPackage

Parameters:

SISContext - the context object representing the current user

promptedProfile - The prompted profile object.

Throws:

CommandException

getPackageTemplates

java.util.List getPackageTemplates(ISISContext SISContext)
                                   throws CommandException

Allows the user to get the available package templates. This call also indicates which of those templates can be used for the creation of packages. ISISPackageTemplate

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

placePackageInFlow

java.util.List placePackageInFlow(ISISContext SISContext,
                                  java.util.List placeInFlowReqs)
                                  throws CommandException

Allows the user to place one or more packages in the process. Returns a list of result objects ISISPlaceInFlow

Parameters:

SISContext - the context object representing the current user

placeInFlowReqs - A list of place in flow requests. ISISPlaceInFlowRequest

Throws:

CommandException

getProcessProfiles

java.util.List getProcessProfiles(ISISContext SISContext)
                                  throws CommandException

Returns available fixed process profiles. ISISProcessProfile

Parameters:

SISContext - the context object representing the current user

Throws:

CommandException

getProfilePrompts

java.util.List getProfilePrompts(ISISContext SISContext,
                                 ISISProcessProfile processProfile)
                                 throws CommandException

Allows the User to get a list of prompts based on a Profile ID. ISISProfilePrompt

Parameters:

SISContext - the context object representing the current user

processProfile - The process profile to get prompts for.

Throws:

CommandException

getProfilePrompts

java.util.List getProfilePrompts(ISISContext SISContext,
                                 java.util.List processProfiles)
                                 throws CommandException

Allows the User to get a list of prompts based on a Profile ID. ISISProfilePrompt

Parameters:

SISContext - the context object representing the current user

processProfiles - A list of profiles ISISProcessProfile

Throws:

CommandException

setPackageFields

java.util.List setPackageFields(ISISContext SISContext,
                                int packageID,
                                java.util.List packageFields)
                                throws CommandException

Allows the user to set the field values of one package by providing both the Package id and the PackageFieldsArray object. Returns a list of package fields ISISPackageField

Parameters:

SISContext - the context object representing the current user

packageID - The package ID to set fields on.

packageFields - The fields to set.

Throws:

CommandException

setPackageFields

java.util.List setPackageFields(ISISContext SISContext,
                                ISISPackage fixedPackage,
                                java.util.List packageFields)
                                throws CommandException

Allows the user to set the field values of one package by providing both the Package id and the PackageFieldsArray object. Returns a list of package fields ISISPackageField

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to set fields on.

packageFields - The fields to set.

Throws:

CommandException

getTemplateStartEvents

java.util.List getTemplateStartEvents(ISISContext SISContext,
                                      java.lang.String templateName)
                                      throws CommandException

Allows the user to get the start events for a Package Template when providing a Template Name. Returns a list of ISISTemplateStartEvent objects.

Parameters:

SISContext - the context object representing the current user

templateName - The template name to retrieve events for.

Throws:

CommandException

getTemplateStartEvents

java.util.List getTemplateStartEvents(ISISContext SISContext,
                                      ISISPackageTemplate template)
                                      throws CommandException

Allows the user to get the start events for a Package Template when providing a Template Name. Returns a list of ISISTemplateStartEvent objects.

Parameters:

SISContext - the context object representing the current user

template - The template object to retrieve events for.

Throws:

CommandException

unlockPackage

java.util.List unlockPackage(ISISContext SISContext,
                             int packageID)
                             throws CommandException

Allows the user to unlock one Package by the Package object. Returns a list of package results ISISPackageResult

Parameters:

SISContext - the context object representing the current user

packageID - The package id of the package to unlock.

Throws:

CommandException

unlockPackage

java.util.List unlockPackage(ISISContext SISContext,
                             ISISPackage fixedPackage)
                             throws CommandException

Allows the user to unlock one Package by the Package object. Returns a list of package results ISISPackageResult

Parameters:

SISContext - the context object representing the current user

fixedPackage - The package to unlock.

Throws:

CommandException

_createPackage

ISISCreatePackage _createPackage()

_createPackageAttachment

ISISPackageAttachment _createPackageAttachment()

_createPlaceInFlowRequest

ISISPlaceInFlowRequest _createPlaceInFlowRequest()

_createPackageField

ISISPackageField _createPackageField()