class ICFS::Cache

Stores current items and provides a standard search interface.

Stores:

Provides locking and searching interface.

@abstract

Public Instance Methods

action_read(cid, anum) click to toggle source

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
action_tags(query) click to toggle source

List tags used on action tasks

@param query [Hash] the query

# File lib/icfs/cache.rb, line 179
def action_tags(query); raise NotImplementedError; end
action_write(cid, anum, item) click to toggle source

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
case_read(cid) click to toggle source

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
case_tags(query) click to toggle source

Get list of tags for cases

@param query [Hash] the query

# File lib/icfs/cache.rb, line 107
def case_tags(query); raise NotImplementedError;end
case_write(cid, item) click to toggle source

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
current_read(cid) click to toggle source

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
current_write(cid, item) click to toggle source

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
entry_read(cid, enum) click to toggle source

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
entry_search(query) click to toggle source

Search for entries

@param query [Hash] the query

# File lib/icfs/cache.rb, line 135
def entry_search(query); raise NotImplementedError; end
entry_tags(query) click to toggle source

List tags used on Entries

@param query [Hash] the query

# File lib/icfs/cache.rb, line 143
def entry_tags(query); raise NotImplementedError; end
entry_write(cid, enum, item) click to toggle source

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
index_read(cid, xnum) click to toggle source

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
index_tags(query) click to toggle source

List tags used in indexes

@param query [Hash] the query

# File lib/icfs/cache.rb, line 215
def index_tags(query); raise NotImplementedError; end
index_write(cid, xnum, item) click to toggle source

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
lock_release(cid) click to toggle source

Release a case lock

@param cid [String] caseid

# File lib/icfs/cache.rb, line 55
def lock_release(cid); raise NotImplementedError; end
lock_take(cid) click to toggle source

Take a case lock

@param cid [String] caseid

# File lib/icfs/cache.rb, line 47
def lock_take(cid); raise NotImplementedError; end
log_read(cid, lnum) click to toggle source

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
log_write(cid, lnum, item) click to toggle source

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
stats(query) click to toggle source

Analyze stats

@param query [Hash] the query

# File lib/icfs/cache.rb, line 251
def stats(query); raise NotImplementedError; end
supports() click to toggle source

What searching options are supported

@return [Hash] Supported searching options

# File lib/icfs/cache.rb, line 39
def supports; raise NotImplementedError; end