ITaskInboxService.java

/*
 * Copyright 2013 JBoss Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.overlord.dtgov.ui.client.shared.services;

import org.jboss.errai.bus.server.annotations.Remote;
import org.overlord.dtgov.ui.client.shared.beans.TaskActionEnum;
import org.overlord.dtgov.ui.client.shared.beans.TaskBean;
import org.overlord.dtgov.ui.client.shared.beans.TaskInboxFilterBean;
import org.overlord.dtgov.ui.client.shared.beans.TaskInboxResultSetBean;
import org.overlord.dtgov.ui.client.shared.exceptions.DtgovUiException;

/**
 * Provides a way to search for tasks.
 *
 * @author eric.wittmann@redhat.com
 */
@Remote
public interface ITaskInboxService {

    /**
     * Search for tasks using the given filters and search text.
     * @param filters
     * @param page
     * @param sortColumnId
     * @param sortAscending
     * @throws DtgovUiException
     */
    public TaskInboxResultSetBean search(TaskInboxFilterBean filters, int page, String sortColumnId,
            boolean sortAscending) throws DtgovUiException;

    /**
     * Fetches a full task by its ID.
     * @param taskId
     * @throws DtgovUiException
     */
    public TaskBean get(String taskId) throws DtgovUiException;

    /**
     * Updates the meta-data of a task.
     * @param task
     * @throws DtgovUiException
     */
    public void update(TaskBean task) throws DtgovUiException;

    /**
     * Executes the given action on the given task.
     * @param task
     * @param action
     */
    public TaskBean executeAction(TaskBean task, TaskActionEnum action) throws DtgovUiException;

}