/**
 * Copyright (C) 2016 Marc Gonzalez Diez Open Source Project
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package repository.datasource;

import com.mgdiez.domain.bean.HashtagBo;
import com.mgdiez.domain.bean.TweetBo;

import java.util.List;

import rx.Observable;

/**
 * Interface that represents a data store from where data is retrieved.
 */
public interface TweetDatastore {

    /**
     * @param userName name of the user
     * @return Observable List of Tweets of UserTimeline
     */
    Observable<List<TweetBo>> getTweetsUsertimeline(String userName);

    /**
     * @param userName name of the user
     * @return Observable List of Tweets of Home Timeline
     */
    Observable<List<TweetBo>> getTweetsHometimeline(String userName);

    /**
     *
     * @return Observable List of Trending Topics atm.
     */
    Observable<List<HashtagBo>> getHashtags();

    /**
     *
     * @param search query introduced by the user
     * @return Observable List of Tweets related with the query
     */
    Observable<List<TweetBo>> getTweetsBySearch(String search);

}
