com.formkiq.server.dao.WorkflowDao Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of formkiq-server Show documentation

Server-side integration for the FormKiQ ios application

There is a newer version: 0.6.1

package com.formkiq.server.dao;

import com.formkiq.server.domain.ClientWorkflow;
import com.formkiq.server.domain.User;
import com.formkiq.server.domain.WorkflowLog;
import com.formkiq.server.domain.type.SyncListDTO;
import com.formkiq.server.domain.type.WorkflowListDTO;

/**
 * Methods for retrieving Client data from the database.
 *
 */
public interface WorkflowDao {

    /**
     * Find Workflow.
     * @param user {@link User}
     * @param client {@link String}
     * @param uuid {@link String}
     * @return {@link ClientWorkflow}
     */
    ClientWorkflow findWorkflow(final User user, final String client,
            final String uuid);

    /**
     * Find Workflows.
     * @param client {@link String}
     * @return {@link WorkflowListDTO}
     */
    WorkflowListDTO findWorkflows(String client);

    /**
     * Find Workflows by parent.
     * @param client {@link String}
     * @param workflow {@link String}
     * @return {@link WorkflowListDTO}
     */
    WorkflowListDTO findWorkflows(String client, String workflow);

    /**
     * Get Workflow Sync List.
     * @param client {@link String}
     * @param nextToken int
     * @return {@link SyncListDTO}
     */
    SyncListDTO findWorkflowSyncList(String client, int nextToken);

    /**
     * Saves Workflow.
     * @param workflow {@link ClientWorkflow}
     * @return {@link ClientWorkflow}
     */
    ClientWorkflow saveWorkflow(ClientWorkflow workflow);

    /**
     * Save Workflow Log.
     * @param log {@link WorkflowLog}
     * @return {@link WorkflowLog}
     */
    WorkflowLog saveWorkflowLog(final WorkflowLog log);
}