001/*-
002 * #%L
003 * HAPI FHIR - Server Framework
004 * %%
005 * Copyright (C) 2014 - 2023 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.rest.api.server;
021
022import org.hl7.fhir.instance.model.api.IBaseResource;
023
024/**
025 * This interface is a parameter type for the {@link ca.uhn.fhir.interceptor.api.Pointcut#STORAGE_PRESHOW_RESOURCES}
026 * hook.
027 */
028public interface IPreResourceShowDetails extends Iterable<IBaseResource> {
029
030        /**
031         * @return Returns the number of resources being shown
032         */
033        int size();
034
035        /**
036         * @return Returns the resource at the given index. If you wish to make modifications
037         * to any resources
038         */
039        IBaseResource getResource(int theIndex);
040
041        /**
042         * Replace the resource being returned at index
043         *
044         * @param theIndex    The resource index
045         * @param theResource The resource at index
046         */
047        void setResource(int theIndex, IBaseResource theResource);
048
049        /**
050         * Indicates that data is being masked from within the resource at the given index.
051         * This generally flags to the rest of the stack that the resource should include
052         * a SUBSET tag as an indication to consumers that some data has been removed.
053         *
054         * @param theIndex The resource index
055         */
056        void markResourceAtIndexAsSubset(int theIndex);
057
058}