001package ca.uhn.fhir.rest.server.interceptor.auth;
002
003/*
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2019 University Health Network
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.util.Collection;
024
025import org.hl7.fhir.instance.model.api.IIdType;
026
027public interface IAuthRuleBuilderRuleOpClassifier {
028
029        /**
030         * Rule applies to resources in the given compartment.
031         * <p>
032         * For example, to apply the rule to any observations in the patient compartment
033         * belonging to patient "123", you would invoke this with</br>
034         * <code>inCompartment("Patient", new IdType("Patient", "123"))</code>
035         * </p>
036         * <p>
037         * This call completes the rule and adds the rule to the chain. 
038         * </p>
039         * 
040         * @param theCompartmentName The name of the compartment (must not be null or blank)
041         * @param theOwner The owner of the compartment. Note that both the resource type and ID must be populated in this ID.
042         */
043        IAuthRuleBuilderRuleOpClassifierFinished inCompartment(String theCompartmentName, IIdType theOwner);
044
045        /**
046         * Rule applies to resources in the given compartment.
047         * <p>
048         * For example, to apply the rule to any observations in the patient compartment
049         * belonging to patient "123", you would invoke this with</br>
050         * <code>inCompartment("Patient", new IdType("Patient", "123"))</code>
051         * </p>
052         * <p>
053         * This call completes the rule and adds the rule to the chain. 
054         * </p>
055         * 
056         * @param theCompartmentName The name of the compartment (must not be null or blank)
057         * @param theOwners The owner of the compartment. Note that both the resource type and ID must be populated in this ID.
058         */
059        IAuthRuleBuilderRuleOpClassifierFinished inCompartment(String theCompartmentName, Collection<? extends IIdType> theOwners);
060
061        /**
062         * Rule applies to any resource instances
063         * <p>
064         * This call completes the rule and adds the rule to the chain. 
065         * </p>
066         */
067        IAuthRuleBuilderRuleOpClassifierFinished withAnyId();
068}