com.atlassian.confluence.setup.bandana.persistence.dao
Interface ConfluenceBandanaRecordDao

All Known Implementing Classes:

HibernateConfluenceBandanaRecordDao

public interface ConfluenceBandanaRecordDao

Interface for DAOs which handle persistence of ConfluenceBandanaRecord instances.

Method Summary

Iterable<ConfluenceBandanaRecord>	findAllWithKey(String key) Returns all records that have a certain key, regardless of context.
Collection	findForContext(String context) Return all the records for the given context.
Iterable<String>	findKeysForContext(String context) Returns all keys for the given context.
ConfluenceBandanaRecord	getRecord(String context, String key) Retrieve a record for the given key, return null if no record exists
void	remove(ConfluenceBandanaRecord record) Remove a record by matching its key (context, key)
void	removeAllInContext(String context) Remove all the records belonging to the given context
void	saveOrUpdate(ConfluenceBandanaRecord record) Save the record, updating it if it already exists.

Method Detail

saveOrUpdate

void saveOrUpdate(ConfluenceBandanaRecord record)

Save the record, updating it if it already exists.

Parameters:

record - the ConfluenceBandanaRecord to update

getRecord

ConfluenceBandanaRecord getRecord(String context,
                                  String key)

Retrieve a record for the given key, return null if no record exists

Parameters:

context -

key -

Returns:

the matching record, or null

remove

void remove(ConfluenceBandanaRecord record)

Remove a record by matching its key (context, key)

Parameters:

record -

removeAllInContext

void removeAllInContext(String context)

Remove all the records belonging to the given context

Parameters:

context -

findForContext

Collection findForContext(String context)

Return all the records for the given context. Returns an empty collection if no records are found.

findKeysForContext

Iterable<String> findKeysForContext(String context)

Returns all keys for the given context.

findAllWithKey

Iterable<ConfluenceBandanaRecord> findAllWithKey(String key)

Returns all records that have a certain key, regardless of context. Calling this method is likely to be inefficient, and shouldn't be used unnecessarily.

Parameters:

key - the bandana key to look up