atg.svc.workflow.process.action
Class ServiceWorkflowAction

java.lang.Object
  atg.process.action.ActionImpl
      atg.epub.workflow.process.action.PublishingAction
          atg.svc.workflow.process.action.ServiceWorkflowAction

All Implemented Interfaces:

atg.process.action.Action, atg.process.action.ActionConstants

Direct Known Subclasses:

ChangeSolutionStatus, ClaimSolutionTask, MarkSolutionStatusAsDeployed, MarkSolutionStatusAsUndeployed, SolutionNextStepAction

public abstract class ServiceWorkflowAction
extends atg.epub.workflow.process.action.PublishingAction

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.epub.workflow.process.action.PublishingAction

sTargetParameterName

Fields inherited from interface atg.process.action.ActionConstants

ERROR_RESPONSE_CONTINUE, ERROR_RESPONSE_DEFAULT, ERROR_RESPONSE_DELETE, ERROR_RESPONSE_INSTANCE_DELETED, ERROR_RESPONSE_RETRY, EXECUTION_POLICY_COLLECTIVE, EXECUTION_POLICY_INDIVIDUAL

Constructor Summary

ServiceWorkflowAction()

Method Summary

protected void	approveProject(atg.epub.project.Project pProject, atg.process.ProcessExecutionContext pContext) Approve the given project
protected void	approveProject(atg.epub.project.Project pProject, java.lang.String pTargetId, atg.process.ProcessExecutionContext pContext) Approve the given project for the specified target
protected void	approveProjectForAllTargets(atg.epub.project.Project pProject, atg.process.ProcessExecutionContext pContext) Approve the given project for all targets
protected void	checkInProject(atg.epub.project.Project pProject, atg.process.ProcessExecutionContext pContext) Checks in the given project
void	configure(java.lang.Object pConfiguration) Configures the action using the given configuration object.
protected void	deployProject(atg.epub.project.Project pProject, atg.process.ProcessExecutionContext pContext) Deploys the given project
protected void	deployProject(atg.epub.project.Project pProject, java.lang.String pTargetId, atg.process.ProcessExecutionContext pContext) Deploys the given project
protected void	deployProjectToAllTargets(atg.epub.project.Project pProject, atg.process.ProcessExecutionContext pContext, boolean pIgnoreNoTargets) Deploys the given project
atg.repository.RepositoryItem	getNonNullProcessData(atg.epub.project.Process pProcess) Gets the process data item tied to pProcess
ServiceWorkflowActionConfiguration	getServiceActionConfiguration() Gets the configuration for this action
int	getVersionForRepItem(atg.repository.RepositoryItem pRepItem) get the versioned URI for the repository item
void	setServiceActionConfiguration(ServiceWorkflowActionConfiguration pConfiguration) Sets the configuration for this action

Methods inherited from class atg.epub.workflow.process.action.PublishingAction

getActionConfiguration, getProcess, getProcessHome, getProject, getProjectHome, getResource, getResource, getTarget, getUser, setActionConfiguration

Methods inherited from class atg.process.action.ActionImpl

execute, execute, executeAction, getActionName, getParameterExpression, getParameterValue, initialize, storeOptionalParameter, storeRequiredMutableParameter, storeRequiredParameter, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ServiceWorkflowAction

public ServiceWorkflowAction()

Method Detail

getServiceActionConfiguration

public ServiceWorkflowActionConfiguration getServiceActionConfiguration()

Gets the configuration for this action

Returns:

the configuration for this action

setServiceActionConfiguration

public void setServiceActionConfiguration(ServiceWorkflowActionConfiguration pConfiguration)

Sets the configuration for this action

Parameters:

pConfiguration - the configuration for this action

configure

public void configure(java.lang.Object pConfiguration)
               throws atg.process.ProcessException

Configures the action using the given configuration object. The configuration object is typically a global Nucleus component which is configured with the information necessary for the action's operation.

Specified by:

configure in interface atg.process.action.Action

Overrides:

configure in class atg.epub.workflow.process.action.PublishingAction

Throws:

atg.process.ProcessException - if the action could not be configured - for example, because some of the required properties are missing from the configuration

getNonNullProcessData

public atg.repository.RepositoryItem getNonNullProcessData(atg.epub.project.Process pProcess)
                                                    throws atg.process.ProcessException

Gets the process data item tied to pProcess

Parameters:

pProcess - the process to get the process data item from

Returns:

the processData RepositoryItem

Throws:

atg.process.ProcessException - if there is no process data item, or an exception occurs

checkInProject

protected void checkInProject(atg.epub.project.Project pProject,
                              atg.process.ProcessExecutionContext pContext)
                       throws atg.process.ProcessException

Checks in the given project

Parameters:

pProject - the project to checkin

pContext - the execution context used to find the current user

Throws:

atg.process.ProcessException - if an error occurs checking in the project

approveProject

protected void approveProject(atg.epub.project.Project pProject,
                              atg.process.ProcessExecutionContext pContext)
                       throws atg.process.ProcessException

Approve the given project

Parameters:

pProject - the project to deploy

pContext - the execution context

Throws:

atg.process.ProcessException - if an error occurs approving the project

approveProject

protected void approveProject(atg.epub.project.Project pProject,
                              java.lang.String pTargetId,
                              atg.process.ProcessExecutionContext pContext)
                       throws atg.process.ProcessException

Approve the given project for the specified target

Parameters:

pProject - the project to deploy

pTargetId - the specific id of the target to the project should be deployed

pContext - the execution context

Throws:

atg.process.ProcessException - if an error occurs approving the project

approveProjectForAllTargets

protected void approveProjectForAllTargets(atg.epub.project.Project pProject,
                                           atg.process.ProcessExecutionContext pContext)
                                    throws atg.process.ProcessException

Approve the given project for all targets

Parameters:

pProject - the project to deploy

pContext - the execution context

Throws:

atg.process.ProcessException - if an error occurs approving the project

deployProject

protected void deployProject(atg.epub.project.Project pProject,
                             atg.process.ProcessExecutionContext pContext)
                      throws atg.process.ProcessException

Deploys the given project

Parameters:

pProject - the project to deploy

pContext - the execution context

Throws:

atg.process.ProcessException - if an error occurs deploying the project

deployProject

protected void deployProject(atg.epub.project.Project pProject,
                             java.lang.String pTargetId,
                             atg.process.ProcessExecutionContext pContext)
                      throws atg.process.ProcessException

Deploys the given project

Parameters:

pProject - the project to deploy

pTargetId - the specific id of the target to the project should be deployed

pContext - the execution context

Throws:

atg.process.ProcessException - if an error occurs deploying the project

deployProjectToAllTargets

protected void deployProjectToAllTargets(atg.epub.project.Project pProject,
                                         atg.process.ProcessExecutionContext pContext,
                                         boolean pIgnoreNoTargets)
                                  throws atg.process.ProcessException

Deploys the given project

Parameters:

pProject - the project to deploy

pContext - the execution context

pIgnoreNoTargets - Dont deploy if targets have not been defined

Throws:

atg.process.ProcessException - if an error occurs deploying the project

getVersionForRepItem

public int getVersionForRepItem(atg.repository.RepositoryItem pRepItem)
                         throws atg.repository.RepositoryException

get the versioned URI for the repository item

Parameters:

the - repository item who's URI we want to get

Returns:

the URI that gives the current version of the item

Throws:

atg.repository.RepositoryException