Package com.liferay.headless.admin.site.resource.v1_0

Interface MasterPageResource

@Generated("")
@ProviderType
public interface MasterPageResource

To access this resource, run: curl -u your@email.com:yourpassword -D - http://localhost:8080/o/headless-admin-site/v1.0

Generated:

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MasterPageResource.Builder
static interface	MasterPageResource.Factory

Method Summary

Modifier and Type	Method	Description
void	deleteSiteMasterPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode)
MasterPage	getSiteMasterPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode)
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>	getSiteMasterPagePermissionsPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode, String roleNames)
com.liferay.portal.vulcan.pagination.Page<MasterPage>	getSiteMasterPagesPage(String siteExternalReferenceCode, String search, com.liferay.portal.vulcan.aggregation.Aggregation aggregation, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.vulcan.pagination.Pagination pagination, com.liferay.portal.kernel.search.Sort[] sorts)
MasterPage	patchSiteMasterPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode, MasterPage masterPage)
MasterPage	postSiteMasterPage(String siteExternalReferenceCode, MasterPage masterPage)
jakarta.ws.rs.core.Response	postSiteMasterPageBatch(String siteExternalReferenceCode, String callbackURL, Object object)
ContentPageSpecification	postSiteMasterPagePageSpecification(String siteExternalReferenceCode, String masterPageExternalReferenceCode, ContentPageSpecification contentPageSpecification)
jakarta.ws.rs.core.Response	postSiteMasterPagesPageExportBatch(String siteExternalReferenceCode, String search, com.liferay.portal.kernel.search.filter.Filter filter, com.liferay.portal.kernel.search.Sort[] sorts, String callbackURL, String contentType, String fieldNames)
MasterPage	putSiteMasterPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode, MasterPage masterPage)
com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission>	putSiteMasterPagePermissionsPage(String siteExternalReferenceCode, String masterPageExternalReferenceCode, com.liferay.portal.vulcan.permission.Permission[] permissions)
default void	setContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage)
void	setContextCompany(com.liferay.portal.kernel.model.Company contextCompany)
default void	setContextHttpServletRequest(jakarta.servlet.http.HttpServletRequest contextHttpServletRequest)
default void	setContextHttpServletResponse(jakarta.servlet.http.HttpServletResponse contextHttpServletResponse)
default void	setContextUriInfo(jakarta.ws.rs.core.UriInfo contextUriInfo)
void	setContextUser(com.liferay.portal.kernel.model.User contextUser)
void	setExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert)
void	setFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider)
void	setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService)
void	setResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService)
void	setResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService)
void	setRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService)
void	setSortParserProvider(com.liferay.portal.odata.sort.SortParserProvider sortParserProvider)
void	setVulcanBatchEngineExportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineExportTaskResource vulcanBatchEngineExportTaskResource)
void	setVulcanBatchEngineImportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineImportTaskResource vulcanBatchEngineImportTaskResource)
default com.liferay.portal.kernel.search.filter.Filter	toFilter(String filterString)
default com.liferay.portal.kernel.search.filter.Filter	toFilter(String filterString, Map<String,List<String>> multivaluedMap)
default com.liferay.portal.kernel.search.Sort[]	toSorts(String sortsString)

Method Details

deleteSiteMasterPage

void deleteSiteMasterPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode)
                   throws Exception

Throws:

Exception

getSiteMasterPage

MasterPage getSiteMasterPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode)
                      throws Exception

Throws:

Exception

getSiteMasterPagePermissionsPage

com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> getSiteMasterPagePermissionsPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode,
 String roleNames)
                                                                                                                     throws Exception

Throws:

Exception

getSiteMasterPagesPage

com.liferay.portal.vulcan.pagination.Page<MasterPage> getSiteMasterPagesPage(String siteExternalReferenceCode,
 String search,
 com.liferay.portal.vulcan.aggregation.Aggregation aggregation,
 com.liferay.portal.kernel.search.filter.Filter filter,
 com.liferay.portal.vulcan.pagination.Pagination pagination,
 com.liferay.portal.kernel.search.Sort[] sorts)
                                                                      throws Exception

Throws:

Exception

patchSiteMasterPage

MasterPage patchSiteMasterPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode,
 MasterPage masterPage)
                        throws Exception

Throws:

Exception

postSiteMasterPage

MasterPage postSiteMasterPage(String siteExternalReferenceCode,
 MasterPage masterPage)
                       throws Exception

Throws:

Exception

postSiteMasterPageBatch

jakarta.ws.rs.core.Response postSiteMasterPageBatch(String siteExternalReferenceCode,
 String callbackURL,
 Object object)
                                             throws Exception

Throws:

Exception

postSiteMasterPagePageSpecification

ContentPageSpecification postSiteMasterPagePageSpecification(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode,
 ContentPageSpecification contentPageSpecification)
                                                      throws Exception

Throws:

Exception

postSiteMasterPagesPageExportBatch

jakarta.ws.rs.core.Response postSiteMasterPagesPageExportBatch(String siteExternalReferenceCode,
 String search,
 com.liferay.portal.kernel.search.filter.Filter filter,
 com.liferay.portal.kernel.search.Sort[] sorts,
 String callbackURL,
 String contentType,
 String fieldNames)
                                                        throws Exception

Throws:

Exception

putSiteMasterPage

MasterPage putSiteMasterPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode,
 MasterPage masterPage)
                      throws Exception

Throws:

Exception

putSiteMasterPagePermissionsPage

com.liferay.portal.vulcan.pagination.Page<com.liferay.portal.vulcan.permission.Permission> putSiteMasterPagePermissionsPage(String siteExternalReferenceCode,
 String masterPageExternalReferenceCode,
 com.liferay.portal.vulcan.permission.Permission[] permissions)
                                                                                                                     throws Exception

Throws:

Exception

setContextAcceptLanguage

default void setContextAcceptLanguage(com.liferay.portal.vulcan.accept.language.AcceptLanguage contextAcceptLanguage)

setContextCompany

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

setContextHttpServletRequest

default void setContextHttpServletRequest(jakarta.servlet.http.HttpServletRequest contextHttpServletRequest)

setContextHttpServletResponse

default void setContextHttpServletResponse(jakarta.servlet.http.HttpServletResponse contextHttpServletResponse)

setContextUriInfo

default void setContextUriInfo(jakarta.ws.rs.core.UriInfo contextUriInfo)

setContextUser

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

setExpressionConvert

void setExpressionConvert(com.liferay.portal.odata.filter.ExpressionConvert<com.liferay.portal.kernel.search.filter.Filter> expressionConvert)

setFilterParserProvider

void setFilterParserProvider(com.liferay.portal.odata.filter.FilterParserProvider filterParserProvider)

setGroupLocalService

void setGroupLocalService(com.liferay.portal.kernel.service.GroupLocalService groupLocalService)

setResourceActionLocalService

void setResourceActionLocalService(com.liferay.portal.kernel.service.ResourceActionLocalService resourceActionLocalService)

setResourcePermissionLocalService

void setResourcePermissionLocalService(com.liferay.portal.kernel.service.ResourcePermissionLocalService resourcePermissionLocalService)

setRoleLocalService

void setRoleLocalService(com.liferay.portal.kernel.service.RoleLocalService roleLocalService)

setSortParserProvider

void setSortParserProvider(com.liferay.portal.odata.sort.SortParserProvider sortParserProvider)

setVulcanBatchEngineExportTaskResource

void setVulcanBatchEngineExportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineExportTaskResource vulcanBatchEngineExportTaskResource)

setVulcanBatchEngineImportTaskResource

void setVulcanBatchEngineImportTaskResource(com.liferay.portal.vulcan.batch.engine.resource.VulcanBatchEngineImportTaskResource vulcanBatchEngineImportTaskResource)

toFilter

default com.liferay.portal.kernel.search.filter.Filter toFilter(String filterString)

toFilter

default com.liferay.portal.kernel.search.filter.Filter toFilter(String filterString,
 Map<String,List<String>> multivaluedMap)

toSorts

default com.liferay.portal.kernel.search.Sort[] toSorts(String sortsString)