|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SpacesTemplateManager
Spaces Template Manager Class is a manager class responsible for managing all SpaceTemplate
objects. It also acts as a frontend for all the external applications which try to get access to SpaceTemplate
. All the access to the SpaceTemplate
class should be made through getSpaceTemplate() method of this class. Space Templates can be created/deleted/modified using the APIs provided by this class. It also provides different sorts of querying mechanism for calling APIs to get the appropriate list of SpaceTemplate
objects. One should always get the SpacesTemplateManager
from SpacesTemplateManagerFactory
.
The following code snippet depicts how one can get hold of SpacesManager:
SpacesTemplateManagerFactory fact = FactoryFinder.getFactory(SpacesTemplateManagerFactory.class.getCanonicalName());
SpacesTemplateManager manager = fact.getSpacesTemplateManager();
Method Summary | |
---|---|
SpaceTemplate |
createTemplate(java.lang.String templateName, java.lang.String templateDescription, Space baseSpace) This API creates a new template from an existing Space object. |
SpaceTemplate |
deleteTemplate(SpaceTemplate template) This API deletes the given Space template metadata from MDS. |
SpaceTemplate |
getTemplate(oracle.mds.core.MDSSession session, java.lang.String name) Deprecated. use getTemplate(name) |
SpaceTemplate |
getTemplate(java.lang.String templateName) |
java.util.Collection<java.lang.String> |
getTemplateNamesList(java.lang.String namePattern) get the global list of template names. |
java.util.List<SpaceTemplate> |
getTemplates(oracle.mds.core.MDSSession session, oracle.mds.query.Condition queryCondition) This API returns all the available template names. |
java.util.List<SpaceTemplate> |
getTemplatesList(java.lang.String namePattern) get the list of Template Basic Objects. |
Method Detail |
---|
SpaceTemplate getTemplate(oracle.mds.core.MDSSession session, java.lang.String name) throws SpacesException
session
- MDSSessionname
- Name of the template to be instantiatedSpacesException
SpaceTemplate getTemplate(java.lang.String templateName) throws SpacesException
SpacesException
SpaceTemplate createTemplate(java.lang.String templateName, java.lang.String templateDescription, Space baseSpace) throws SpacesException, oracle.webcenter.webcenterapp.security.WCSecurityException
templateName
- Name of the template to be createdtemplateDescription
- Description of the new templatebaseSpace
- Space on which the template would be based uponSpacesException
oracle.webcenter.webcenterapp.security.WCSecurityException
SpaceTemplate deleteTemplate(SpaceTemplate template) throws SpacesException, oracle.webcenter.webcenterapp.security.WCSecurityException
template
- Space template to be deletedSpacesException
oracle.webcenter.webcenterapp.security.WCSecurityException
java.util.List<SpaceTemplate> getTemplates(oracle.mds.core.MDSSession session, oracle.mds.query.Condition queryCondition) throws SpacesException
queryCondition
- Search pattern that would match the names of the spaces that are to be returned by this method. null
or empty string if this method should not perform any search but simply return the 'visible' spaces.session
- MDSSessionSpacesException
java.util.List<SpaceTemplate> getTemplatesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
java.util.Collection<java.lang.String> getTemplateNamesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |