oracle.webcenter.spaces.template

Class SpaceTemplate

java.lang.Object

oracle.webcenter.spaces.BaseSpace

oracle.webcenter.spaces.template.SpaceTemplate

All Implemented Interfaces:

java.io.Serializable

public abstract class SpaceTemplate
extends BaseSpace

This class is responsible for handling all spaces template related operations. This class inherits a spaces class for spaces metadata, which the template has. It inherits these classes to provide uniform place to access to MDS. It also takes care of other APIs related to spaces templates. There are APIs, which require some actions besides setting attributes in MDS; this class implements different methods to provide one uniform place to do all these operations. Each instance of this class represents one spaces template

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.webcenter.spaces.BaseSpace

baseSpaceName

Constructor Summary

Constructors

Constructor and Description
SpaceTemplate(java.lang.String templateName) Default Constructor

Method Summary

Modifier and Type	Method and Description
abstract SpaceTemplate	clone(oracle.mds.core.MDSSession session, SpaceCreationOptions option) Clone method for a spaces template.
abstract SpaceTemplate	clone(oracle.mds.core.MDSSession session, java.lang.String newTemplateName, java.lang.String newGUID, java.lang.String description, java.lang.String displayName, java.lang.String keywords, boolean closed) Clone method for a spaces template.
abstract java.lang.String	getMetadataPath() Gets the metadata path for the Group Space Template.
abstract java.lang.String	getMetadataRootDir() This API returns the root dir of the metadata
abstract java.lang.String	getScopedNameForTemplate() Get the scoped name for templates.

Methods inherited from class oracle.webcenter.spaces.BaseSpace

disableService, enableService, getClosed, getDescription, getDisplayName, getGSMetadata, getGUID, getKeywords, getMetadata, getName, getOptionalProvisionedServices, getPreferenceMetadata, getProvisionedServices, getScopeMOPath, getSecurityManager, getSecurityManager, isEnabled, provisionEnabledService, provisionService, setClosed, setDescription, setDisplayName, setKeywords, unProvisionService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpaceTemplate

public SpaceTemplate(java.lang.String templateName)

Default Constructor

Parameters:

templateName - template name

Method Detail

clone

public abstract SpaceTemplate clone(oracle.mds.core.MDSSession session,
                                    java.lang.String newTemplateName,
                                    java.lang.String newGUID,
                                    java.lang.String description,
                                    java.lang.String displayName,
                                    java.lang.String keywords,
                                    boolean closed)
                             throws SpacesException

Clone method for a spaces template. This method creates a clone of an existing spaces template into a new location and returns it as an object

Specified by:

clone in class BaseSpace

Parameters:

session - MDSSession

newTemplateName - Name of the new spaces template

newGUID - guid of the space

description - description of Group Space

displayName - of the template

keywords - The keywords for the Group Space

closed - status of the Group Space

Returns:

spacesTemplate object for a newly created template

Throws:

SpacesException

clone

public abstract SpaceTemplate clone(oracle.mds.core.MDSSession session,
                                    SpaceCreationOptions option)
                             throws SpacesException

Clone method for a spaces template. This method creates a clone of an existing spaces template into a new location and returns it as an object

Specified by:

clone in class BaseSpace

Parameters:

session - MDSSession

newSpaceName - Name of the new spaces being created

option - The SpaceCreationOptions which contains space parameters used for creating space

Returns:

spacesTemplate object for a newly created template

Throws:

SpacesException

getMetadataPath

public abstract java.lang.String getMetadataPath()

Gets the metadata path for the Group Space Template.

Specified by:

getMetadataPath in class BaseSpace

Returns:

Returns the metadata path

getMetadataRootDir

public abstract java.lang.String getMetadataRootDir()

This API returns the root dir of the metadata

Specified by:

getMetadataRootDir in class BaseSpace

Returns:

Returns the string value of the root directory

getScopedNameForTemplate

public abstract java.lang.String getScopedNameForTemplate()

Get the scoped name for templates. This should be used to get GUIDs from the scope object

Parameters:

name - Name of the template

Returns: