1 /*
2  * Copyright (C) 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.bedstead.harrier.annotations.enterprise;
18 
19 import static com.android.bedstead.enterprise.annotations.EnsureHasWorkProfileKt.ENSURE_HAS_WORK_PROFILE_PRIORITY;
20 
21 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
22 import com.android.queryable.annotations.Query;
23 
24 import java.lang.annotation.ElementType;
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28 
29 /**
30  * Register additional query parameters which should be applied to test apps for this test.
31  *
32  * <p>This is used in conjunction with e.g. @PolicyApplies test to restrict the DPCs used.
33  */
34 @Target(ElementType.METHOD)
35 @Retention(RetentionPolicy.RUNTIME)
36 public @interface AdditionalQueryParameters {
37 
38     /**
39      * The test app to apply these query parameters to.
40      *
41      * <p>There should be a constant defined in the annotation you are trying to influence for the
42      * test apps they use.
43      */
forTestApp()44     String forTestApp();
45 
46     /** The additional query to apply. */
query()47     Query query();
48 
49      /**
50      * Priority sets the order that annotations will be resolved.
51      *
52      * <p>Annotations with a lower priority will be resolved before annotations with a higher
53      * priority.
54      *
55      * <p>If there is an order requirement between annotations, ensure that the priority of the
56      * annotation which must be resolved first is lower than the one which must be resolved later.
57      *
58      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
59      */
priority()60     int priority() default ENSURE_HAS_WORK_PROFILE_PRIORITY - 1;
61 }
62