api/src/main/java/org/apache/unomi/api/services/ScopeService.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.unomi.api.services;

import org.apache.unomi.api.Scope;

import java.util.List;

/**
 * A service to create, update and delete scope.
 */
public interface ScopeService {

    /**
     * Retrieves all known scopes.
     *
     * @return the List of known scopes
     */
    List<Scope> getScopes();

    /**
     * Save a scope
     *
     * @param scope to save
     */
    void save(Scope scope);

    /**
     * Delete a scope
     *
     * @param id of the scope
     * @return true if scope is deleted
     */
    boolean delete(String id);

    /**
     * Get a scope by its id
     *
     * @return Scope matching the id
     */
    Scope getScope(String id);
}