ActivityQueryListTrimmerFactory.java

/*
 * Copyright (c) 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.server.action.execution.stream;

import net.sf.json.JSONObject;

/**
 * Interface for creating list trimmers. Allows trimmers to be stateful so they can extract the data from the query
 * once.
 */
public interface ActivityQueryListTrimmerFactory
{
    /**
     * Gets a trimmer for the activity query request.
     * 
     * @param request
     *            Activity request.
     * @param userEntityId
     *            User to receive the results.
     * @return Trimmer.
     */
    ListTrimmer getTrimmer(JSONObject request, Long userEntityId);
}