ISituationsServiceImpl.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.rtgov.ui.server.services;

import java.io.OutputStream;

import org.overlord.rtgov.ui.client.model.ResolutionState;
import org.overlord.rtgov.ui.client.model.BatchRetryResult;
import org.overlord.rtgov.ui.client.model.SituationBean;
import org.overlord.rtgov.ui.client.model.SituationResultSetBean;
import org.overlord.rtgov.ui.client.model.SituationsFilterBean;
import org.overlord.rtgov.ui.client.model.UiException;

/**
 * Provides a way to manage situations.
 *
 * @author eric.wittmann@redhat.com
 */
public interface ISituationsServiceImpl {

    /**
     * Search for services using the given filters and search text.
     * @param filters
     * @param page
     * @param sortColumn
     * @param ascending
     * @throws UiException
     */
    public SituationResultSetBean search(SituationsFilterBean filters, int page, String sortColumn,
            boolean ascending) throws UiException;

    /**
     * Fetches a full service by its name.
     * @param name
     * @throws UiException
     */
    public SituationBean get(String name) throws UiException;

    /**
     * Resubmits a message.
     * @param situationId
     * @param message
     * @throws UiException
     */
    public void resubmit(String situationId, String message, String username) throws UiException;
    
    /**
     * Assigns a situation to the currently logged in user.
     * @param situationId
     * @param userName
     * @throws UiException
     */
    void assign(String situationId, String userName) throws UiException;
    
    /**
     * Deassign (close) a situation from an assigned user.
     * @param situationId
     * @throws UiException
     */
    void unassign(String situationId) throws UiException;

    /**
     * Updates a situation's resolutionState.
     * @param situationId
     * @throws UiException
     */
	void updateResolutionState(String situationId, ResolutionState resolutionState) throws UiException;

	/**
     * Resubmits all message matching the given filter criteria.
     * @param situationsFilterBean
     * @param username The user performing the resubmit
     * @throws UiException
     */
    BatchRetryResult resubmit(SituationsFilterBean situationsFilterBean, String username) throws UiException;

    /**
     * Retrieve resubmission failures for situation.
     * @param situationId
     * @param page
     * @param sortColumn
     * @param ascending
     * @throws UiException
     */
    public SituationResultSetBean getResubmitFailures(String situationId, int page, String sortColumn,
            boolean ascending) throws UiException;

    /**
     * Export the content of all message's matching the given filter criteria.
     * @param situationsFilterBean
     */
    void export(SituationsFilterBean situationsFilterBean, OutputStream outputStream);

    /**
     * Deletes all message matching the given filter criteria.
     * @param situationsFilterBean
     * @throws UiException
     */
    int delete(SituationsFilterBean situationsFilterBean) throws UiException;

}