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.batch.models;
021
022import jakarta.annotation.Nonnull;
023
024/**
025 * Base parameters for StartJob as well as other requests
026 */
027public class Batch2BaseJobParameters {
028
029        /**
030         * The id of the jobdefinition that is to be executed
031         */
032        private final String myJobDefinitionId;
033
034        /**
035         * If true, will search for existing jobs
036         * first and return any that have already completed or are inprogress/queued first
037         */
038        private boolean myUseExistingJobsFirst;
039
040        public Batch2BaseJobParameters(@Nonnull String theJobDefinitionId) {
041                myJobDefinitionId = theJobDefinitionId;
042        }
043
044        public String getJobDefinitionId() {
045                return myJobDefinitionId;
046        }
047
048        public boolean isUseExistingJobsFirst() {
049                return myUseExistingJobsFirst;
050        }
051
052        public void setUseExistingJobsFirst(boolean theUseExistingJobsFirst) {
053                myUseExistingJobsFirst = theUseExistingJobsFirst;
054        }
055}