TaskHandlerActionContext.java example

Explorer
eurekastreams-master
/*
 * Copyright (c) 2010-2011 Lockheed Martin Corporation
 *
 * 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.eurekastreams.commons.actions.context;

import java.util.List;

import org.eurekastreams.commons.server.UserActionRequest;

/**
 * This interface represents a specialized context for TaskHandler actions. This context carries along the original
 * context, as well as the list of {@link UserActionRequest} objects that are build up during execution and submitted
 * afterwards.
 * 
 * @param <T>
 *            - Type of ActionContext that is contained within this specialized context.
 */
public interface TaskHandlerActionContext<T extends ActionContext>
{
    /**
     * Retrieve the current {@link ActionContext} contained within this context.
     *
     * @return current {@link ActionContext} contained within this context.
     */
    T getActionContext();

    /**
     * Retrieve the current List of {@link UserActionRequest} objects.
     *
     * @return current List of {@link UserActionRequest} objects.
     */
    List<UserActionRequest> getUserActionRequests();
}