/*
 * Copyright 2023-2024 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.modulith.events;

import java.time.Duration;
import java.util.Collection;
import java.util.function.Predicate;

/**
 * All {@link EventPublication}s that have already been completed.
 *
 * @author Oliver Drotbohm
 * @since 1.1
 */
public interface CompletedEventPublications {

	/**
	 * Returns all {@link EventPublication}s that have already been completed.
	 *
	 * @return will never be {@literal null}.
	 */
	Collection<? extends EventPublication> findAll();

	/**
	 * Deletes all {@link EventPublication}s matching the given {@link Predicate}. Note that implementations will iterate
	 * all completed {@link EventPublication}s and apply the predicate in memory.
	 *
	 * @param filter must not be {@literal null}.
	 */
	void deletePublications(Predicate<EventPublication> filter);

	/**
	 * Deletes all {@link EventPublication}s whose completion date is older than the given {@link Duration}.
	 *
	 * @param duration must not be {@literal null}.
	 */
	void deletePublicationsOlderThan(Duration duration);
}
