de.mhus.lib.portlet.actions.Action Maven / Gradle / Ivy

/**
 * Copyright (C) 2002 Mike Hummel ([email protected])
 *
 * 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 de.mhus.lib.portlet.actions;

import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;

import de.mhus.lib.core.IProperties;

/**
 * Action interface.
 *
 * @author mikehummel
 * @version $Id: $Id
 */
public interface Action {

    /**
     * processAction.
     *
     * @param path a {@link java.lang.String} object.
     * @param request a {@link javax.portlet.ActionRequest} object.
     * @param response a {@link javax.portlet.ActionResponse} object.
     * @return a boolean.
     * @throws java.lang.Exception if any.
     */
    public boolean processAction(String path, ActionRequest request, ActionResponse response)
            throws Exception;

    /**
     * createProperties.
     *
     * @param request a {@link javax.portlet.ActionRequest} object.
     * @return a {@link de.mhus.lib.core.IProperties} object.
     */
    public IProperties createProperties(ActionRequest request);
}