org.xlcloud.service.api.RestrictionsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xms-api Show documentation

The newest version!

/*
 * Copyright 2012 AMG.lab, a Bull Group Company
 * 
 * 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 org.xlcloud.service.api;

import org.xlcloud.service.Restriction;
import org.xlcloud.service.Restrictions;

/**
 * Interface for API that allows to manage {@link Restriction} scoped resources.
 * 
 * @author Andrzej Stasiak, AMG.net
 *
 */
public interface RestrictionsApi {
    
    /**
     * Lists all defined {@link Restrictions}.
     * Returns only accountId, restrictionId and name for each restriction.
     * @return list of {@link Restriction}
     */
    Restrictions listRestrictions();
    
    /**
     * Removes an {@link Restriction}
     * @param restrictionId
     */
    void deleteRestriction(Long restrictionId);
    
    /**
     * Returns the {@link Restriction} with the specified id
     * @param restrictionId
     * @return {@link Restriction} object
     */
    Restriction getRestriction(Long restrictionId);
    
    /**
     * Updates the {@link Restriction} with the specified id
     * @param restrictionId
     * @param restriction
     * @return updated {@link Restriction} object
     */
    Restriction updateRestriction(Long restrictionId, Restriction restriction);
}