org.sakaiproject.service.framework.memory
Interface SiteCache

All Superinterfaces:
Cache, Cacher
All Known Implementing Classes:
SiteCacheImpl

public interface SiteCache
extends Cache

SiteCache is a cache that holds Site objects, and gives access to the cached site's ToolConfigurations by their id.

Author:
Sakai Software Development Team

Method Summary
 Group getGroup(String id)
          Access the group that is part of a cached site, by group Id.
 SitePage getPage(String pageId)
          Access the page that is part of a cached site, by page Id.
 ToolConfiguration getTool(String toolId)
          Access the tool that is part of a cached site, by tool Id.
 
Methods inherited from interface org.sakaiproject.service.framework.memory.Cache
clear, containsKey, containsKeyExpiredOrNot, destroy, disable, disabled, enable, expire, get, getAll, getAll, getExpiredOrNot, getIds, getKeys, holdEvents, isComplete, isComplete, processEvents, put, put, remove, setComplete, setComplete
 
Methods inherited from interface org.sakaiproject.service.framework.memory.Cacher
getDescription, getSize, resetCache
 

Method Detail

getTool

public ToolConfiguration getTool(String toolId)
Access the tool that is part of a cached site, by tool Id.

Parameters:
toolId - The tool's id.
Returns:
The ToolConfiguration that has this id, from a cached site.

getPage

public SitePage getPage(String pageId)
Access the page that is part of a cached site, by page Id.

Parameters:
pageId - The page's id.
Returns:
The SitePage that has this id, from a cached site.

getGroup

public Group getGroup(String id)
Access the group that is part of a cached site, by group Id.

Parameters:
id - The group id.
Returns:
The Group that has this id, from a cached site.