io.gravitee.rest.api.service.PageService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-rest-api-service Show documentation
Gravitee IO Manager Service
There is a newer version: 3.10.0
Show newest version
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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.
 */
package io.gravitee.rest.api.service;

import io.gravitee.common.data.domain.Page;
import io.gravitee.rest.api.model.*;
import io.gravitee.rest.api.model.api.ApiEntity;
import io.gravitee.rest.api.model.common.Pageable;
import io.gravitee.rest.api.model.documentation.PageQuery;
import java.util.List;
import java.util.Map;

/**
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com)
 * @author Titouan COMPIEGNE (titouan.compiegne at graviteesource.com)
 * @author Guillaume GILLON
 * @author GraviteeSource Team
 */
public interface PageService {
    Page findAll(Pageable pageable);

    PageEntity findById(String pageId);

    PageEntity findById(String pageId, String acceptedLocale);

    List search(PageQuery query);

    List search(PageQuery query, boolean withTranslations);

    List search(PageQuery query, String acceptedLocale);

    void transformSwagger(PageEntity pageEntity);

    void transformSwagger(PageEntity pageEntity, String apiId);

    PageEntity createPage(String apiId, NewPageEntity page);

    PageEntity createPage(NewPageEntity page);

    PageEntity update(String pageId, UpdatePageEntity updatePageEntity);

    PageEntity update(String pageId, UpdatePageEntity updatePageEntity, boolean partial);

    void delete(String pageId);

    void deleteAllByApi(String apiId);

    int findMaxApiPageOrderByApi(String apiId);

    int findMaxPortalPageOrder();

    boolean isDisplayable(ApiEntity api, boolean isPagePublished, String username);

    void fetchAll(PageQuery query, String contributor);

    long execAutoFetch();

    PageEntity fetch(String pageId, String contributor);

    List importFiles(ImportPageEntity pageEntity);

    List importFiles(String apiId, ImportPageEntity pageEntity);

    void transformWithTemplate(PageEntity pageEntity, String api);

    PageEntity create(String apiId, PageEntity pageEntity);

    List validateSafeContent(PageEntity pageEntity, String apiId);

    Map initialize(String environmentId);

    PageEntity createSystemFolder(String apiId, SystemFolderType systemFolderType, int order, String environmentId);

    PageEntity createWithDefinition(String apiId, String toString);

    /**
     * Check if the page is used as GeneralCondition by an active Plan for the given ApiID
     *
     * @param page
     * @param apiId
     * @return
     */
    boolean isPageUsedAsGeneralConditions(PageEntity page, String apiId);

    boolean shouldHaveRevision(String pageType);

    void attachMedia(String pageId, String mediaId, String mediaName);
}