| org.sakaiproject.metaobj.shared.mgt.HomeFactory
All known Subclasses: org.sakaiproject.metaobj.shared.mgt.factories.DbXmlHomeFactoryImpl, org.sakaiproject.metaobj.shared.mgt.HomeFactoryImpl, org.sakaiproject.metaobj.shared.mgt.factories.MapHomeFactoryImpl, org.sakaiproject.metaobj.shared.mgt.factories.HomeFactoryBase, org.sakaiproject.metaobj.shared.mgt.factories.InteractionHomeFactoryImpl, org.sakaiproject.metaobj.shared.mgt.factories.XmlHomeFactoryImpl, org.sakaiproject.metaobj.shared.mgt.factories.BinaryFileHomeFactoryImpl,
HomeFactory | public interface HomeFactory (Code) | | Created by IntelliJ IDEA.
User: John Ellis
Date: Apr 9, 2004
Time: 12:44:49 PM
To change this template use File | Settings | File Templates.
|
findHomeByExternalId | public ReadableObjectHome findHomeByExternalId(String externalId, Id worksiteId)(Code) | | Find a home by an external id. This id should be unique and naturally occuring.
This is used for matching up a home imported from another worksite or system when importing
things that use Homes (ie. presentation templates, matrices, etc)
Parameters: externalId - naturally occuring id (like the document root and system id of an xml document) Parameters: worksiteId - The worksite to import it into or null for global import the home if found or null. |
getHome | public ReadableObjectHome getHome(String objectType)(Code) | | Get a home for the given object type. The returned home may support a number of interfaces
depending on the features of this home. At a minimum, the home must support
ReadableObjectHome interface.
Parameters: objectType - a home suitable for reading the object, but it may support other home interfaces |
getHomes | public Map getHomes()(Code) | | Map of all homes. This map will map the object type as a String to the home as a ReadableObjectHome.
The home may support more features. This can be determined by checking instanceof on other home interfaces
map of object type to home |
getHomes | public Map getHomes(Class requiredHomeType)(Code) | | Map of certain homes. This map will map the object type as a String to the home as a ReadableObjectHome.
The home may support more features. This can be determined by checking instanceof on other home interfaces.
All the homes returned will implement the requiredHomeType interface. This method can be used to get
homes that support certain features.
Parameters: requiredHomeType - interface that all returned homes will be an implementation of map of object type to home |
getWorksiteHomes | public Map getWorksiteHomes(Id worksiteId)(Code) | | Parameters: worksiteId - a map with all worksite and global homes |
getWorksiteHomes | public Map getWorksiteHomes(Id worksiteId, boolean includeHidden)(Code) | | |
handlesType | public boolean handlesType(String objectType)(Code) | | Check to see if this home factory is responsible for the passed in object type
Parameters: objectType - true if this home factory handles the specified object type |
reload | public void reload()(Code) | | forces reloading of any cached homes. Allows configuration
changes to occur at runtime.
|
|
|