Class: ICFS::Cache Abstract
- Inherits:
-
Object
- Object
- ICFS::Cache
- Defined in:
- lib/icfs/cache.rb
Overview
Stores current items and provides a standard search interface.
Stores:
-
Case - current version
-
Log - all
-
Entry - current version
-
Action - current version
-
Current - for each case
-
Index - current version
Provides locking and searching interface.
Direct Known Subclasses
Instance Method Summary collapse
-
#action_read(cid, anum) ⇒ String
Read an action.
-
#action_search(query) ⇒ Object
Search for actions.
-
#action_tags(query) ⇒ Object
List tags used on action tasks.
-
#action_write(cid, anum, item) ⇒ Object
Write an action.
-
#case_read(cid) ⇒ String
Read a case.
-
#case_search(query) ⇒ Object
Search for cases.
-
#case_tags(query) ⇒ Object
Get list of tags for cases.
-
#case_write(cid, item) ⇒ Object
Write a case.
-
#current_read(cid) ⇒ String
Read current.
-
#current_write(cid, item) ⇒ Object
Write current.
-
#entry_read(cid, enum) ⇒ String
Read an entry.
-
#entry_search(query) ⇒ Object
Search for entries.
-
#entry_tags(query) ⇒ Object
List tags used on Entries.
-
#entry_write(cid, enum, item) ⇒ Object
Write an entry.
-
#index_read(cid, xnum) ⇒ String
Read an Index.
-
#index_search(query) ⇒ Object
Search for Indexes.
-
#index_tags(query) ⇒ Object
List tags used in indexes.
-
#index_write(cid, xnum, item) ⇒ Object
Write an Index.
-
#lock_release(cid) ⇒ Object
Release a case lock.
-
#lock_take(cid) ⇒ Object
Take a case lock.
-
#log_read(cid, lnum) ⇒ String
Read a log.
-
#log_search(query) ⇒ Object
Search for a log.
-
#log_write(cid, lnum, item) ⇒ Object
Write a log.
-
#stats(query) ⇒ Object
Analyze stats.
-
#supports ⇒ Hash
What searching options are supported.
Instance Method Details
#action_read(cid, anum) ⇒ String
Read an action
153 |
# File 'lib/icfs/cache.rb', line 153 def action_read(cid, anum); raise NotImplementedError; end |
#action_search(query) ⇒ Object
Search for actions
171 |
# File 'lib/icfs/cache.rb', line 171 def action_search(query); raise NotImplementedError; end |
#action_tags(query) ⇒ Object
List tags used on action tasks
179 |
# File 'lib/icfs/cache.rb', line 179 def (query); raise NotImplementedError; end |
#action_write(cid, anum, item) ⇒ Object
Write an action
163 |
# File 'lib/icfs/cache.rb', line 163 def action_write(cid, anum, item); raise NotImplementedError; end |
#case_read(cid) ⇒ String
Read a case
82 |
# File 'lib/icfs/cache.rb', line 82 def case_read(cid); raise NotImplementedError; end |
#case_search(query) ⇒ Object
Search for cases
99 |
# File 'lib/icfs/cache.rb', line 99 def case_search(query); raise NotImplementedError; end |
#case_tags(query) ⇒ Object
Get list of tags for cases
107 |
# File 'lib/icfs/cache.rb', line 107 def (query); raise NotImplementedError;end |
#case_write(cid, item) ⇒ Object
Write a case
91 |
# File 'lib/icfs/cache.rb', line 91 def case_write(cid, item); raise NotImplementedError; end |
#current_read(cid) ⇒ String
Read current
64 |
# File 'lib/icfs/cache.rb', line 64 def current_read(cid); raise NotImplementedError; end |
#current_write(cid, item) ⇒ Object
Write current
73 |
# File 'lib/icfs/cache.rb', line 73 def current_write(cid, item); raise NotImplementedError; end |
#entry_read(cid, enum) ⇒ String
Read an entry
117 |
# File 'lib/icfs/cache.rb', line 117 def entry_read(cid, enum); raise NotImplementedError; end |
#entry_search(query) ⇒ Object
Search for entries
135 |
# File 'lib/icfs/cache.rb', line 135 def entry_search(query); raise NotImplementedError; end |
#entry_tags(query) ⇒ Object
List tags used on Entries
143 |
# File 'lib/icfs/cache.rb', line 143 def (query); raise NotImplementedError; end |
#entry_write(cid, enum, item) ⇒ Object
Write an entry
127 |
# File 'lib/icfs/cache.rb', line 127 def entry_write(cid, enum, item); raise NotImplementedError; end |
#index_read(cid, xnum) ⇒ String
Read an Index
189 |
# File 'lib/icfs/cache.rb', line 189 def index_read(cid, xnum); raise NotImplementedError; end |
#index_search(query) ⇒ Object
Search for Indexes
207 |
# File 'lib/icfs/cache.rb', line 207 def index_search(query); raise NotImplementedError; end |
#index_tags(query) ⇒ Object
List tags used in indexes
215 |
# File 'lib/icfs/cache.rb', line 215 def (query); raise NotImplementedError; end |
#index_write(cid, xnum, item) ⇒ Object
Write an Index
199 |
# File 'lib/icfs/cache.rb', line 199 def index_write(cid, xnum, item); raise NotImplementedError; end |
#lock_release(cid) ⇒ Object
Release a case lock
55 |
# File 'lib/icfs/cache.rb', line 55 def lock_release(cid); raise NotImplementedError; end |
#lock_take(cid) ⇒ Object
Take a case lock
47 |
# File 'lib/icfs/cache.rb', line 47 def lock_take(cid); raise NotImplementedError; end |
#log_read(cid, lnum) ⇒ String
Read a log
225 |
# File 'lib/icfs/cache.rb', line 225 def log_read(cid, lnum); raise NotImplementedError; end |
#log_search(query) ⇒ Object
Search for a log
243 |
# File 'lib/icfs/cache.rb', line 243 def log_search(query); raise NotImplementedError; end |
#log_write(cid, lnum, item) ⇒ Object
Write a log
235 |
# File 'lib/icfs/cache.rb', line 235 def log_write(cid, lnum, item); raise NotImplementedError; end |
#stats(query) ⇒ Object
Analyze stats
251 |
# File 'lib/icfs/cache.rb', line 251 def stats(query); raise NotImplementedError; end |
#supports ⇒ Hash
What searching options are supported
39 |
# File 'lib/icfs/cache.rb', line 39 def supports; raise NotImplementedError; end |