summaryrefslogtreecommitdiffstats
path: root/info_lookup/src/com/cyanogen/lookup/phonenumber/contract/LookupProvider.java
blob: 524e4cb250bdc6d8e0464c109fe9c819898e92c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package com.cyanogen.lookup.phonenumber.contract;

import com.cyanogen.lookup.phonenumber.request.LookupRequest;

/**
 * Notion of a phone number lookup provider
 */
public interface LookupProvider {

    /**
     * Explicit call to the provider to initialize itself. Decoupling it from provider construction
     * to enable explicit setup and tear down based on resource constraints.
     */
    boolean initialize();

    /**
     * Returns true if the provider is installed and enabled
     */
    boolean isEnabled();

    /**
     * Request to lookup contact info asynchronously. The callback is embedded
     * within {@link LookupRequest}
     */
    void fetchInfo(LookupRequest request);

    /**
     * Explicit call to disable provider and free resources
     */
    void disable();

    /**
     * Interface to provide ability to flag a phone number as spam
     */
    void markAsSpam(String phoneNumber);

}