TransientPropertyPopulator.java

/*
 * Copyright (c) 2009 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.service.actions.strategies.directory;

import java.util.List;

import org.eurekastreams.commons.search.modelview.ModelView;

/**
 * Populates a transient property.
 */
public interface TransientPropertyPopulator
{

    /**
     * Populate any transient properties in the result set.
     * 
     * @param results
     *            the results to update
     * @param userPersonId
     *            the currently logged-in user's Person Id
     * @param searchText
     *            the text the user searched for
     */
    void populateTransientProperties(final List<ModelView> results, final long userPersonId, final String searchText);

}