com.liferay.search.experiences.rest.resource.v1_0.SXPBlueprintResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.search.experiences.rest.api Show documentation
Liferay Search Experiences REST API
The newest version!
/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.search.experiences.rest.resource.v1_0;

import com.liferay.portal.kernel.search.Sort;
import com.liferay.portal.kernel.search.filter.Filter;
import com.liferay.portal.kernel.service.GroupLocalService;
import com.liferay.portal.kernel.service.ResourceActionLocalService;
import com.liferay.portal.kernel.service.ResourcePermissionLocalService;
import com.liferay.portal.kernel.service.RoleLocalService;
import com.liferay.portal.odata.filter.ExpressionConvert;
import com.liferay.portal.odata.filter.FilterParserProvider;
import com.liferay.portal.odata.sort.SortParserProvider;
import com.liferay.portal.vulcan.accept.language.AcceptLanguage;
import com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineExportTaskResource;
import com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineImportTaskResource;
import com.liferay.portal.vulcan.pagination.Page;
import com.liferay.portal.vulcan.pagination.Pagination;
import com.liferay.search.experiences.rest.dto.v1_0.SXPBlueprint;

import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.annotation.Generated;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

import org.osgi.annotation.versioning.ProviderType;

/**
 * To access this resource, run:
 *
 *     curl -u [email protected]:yourpassword -D - http://localhost:8080/o/search-experiences-rest/v1.0
 *
 * @author Brian Wing Shun Chan
 * @generated
 */
@Generated("")
@ProviderType
public interface SXPBlueprintResource {

	public Page getSXPBlueprintsPage(
			String search, Filter filter, Pagination pagination, Sort[] sorts)
		throws Exception;

	public Response postSXPBlueprintsPageExportBatch(
			String search, Filter filter, Sort[] sorts, String callbackURL,
			String contentType, String fieldNames)
		throws Exception;

	public SXPBlueprint postSXPBlueprint(SXPBlueprint sxpBlueprint)
		throws Exception;

	public Response postSXPBlueprintBatch(
			SXPBlueprint sxpBlueprint, String callbackURL, Object object)
		throws Exception;

	public SXPBlueprint getSXPBlueprintByExternalReferenceCode(
			String externalReferenceCode)
		throws Exception;

	public SXPBlueprint putSXPBlueprintByExternalReferenceCode(
			String externalReferenceCode, SXPBlueprint sxpBlueprint)
		throws Exception;

	public SXPBlueprint postSXPBlueprintValidate(String string)
		throws Exception;

	public void deleteSXPBlueprint(Long sxpBlueprintId) throws Exception;

	public Response deleteSXPBlueprintBatch(
			Long sxpBlueprintId, String callbackURL, Object object)
		throws Exception;

	public SXPBlueprint getSXPBlueprint(Long sxpBlueprintId) throws Exception;

	public SXPBlueprint patchSXPBlueprint(
			Long sxpBlueprintId, SXPBlueprint sxpBlueprint)
		throws Exception;

	public SXPBlueprint putSXPBlueprint(
			Long sxpBlueprintId, SXPBlueprint sxpBlueprint)
		throws Exception;

	public Response putSXPBlueprintBatch(
			Long sxpBlueprintId, SXPBlueprint sxpBlueprint, String callbackURL,
			Object object)
		throws Exception;

	public SXPBlueprint postSXPBlueprintCopy(Long sxpBlueprintId)
		throws Exception;

	public Response getSXPBlueprintExport(Long sxpBlueprintId) throws Exception;

	public default void setContextAcceptLanguage(
		AcceptLanguage contextAcceptLanguage) {
	}

	public void setContextCompany(
		com.liferay.portal.kernel.model.Company contextCompany);

	public default void setContextHttpServletRequest(
		HttpServletRequest contextHttpServletRequest) {
	}

	public default void setContextHttpServletResponse(
		HttpServletResponse contextHttpServletResponse) {
	}

	public default void setContextUriInfo(UriInfo contextUriInfo) {
	}

	public void setContextUser(
		com.liferay.portal.kernel.model.User contextUser);

	public void setExpressionConvert(
		ExpressionConvert expressionConvert);

	public void setFilterParserProvider(
		FilterParserProvider filterParserProvider);

	public void setGroupLocalService(GroupLocalService groupLocalService);

	public void setResourceActionLocalService(
		ResourceActionLocalService resourceActionLocalService);

	public void setResourcePermissionLocalService(
		ResourcePermissionLocalService resourcePermissionLocalService);

	public void setRoleLocalService(RoleLocalService roleLocalService);

	public void setSortParserProvider(SortParserProvider sortParserProvider);

	public void setVulcanBatchEngineExportTaskResource(
		VulcanBatchEngineExportTaskResource
			vulcanBatchEngineExportTaskResource);

	public void setVulcanBatchEngineImportTaskResource(
		VulcanBatchEngineImportTaskResource
			vulcanBatchEngineImportTaskResource);

	public default Filter toFilter(String filterString) {
		return toFilter(
			filterString, Collections.>emptyMap());
	}

	public default Filter toFilter(
		String filterString, Map> multivaluedMap) {

		return null;
	}

	public default Sort[] toSorts(String sortsString) {
		return new Sort[0];
	}

	@ProviderType
	public interface Builder {

		public SXPBlueprintResource build();

		public Builder checkPermissions(boolean checkPermissions);

		public Builder httpServletRequest(
			HttpServletRequest httpServletRequest);

		public Builder httpServletResponse(
			HttpServletResponse httpServletResponse);

		public Builder preferredLocale(Locale preferredLocale);

		public Builder uriInfo(UriInfo uriInfo);

		public Builder user(com.liferay.portal.kernel.model.User user);

	}

	@ProviderType
	public interface Factory {

		public Builder create();

	}

}