ca.uhn.fhir.rest.api.PagingHttpMethodEnum Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation

There is a newer version: 7.4.5

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.rest.api;

/**
 * Enumerated type to represent allowable HTTP methods for a paging request.
 */
public enum PagingHttpMethodEnum {

	/**
	 * This is the most common default behaviour. Performs the paging using GET HTTP method.
	 */
	GET(RequestTypeEnum.GET),

	/**
	 * Performs the paging using POST HTTP method. Note that this style is less commonly supported
	 * in servers, so it should not be used unless there is a specific reason for needing to.
	 */
	POST(RequestTypeEnum.POST);

	private final RequestTypeEnum myRequestType;

	PagingHttpMethodEnum(RequestTypeEnum theRequestType) {
		this.myRequestType = theRequestType;
	}

	public RequestTypeEnum getRequestType() {
		return myRequestType;
	}
}