001/*-
002 * #%L
003 * HAPI FHIR Storage api
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.model.search;
021
022public enum SearchStatusEnum {
023
024        /**
025         * The search is currently actively working
026         */
027        LOADING(false),
028        /**
029         * The search has loaded a set of results and has stopped searching because it
030         * reached an appropriate threshold
031         */
032        PASSCMPLET(false),
033        /**
034         * The search completed normally and loaded all of the results it as permitted to
035         * load
036         */
037        FINISHED(true),
038        /**
039         * The search failed and will not continue
040         */
041        FAILED(true),
042        /**
043         * The search has been expired and will be expunged shortly
044         */
045        GONE(true);
046
047        private final boolean myDone;
048
049        SearchStatusEnum(boolean theDone) {
050                myDone = theDone;
051        }
052
053        /**
054         * Returns true if no more work will happen for this search (finished, failed, gone)
055         */
056        public boolean isDone() {
057                return myDone;
058        }
059}