io.gravitee.rest.api.service.PlanService 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.rest.api.model.NewPlanEntity;
import io.gravitee.rest.api.model.PlanEntity;
import io.gravitee.rest.api.model.PlansConfigurationEntity;
import io.gravitee.rest.api.model.UpdatePlanEntity;
import io.gravitee.rest.api.model.plan.PlanQuery;
import java.util.List;
import java.util.Set;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface PlanService {
    PlanEntity findById(String plan);

    Set findByApi(String api);

    List search(PlanQuery query);

    PlanEntity create(NewPlanEntity plan);

    PlanEntity update(UpdatePlanEntity plan);

    PlanEntity close(String plan, String username);

    void delete(String plan);

    PlanEntity publish(String plan);

    PlanEntity deprecate(String plan);

    PlanEntity deprecate(String plan, boolean allowStaging);

    PlansConfigurationEntity getConfiguration();

    PlanEntity create(String apiId, PlanEntity planEntity);
}