com.adobe.livecycle.rca
Interface StageManagementService

public interface StageManagementService

Method Summary

StageTemplateTO	createStageTemplate(StageTemplateTO stageTemplate, boolean overwrite) Creates a new Stage Template in the system.
StageTemplateTO	deleteStageTemplate(String templateName) Deletes the Stage Template from the system.
List	getReviewTemplatesReferring(String templateName) Get all ReviewTemplateTOs referring a StageTemplateTO.
StageTemplateTO	getStageTemplate(String templateName) Get a StageTemplateTO given its ID.
List	searchStage(StageTemplateSearchFilter stageTemplateSearchFilter) Search for StageTemplateTO based on StageTemplateSearchFilter.

Method Detail

createStageTemplate

StageTemplateTO createStageTemplate(StageTemplateTO stageTemplate,
                                    boolean overwrite)
                                    throws ICRException

Creates a new Stage Template in the system.

Parameters:

stageTemplate - StageTemplateTO to create

Throws:

ICRException - Wrapping any exception generated by the underlying Persistence store.

deleteStageTemplate

StageTemplateTO deleteStageTemplate(String templateName)
                                    throws ICRException

Deletes the Stage Template from the system. If this Stage is referred by one (or more) ReviewTemplateTO, deletion will fail with appropriate exception.

Parameters:

templateName - The Stage Template name (unique in the system)

Returns:

The deleted StageTemplateTO

Throws:

ICRException - Wrapping any exception generated by the underlying Persistence store.

getStageTemplate

StageTemplateTO getStageTemplate(String templateName)
                                 throws ICRException

Get a StageTemplateTO given its ID.

Parameters:

templateName - The Stage Template name (unique in the system)

Returns:

StageTemplateTO or null if the stage doesn't exist

Throws:

ICRException - Wrapping any exception generated by the underlying Persistence store.

searchStage

List searchStage(StageTemplateSearchFilter stageTemplateSearchFilter)
                 throws ICRException

Search for StageTemplateTO based on StageTemplateSearchFilter.

Parameters:

stageTemplateSearchFilter - StageTemplateSearchFilter which defines the search criteria

Returns:

List of StageTemplateTO found in the system matching the criteria

Throws:

ICRException - Wrapping any exception generated by the underlying Persistence store.

getReviewTemplatesReferring

List getReviewTemplatesReferring(String templateName)
                                 throws ICRException

Get all ReviewTemplateTOs referring a StageTemplateTO.

Parameters:

templateName - The Stage Template name (unique in the system)

Returns:

List of ReviewTemplateTO referring the Stage Template with ID stageTemplateID

Throws:

ICRException - Wrapping any exception generated by the underlying Persistence store.