1 /* 2 * Copyright (C) 2024 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 android.app.appsearch.aidl; 18 19 import android.annotation.ElapsedRealtimeLong; 20 import android.annotation.NonNull; 21 import android.app.appsearch.SearchSpec; 22 import android.app.appsearch.safeparcel.AbstractSafeParcelable; 23 import android.app.appsearch.safeparcel.SafeParcelable; 24 import android.os.Parcel; 25 import android.os.Parcelable; 26 import android.os.UserHandle; 27 28 import java.util.Objects; 29 30 /** 31 * Encapsulates a request to make a binder call to search over all permitted databases in the 32 * AppSearch index. 33 * 34 * @hide 35 */ 36 @SafeParcelable.Class(creator = "GlobalSearchAidlRequestCreator") 37 public class GlobalSearchAidlRequest extends AbstractSafeParcelable { 38 @NonNull 39 public static final Parcelable.Creator<GlobalSearchAidlRequest> CREATOR = 40 new GlobalSearchAidlRequestCreator(); 41 42 @NonNull 43 @Field(id = 1, getter = "getCallerAttributionSource") 44 private final AppSearchAttributionSource mCallerAttributionSource; 45 46 @NonNull 47 @Field(id = 2, getter = "getSearchExpression") 48 private final String mSearchExpression; 49 50 @NonNull 51 @Field(id = 3, getter = "getSearchSpec") 52 private final SearchSpec mSearchSpec; 53 54 @NonNull 55 @Field(id = 4, getter = "getUserHandle") 56 private final UserHandle mUserHandle; 57 58 @Field(id = 5, getter = "getBinderCallStartTimeMillis") 59 @ElapsedRealtimeLong 60 private final long mBinderCallStartTimeMillis; 61 62 @Field(id = 6, getter = "isForEnterprise") 63 private final boolean mIsForEnterprise; 64 65 /** 66 * Executes a global search, i.e. over all permitted databases, against the AppSearch index and 67 * returns results. 68 * 69 * @param callerAttributionSource The permission identity of the package making the search. 70 * @param searchExpression String to search for 71 * @param searchSpec SearchSpec 72 * @param userHandle Handle of the calling user 73 * @param binderCallStartTimeMillis start timestamp of binder call in Millis 74 * @param isForEnterprise Whether to use the user's enterprise profile AppSearch instance 75 */ 76 @Constructor GlobalSearchAidlRequest( @aramid = 1) @onNull AppSearchAttributionSource callerAttributionSource, @Param(id = 2) @NonNull String searchExpression, @Param(id = 3) @NonNull SearchSpec searchSpec, @Param(id = 4) @NonNull UserHandle userHandle, @Param(id = 5) @ElapsedRealtimeLong long binderCallStartTimeMillis, @Param(id = 6) boolean isForEnterprise)77 public GlobalSearchAidlRequest( 78 @Param(id = 1) @NonNull AppSearchAttributionSource callerAttributionSource, 79 @Param(id = 2) @NonNull String searchExpression, 80 @Param(id = 3) @NonNull SearchSpec searchSpec, 81 @Param(id = 4) @NonNull UserHandle userHandle, 82 @Param(id = 5) @ElapsedRealtimeLong long binderCallStartTimeMillis, 83 @Param(id = 6) boolean isForEnterprise) { 84 mCallerAttributionSource = Objects.requireNonNull(callerAttributionSource); 85 mSearchExpression = Objects.requireNonNull(searchExpression); 86 mSearchSpec = Objects.requireNonNull(searchSpec); 87 mUserHandle = Objects.requireNonNull(userHandle); 88 mBinderCallStartTimeMillis = binderCallStartTimeMillis; 89 mIsForEnterprise = isForEnterprise; 90 } 91 92 @NonNull getCallerAttributionSource()93 public AppSearchAttributionSource getCallerAttributionSource() { 94 return mCallerAttributionSource; 95 } 96 97 @NonNull getSearchExpression()98 public String getSearchExpression() { 99 return mSearchExpression; 100 } 101 102 @NonNull getSearchSpec()103 public SearchSpec getSearchSpec() { 104 return mSearchSpec; 105 } 106 107 @NonNull getUserHandle()108 public UserHandle getUserHandle() { 109 return mUserHandle; 110 } 111 112 @ElapsedRealtimeLong getBinderCallStartTimeMillis()113 public long getBinderCallStartTimeMillis() { 114 return mBinderCallStartTimeMillis; 115 } 116 isForEnterprise()117 public boolean isForEnterprise() { 118 return mIsForEnterprise; 119 } 120 121 @Override writeToParcel(@onNull Parcel dest, int flags)122 public void writeToParcel(@NonNull Parcel dest, int flags) { 123 GlobalSearchAidlRequestCreator.writeToParcel(this, dest, flags); 124 } 125 } 126