001/*-
002 * #%L
003 * HAPI FHIR - Server Framework
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.rest.api.server;
021
022import org.hl7.fhir.instance.model.api.IBaseResource;
023
024import java.util.List;
025
026/**
027 * This interface is a parameter type for the {@link ca.uhn.fhir.interceptor.api.Pointcut#STORAGE_PRESHOW_RESOURCES}
028 * hook.
029 */
030public interface IPreResourceShowDetails extends Iterable<IBaseResource> {
031
032        /**
033         * @return Returns the number of resources being shown
034         */
035        int size();
036
037        /**
038         * @return Returns the resource at the given index. If you wish to make modifications
039         * to any resources
040         */
041        IBaseResource getResource(int theIndex);
042
043        /**
044         * Replace the resource being returned at index
045         *
046         * @param theIndex    The resource index
047         * @param theResource The resource at index
048         */
049        void setResource(int theIndex, IBaseResource theResource);
050
051        /**
052         * Indicates that data is being masked from within the resource at the given index.
053         * This generally flags to the rest of the stack that the resource should include
054         * a SUBSET tag as an indication to consumers that some data has been removed.
055         *
056         * @param theIndex The resource index
057         */
058        void markResourceAtIndexAsSubset(int theIndex);
059
060        /**
061         * Returns a {@link List} containing all resources that will be shown.
062         * The returned list will have the same relative ordering as if the resources
063         * were retrieved using {@link #getResource(int)}, but any {@literal null} entries
064         * will be filtered out.
065         * <p>
066         * The returned List may not be modified. Use this method only if you are not
067         * looking to make changes.
068         *
069         * @since 6.6.0
070         */
071        List<IBaseResource> getAllResources();
072}