CollectionService.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.apache.usergrid.corepersistence.service;


import org.apache.usergrid.corepersistence.pipeline.read.ResultsPage;
import org.apache.usergrid.persistence.model.entity.Entity;

import org.apache.usergrid.persistence.model.entity.Id;
import rx.Observable;


/**
 * Interface for operating on collections
 */
public interface CollectionService {

    /**
     * Search a collection and return an observable of results pages
     * @param search The search to perform
     * @return An observable with results page entries for the stream
     */
    Observable<ResultsPage<Entity>> searchCollection(final CollectionSearch search);



    Observable<ResultsPage<Id>> searchCollectionIds(final CollectionSearch search);
}