ApiJobStore (Fili: parent pom 0.10-SNAPSHOT API)

All Known Implementing Classes:

HashJobStore, NoOpApiJobStore
```
public interface ApiJobStore
```
An ApiJobStore is responsible for storing the metadata about Bard jobs. Conceptually, the ApiJobStore is a table where each row is the metadata of a particular job, and the columns are the metadata stored with each job (such metadata may include date created, a link to results, etc). The table uses the job's id as the primary key.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`rx.Observable<JobRow>`	`get(String id)` Returns a cold Observable that emits 0 or 1 messages: the desired JobRow, or nothing if there is no JobRow with the specified id.
`rx.Observable<JobRow>`	`getAllRows()` A cold observable that emits a stream of JobRows until all JobRows have been retrieved from the store.
`rx.Observable<JobRow>`	`getFilteredRows(Set<JobRowFilter> jobRowFilters)` This method takes a Set of JobRowFilters, ANDS them by default, and returns a cold observable that emits a stream of JobRows which satisfy the given filter.
`rx.Observable<JobRow>`	`save(JobRow metadata)` Returns a cold Observable that emits the JobRow that has been stored.

- Method Detail
  - get
```
rx.Observable<JobRow> get(String id)
```
    Returns a cold Observable that emits 0 or 1 messages: the desired JobRow, or nothing if there is no JobRow with the specified id.
    If an error is encountered while interacting with the metadata store, then the Observable's onError is called with the exception as payload.
    
    Parameters:
    
    id - The ID of the job desired
    
    Returns:
    
    An Observable that emits the metadata of the job with the specified id, if such a job exists
  - save
```
rx.Observable<JobRow> save(JobRow metadata)
```
    Returns a cold Observable that emits the JobRow that has been stored. The message is not emitted until the metadata has been successfully stored.
    While the Observable should not emit a message until at least one subscriber has subscribed, it should store the results immediately, without waiting for a subscriber. If a row with the same ID already exists, then that row will be overwritten. Otherwise, a new ID-JobRow mapping is added to the store. If an error is encountered while storing the data, the Observable instead invokes the onError methods on its subscribers with an ApiJobStoreException
    
    Parameters:
    
    metadata - The Job metadata that needs to be stored
    
    Returns:
    
    An Observable that emits the JobRow that was just stored
  - getAllRows
```
rx.Observable<JobRow> getAllRows()
```
    A cold observable that emits a stream of JobRows until all JobRows have been retrieved from the store. If at any time an error is encountered, onError is invoked, and the stream halts.
    
    Returns:
    
    An Observable that emits a stream of all the JobRows in the store
  - getFilteredRows
```
rx.Observable<JobRow> getFilteredRows(Set<JobRowFilter> jobRowFilters)
                               throws IllegalArgumentException
```
    This method takes a Set of JobRowFilters, ANDS them by default, and returns a cold observable that emits a stream of JobRows which satisfy the given filter.
    Any of the fields may be not filterable for every implementation of the ApiJobStore as the efficiency of filtering is dependent on the backing store. An IllegalArgumentException is thrown if filtering on any given field is not supported.
    
    Parameters:
    
    jobRowFilters - A Set of JobRowFilters where each JobRowFilter contains the JobField to be filtered on, the filter operation and the values to be compared to.
    
    Returns:
    
    An Observable that emits a stream of JobRows that satisfy the given filters
    
    Throws:
    
    IllegalArgumentException - if filtering on any field is not supported

Interface ApiJobStore

Method Summary

Method Detail

get

save

getAllRows

getFilteredRows