001package ca.uhn.fhir.rest.api.server;
002
003/*-
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import org.hl7.fhir.instance.model.api.IBaseResource;
024
025/**
026 * This interface is a parameter type for the {@link ca.uhn.fhir.interceptor.api.Pointcut#STORAGE_PRESHOW_RESOURCES}
027 * hook.
028 */
029public interface IPreResourceShowDetails extends Iterable<IBaseResource> {
030
031        /**
032         * @return Returns the number of resources being shown
033         */
034        int size();
035
036        /**
037         * @return Returns the resource at the given index. If you wish to make modifications
038         * to any resources
039         */
040        IBaseResource getResource(int theIndex);
041
042        /**
043         * Replace the resource being returned at index
044         *
045         * @param theIndex    The resource index
046         * @param theResource The resource at index
047         */
048        void setResource(int theIndex, IBaseResource theResource);
049
050        /**
051         * Indicates that data is being masked from within the resource at the given index.
052         * This generally flags to the rest of the stack that the resource should include
053         * a SUBSET tag as an indication to consumers that some data has been removed.
054         *
055         * @param theIndex The resource index
056         */
057        void markResourceAtIndexAsSubset(int theIndex);
058
059}