Sha256: 7d81326bd2db0751bf852f23082f48e87634a8faeb7bee34f6d0b06cd1bdbc13

Contents?: true

Size: 1.11 KB

Versions: 27

Compression:

Stored size: 1.11 KB

Contents

SearchMethods
===
SearchMethods' allow Umlaut to search an arbitrary data source for A-Z Journals.
Implementations must adhere to the following method signatures.
The module is included in the SearchController and has access to instance methods and
instance variables from the SearchController.

Class Methods:
--- 
These class methods are used only in the `:load_sfx_urls` rake task.
They are expected to be deprecated in future Umlaut releases.

  - `::fetch_urls?() `==> `Boolean` <br>
  Returns a Boolean indicating whether the module will return URLs
  
  - `::fetch_urls()` ==> `Array<String>` <br>
  Returns an array of strings representing URLs that are "owned" by the search
  system

Instance Methods:
---
  - `#find_by_title()` ==> `[Array<OpenURL::ContextObject>, integer]` <br>
  Returns a two element array consisting of an Array of OpenURL::ContextObject
  and the total count of records returned by the search
  
  - `#find_by_group()` ==> `[Array<OpenURL::ContextObject>, integer]` <br>
  Returns a two element array consisting of an Array of OpenURL::ContextObject
  and the total count of records returned by the search

Version data entries

27 entries across 27 versions & 1 rubygems

Version Path
umlaut-3.3.1 app/controllers/search_methods/README.md
umlaut-3.3.0 app/controllers/search_methods/README.md
umlaut-3.2.0 app/controllers/search_methods/README.md
umlaut-3.1.1 app/controllers/search_methods/README.md
umlaut-3.1.0 app/controllers/search_methods/README.md
umlaut-3.1.0.pre2 app/controllers/search_methods/README.md
umlaut-3.1.0.pre1 app/controllers/search_methods/README.md