class ICFS::Cache
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.
@abstract
Public Instance Methods
Read an action
@param cid [String] caseid @param anum [Integer] the action number @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 153 def action_read(cid, anum); raise NotImplementedError; end
Search for actions
@param query [Hash] the query
# File lib/icfs/cache.rb, line 171 def action_search(query); raise NotImplementedError; end
Write an action
@param cid [String] caseid @param anum [Integer] the action number @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 163 def action_write(cid, anum, item); raise NotImplementedError; end
Read a case
@param cid [String] caseid @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 82 def case_read(cid); raise NotImplementedError; end
Search for cases
@param query [Hash] the query
# File lib/icfs/cache.rb, line 99 def case_search(query); raise NotImplementedError; end
Write a case
@param cid [String] caseid @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 91 def case_write(cid, item); raise NotImplementedError; end
Read current
@param cid [String] caseid @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 64 def current_read(cid); raise NotImplementedError; end
Write current
@param cid [String] caseid @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 73 def current_write(cid, item); raise NotImplementedError; end
Read an entry
@param cid [String] caseid @param enum [Integer] the entry number @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 117 def entry_read(cid, enum); raise NotImplementedError; end
Search for entries
@param query [Hash] the query
# File lib/icfs/cache.rb, line 135 def entry_search(query); raise NotImplementedError; end
Write an entry
@param cid [String] caseid @param enum [Integer] the entry number @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 127 def entry_write(cid, enum, item); raise NotImplementedError; end
Read an Index
@param cid [String] caseid @param xnum [Integer] the index number @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 189 def index_read(cid, xnum); raise NotImplementedError; end
Search for Indexes
@param query [Hash] the query
# File lib/icfs/cache.rb, line 207 def index_search(query); raise NotImplementedError; end
Write an Index
@param cid [String] caseid @param xnum [Integer] the index number @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 199 def index_write(cid, xnum, item); raise NotImplementedError; end
Release a case lock
@param cid [String] caseid
# File lib/icfs/cache.rb, line 55 def lock_release(cid); raise NotImplementedError; end
Take a case lock
@param cid [String] caseid
# File lib/icfs/cache.rb, line 47 def lock_take(cid); raise NotImplementedError; end
Read a log
@param cid [String] caseid @param lnum [Integer] the log number @return [String] JSON encoded item
# File lib/icfs/cache.rb, line 225 def log_read(cid, lnum); raise NotImplementedError; end
Search for a log
@param query [Hash] the query
# File lib/icfs/cache.rb, line 243 def log_search(query); raise NotImplementedError; end
Write a log
@param cid [String] caseid @param lnum [Integer] the log number @param item [String] JSON encoded item
# File lib/icfs/cache.rb, line 235 def log_write(cid, lnum, item); raise NotImplementedError; end
Analyze stats
@param query [Hash] the query
# File lib/icfs/cache.rb, line 251 def stats(query); raise NotImplementedError; end
What searching options are supported
@return [Hash] Supported searching options
# File lib/icfs/cache.rb, line 39 def supports; raise NotImplementedError; end