Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing failing Jenkins tests. Adding some Javadoc. #13517

Merged
merged 1 commit into from
Jan 30, 2018
Merged

Fixing failing Jenkins tests. Adding some Javadoc. #13517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 40 additions & 25 deletions dotCMS/src/main/java/com/dotmarketing/portlets/workflows/business/WorkFlowFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
package com.dotmarketing.portlets.workflows.business;

import java.util.List;
import java.util.Map;

import com.dotmarketing.business.DotStateException;
import com.dotmarketing.exception.AlreadyExistException;
import com.dotmarketing.exception.DotDataException;
Expand All @@ -18,7 +15,18 @@
import com.dotmarketing.portlets.workflows.model.WorkflowStep;
import com.dotmarketing.portlets.workflows.model.WorkflowTask;
import com.liferay.portal.model.User;
import java.util.List;
import java.util.Map;

/**
* This class provides access to all the information related to Workflows in dotCMS. Workflows
* allow content authors to specify the different phases that a content must go through when being
* published. This class provides methods to access information about the workflow assigned to a
* contentlet, and all the data that is generated during its execution.
*
* @author root
* @since Mar 22, 2012.
*/
public interface WorkFlowFactory {

public void deleteComment(WorkflowComment comment) throws DotDataException;
Expand Down Expand Up @@ -70,6 +78,15 @@ public interface WorkFlowFactory {

public void saveWorkflowHistory(WorkflowHistory history) throws DotDataException;

/**
* Saves a given WorkflowTask, if the task does not exist it will create a new one and if does exist
* it will update the existing record.
* <br/>
* If the record does not exist and the given task have set an id the new record will be created with that id.
*
* @param task
* @throws DotDataException
*/
public void saveWorkflowTask(WorkflowTask task) throws DotDataException;

public List<WorkflowScheme> findSchemes(boolean showArchived) throws DotDataException;
Expand Down Expand Up @@ -149,7 +166,6 @@ public interface WorkFlowFactory {
*/
void saveAction(WorkflowAction workflowAction, WorkflowStep workflowStep) throws DotDataException,AlreadyExistException;


public WorkflowStep findStep(String id) throws DotDataException;

/**
Expand All @@ -176,7 +192,6 @@ public interface WorkFlowFactory {
*/
void deleteActions(WorkflowStep step) throws DotDataException, AlreadyExistException;


public void deleteStep(WorkflowStep step) throws DotDataException, AlreadyExistException;

public int getCountContentletsReferencingStep(WorkflowStep step) throws DotDataException;
Expand Down Expand Up @@ -205,42 +220,42 @@ public interface WorkFlowFactory {

public void copyWorkflowStep(WorkflowStep from, WorkflowScheme scheme) throws DotDataException;

// christian escalation
public List<WorkflowTask> searchAllTasks(WorkflowSearcher searcher) throws DotDataException;

public WorkflowHistory retrieveLastStepAction(String taskId) throws DotDataException;
// christian escalation

public List<WorkflowTask> findExpiredTasks() throws DotDataException, DotSecurityException;

public WorkflowScheme findSchemeByName(String schemaName) throws DotDataException;

public void deleteWorkflowActionClassParameter(WorkflowActionClassParameter param) throws DotDataException, AlreadyExistException;

/**
* Method will replace user references of the given userId in workflow, workflow_ action task and workflow comments
* with the replacement user id
* @param userId User Identifier
* @param userRoleId The role id of the user
* @param replacementUserId The user id of the replacement user

/**
* Method will replace user references of the given userId in workflow, workflow_ action task
* and workflow comments with the replacement user id.
*
* @param userId User Identifier
* @param userRoleId The role id of the user
* @param replacementUserId The user id of the replacement user
* @param replacementUserRoleId The role Id of the replacemente user
* @throws DotDataException There is a data inconsistency
* @throws DotStateException There is a data inconsistency
* @throws DotSecurityException
*
* @throws DotDataException There is a data inconsistency
* @throws DotStateException There is a data inconsistency
* @throws DotSecurityException
*/
public void updateUserReferences(String userId, String userRoleId, String replacementUserId, String replacementUserRoleId)throws DotDataException, DotSecurityException;

/**
* Method will replace step references of the given stepId in workflow, workflow_action task and contentlets
* with the replacement step id
* @param stepId Step Identifier
* Method will replace step references of the given stepId in workflow, workflow_action task and
* contentlets with the replacement step id.
*
* @param stepId Step Identifier
* @param replacementStepId The step id of the replacement step
* @throws DotDataException There is a data inconsistency
* @throws DotStateException There is a data inconsistency
* @throws DotSecurityException
*
* @throws DotDataException There is a data inconsistency
* @throws DotStateException There is a data inconsistency
* @throws DotSecurityException
*/
public void updateStepReferences(String stepId, String replacementStepId) throws DotDataException, DotSecurityException;



}
Loading