Skip navigation links

oracle.webcenter.spaces.template
Interface SpacesTemplateManager

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

getTemplate

SpaceTemplate getTemplate(oracle.mds.core.MDSSession session,
                          java.lang.String name)
                          throws SpacesException

Deprecated. use getTemplate(name)

This method returns a SpaceTemplate class object for a given name.

Parameters:

session - MDSSession

name - Name of the template to be instantiated

Returns:

Returns the SpaceTemplate class for a given template name

Throws:

SpacesException

getTemplate

SpaceTemplate getTemplate(java.lang.String templateName)
                          throws SpacesException

Throws:

SpacesException

createTemplate

SpaceTemplate createTemplate(java.lang.String templateName,
                             java.lang.String templateDescription,
                             Space baseSpace)
                             throws SpacesException,
                                    oracle.webcenter.webcenterapp.security.WCSecurityException

This API creates a new template from an existing Space object. This class automatically creates the metadata for a Template, copies the Space metadata in it and returns the instance of it

Parameters:

templateName - Name of the template to be created

templateDescription - Description of the new template

baseSpace - Space on which the template would be based upon

Returns:

SpaceTemplate object for a new template created

Throws:

SpacesException

oracle.webcenter.webcenterapp.security.WCSecurityException

deleteTemplate

SpaceTemplate deleteTemplate(SpaceTemplate template)
                             throws SpacesException,
                                    oracle.webcenter.webcenterapp.security.WCSecurityException

This API deletes the given Space template metadata from MDS. It also removes entries for Space template metadata customizations, preferences, security metatadata etc.

Parameters:

template - Space template to be deleted

Returns:

SpaceTemplate that is deleted

Throws:

SpacesException

oracle.webcenter.webcenterapp.security.WCSecurityException

getTemplates

java.util.List<SpaceTemplate> getTemplates(oracle.mds.core.MDSSession session,
                                           oracle.mds.query.Condition queryCondition)
                                           throws SpacesException

This API returns all the available template names. This API searches for all templates available in template metadata directory and it passes the root element of the XML and returns back the String array of templates

Parameters:

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 - MDSSession

Returns:

List of String containing name of templates

Throws:

SpacesException

getTemplatesList

java.util.List<SpaceTemplate> getTemplatesList(java.lang.String namePattern)
                                               throws SpacesException

get the list of Template Basic Objects. These objects are from joc and have the bare minimum information about the template. ######### IMPORTANT ######### This is a place holder for now and is the first version of our move towards the new caching stratergy. This is not a supported API until this comment is taken off and we have implemented and tested this completly.

Parameters:

namePattern - to filter on. if null everything is returned.

Returns:

List of Space objects on which the currrent user has access.

Throws:

SpacesException

getTemplateNamesList

java.util.Collection<java.lang.String> getTemplateNamesList(java.lang.String namePattern)
                                                            throws SpacesException

get the global list of template names. ######### IMPORTANT ######### This is a place holder for now and is the first version of our move towards the new caching stratergy. This is not a supported API until this comment is taken off and we have implemented and tested this completly.

Parameters:

namePattern - to filter on. if null everything is returned.

Returns:

List of Space objects on which the currrent user has access.

Throws:

SpacesException

Skip navigation links