001/*-
002 * #%L
003 * HAPI FHIR JPA Server
004 * %%
005 * Copyright (C) 2014 - 2025 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.model;
021
022import ca.uhn.fhir.interceptor.api.Pointcut;
023import ca.uhn.fhir.model.api.IProvenanceAgent;
024import ca.uhn.fhir.rest.api.server.RequestDetails;
025
026import java.util.List;
027
028/**
029 * This interface is used to pass parameters to the {@link Pointcut#PROVENANCE_AGENTS} pointcut.
030 * It allows interceptors to retrieve input parameters and provide provenance agents as an output parameter.
031 */
032public interface IProvenanceAgentsPointcutParameter {
033        List<IProvenanceAgent> getProvenanceAgents();
034
035        IProvenanceAgentsPointcutParameter setProvenanceAgents(List<IProvenanceAgent> theProvenanceAgents);
036
037        void addProvenanceAgent(IProvenanceAgent theProvenanceAgent);
038
039        RequestDetails getRequestDetails();
040
041        IProvenanceAgentsPointcutParameter setRequestDetails(RequestDetails myRequestDetails);
042}