1 /*
2  * Copyright (C) 2018 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 package android.service.autofill;
17 
18 import android.os.Bundle;
19 import android.util.ArrayMap;
20 
21 /**
22  * Class used to define a generic UserData for field classification
23  *
24  * @hide
25  */
26 public interface FieldClassificationUserData {
27     /**
28      * Gets the name of the default algorithm that is used to calculate
29      * {@link FieldClassification.Match#getScore()} match scores}.
30      */
getFieldClassificationAlgorithm()31     String getFieldClassificationAlgorithm();
32 
33     /**
34      * Gets the default field classification args.
35      */
getDefaultFieldClassificationArgs()36     Bundle getDefaultFieldClassificationArgs();
37 
38     /**
39      * Gets the name of the field classification algorithm for a specific category.
40      *
41      * @param categoryId id of the specific category.
42      */
getFieldClassificationAlgorithmForCategory(String categoryId)43     String getFieldClassificationAlgorithmForCategory(String categoryId);
44 
45     /**
46      * Gets all field classification algorithms for specific categories.
47      */
getFieldClassificationAlgorithms()48     ArrayMap<String, String> getFieldClassificationAlgorithms();
49 
50     /**
51      * Gets all field classification args for specific categories.
52      */
getFieldClassificationArgs()53     ArrayMap<String, Bundle> getFieldClassificationArgs();
54 
55     /**
56      * Gets all category ids
57      */
getCategoryIds()58     String[] getCategoryIds();
59 
60     /**
61      * Gets all string values for field classification
62      */
getValues()63     String[] getValues();
64 }
65