001/*-
002 * #%L
003 * HAPI FHIR JPA Server - Batch2 Task Processor
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.batch2.api;
021
022import ca.uhn.fhir.batch2.model.ChunkOutcome;
023import ca.uhn.fhir.model.api.IModelJson;
024import jakarta.annotation.Nonnull;
025
026/**
027 * Reduction step worker.
028 * @param <PT> Job Parameter Type
029 * @param <IT> Input Parameter type (real input for step is ListResult of IT
030 * @param <OT> Output Job Report Type
031 */
032public interface IReductionStepWorker<PT extends IModelJson, IT extends IModelJson, OT extends IModelJson>
033                extends IJobStepWorker<PT, IT, OT> {
034
035        /**
036         *
037         * If an exception is thrown, the workchunk will be marked as failed.
038         * @param theChunkDetails - the workchunk details for reduction
039         * @return
040         */
041        @Nonnull
042        ChunkOutcome consume(ChunkExecutionDetails<PT, IT> theChunkDetails);
043}