ITinCanEventScheduler.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.events.tincan;

import java.util.List;
import org.apereo.portal.events.tincan.om.LrsStatement;
import org.apereo.portal.events.tincan.providers.ITinCanAPIProvider;

/**
 * API that controls when API events are sent off to a provider.
 *
 */
public interface ITinCanEventScheduler {
    /**
     * Set the list of xAPI providers to process each event.
     *
     * @param providers the list of providers
     */
    void setProviders(List<ITinCanAPIProvider> providers);

    /**
     * Schedule an event for processing.
     *
     * @param statement the statement to schedule.
     */
    void scheduleEvent(LrsStatement statement);
}