001/*-
002 * #%L
003 * HAPI FHIR Subscription Server
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.jpa.topic.status;
021
022import ca.uhn.fhir.jpa.subscription.match.registry.ActiveSubscription;
023import org.hl7.fhir.instance.model.api.IBaseResource;
024
025import java.util.List;
026
027public interface INotificationStatusBuilder<T extends IBaseResource> {
028        /**
029         * Build a notification status resource to include as the first element in a topic subscription notification bundle
030         * @param theResources The resources to include in the notification bundle.  It should _NOT_ include the
031         *                       notification status resource.  The first resource will be the "focus" resource.
032         * @param theActiveSubscription The active subscription that triggered the notification
033         * @param theTopicUrl   The topic URL of the topic subscription
034         * @return the notification status resource.  The resource type varies depending on the FHIR version.
035         */
036        T buildNotificationStatus(
037                        List<IBaseResource> theResources, ActiveSubscription theActiveSubscription, String theTopicUrl);
038}