|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
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();
Nested Class Summary | |
---|---|
static class |
SpacesTemplateManager.UpdateType Deprecated. This enum might be changed in future release. The usage is discouraged. |
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 |
createTemplate(java.lang.String templateName, java.lang.String templateDescription, Space baseSpace, java.util.Collection<java.lang.String> serviceCopyDataList) 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<GSMetadata> |
getTemplates(SpacesQueryOptions options, java.lang.String searchPattern, int startIndex, int batchSize) get a list of template metadata based on the jpa implementation. |
Future |
refreshTemplateCache(java.util.List<java.lang.String> templateNames, SpacesTemplateManager.UpdateType updateType, boolean syncMode, boolean cleanGSTableCache) Deprecated. |
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 createTemplate(java.lang.String templateName, java.lang.String templateDescription, Space baseSpace, java.util.Collection<java.lang.String> serviceCopyDataList) 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 uponserviceCopyDataList
- List of services whose data has to be copied from base space to templateSpacesException
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.Collection<java.lang.String> getTemplateNamesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
java.util.List<GSMetadata> getTemplates(SpacesQueryOptions options, java.lang.String searchPattern, int startIndex, int batchSize) throws SpacesException
searchPattern
- the search pattern, null or empty string can be passed in to skip the search patternstartIndex
- the starting row index in the page containing the data.batchSize
- the number of results to be returned in a single page.SpacesException
Future refreshTemplateCache(java.util.List<java.lang.String> templateNames, SpacesTemplateManager.UpdateType updateType, boolean syncMode, boolean cleanGSTableCache) throws SpacesException
templateNames
- is a list of template names. An empty list or null indicates that we need to updated all the template.updateType
- there are 3 options METADATA - updates only metadata, SECURITY - updates only security, ALL - updates both space and security.syncMode
- - true runs the project in synchronous mode. In async mode new thread will be spawned to run the update process.cleanGSTableCache
- - should be set to true only in case of app import This attribute will delete all the templates in the target instance which were not availiable in the source instance.SpacesException
- when error occurs while updating the header and detail repository.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |