com.formkiq.server.service.SaveActionService Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 FormKiQ 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 com.formkiq.server.service;

import com.formkiq.server.service.dto.SaveActionRequest;
import com.formkiq.server.service.dto.SaveActionResponse;

/**
 * Actions that can be performed on Save.
 *
 */
public interface SaveActionService {

    /**
     * Name of Save Action Service.
     * @return {@link String}
     */
    String getName();

    /**
     * Returns whether request is supported by Service.
     * @param request SaveActionRequest
     * @return boolean
     */
    boolean isSupported(SaveActionRequest request);

    /**
     * Performs a SaveActionRequest and returns the result.
     * @param request SaveActionRequest
     * @return SaveActionResult
     * @throws SaveActionException SaveActionException
     */
    SaveActionResponse perform(SaveActionRequest request)
            throws SaveActionException;
}