Skip navigation links

oracle.webcenter.spaces
Class Space

java.lang.Object
oracle.webcenter.spaces.BaseSpace
oracle.webcenter.spaces.Space

public abstract class Space

extends BaseSpace

This class is responsible for handling all Single space object related operations. The relationship of space object with Space class is one-to-one. This inerface provides wrapper for all different APIs operations like metadata related operations, security related operations, preferences related operations etc. This class providers a uniform place to access all sorts of sub-components for Space. This API should be accessed through SpacesManager class. Depending upon underlying implementation, different methods are supported.

Following is the sample snippet of the code:
SpacesManager manager = SpacesManagerFactory.getSpacesManager();
Space mySpace = SpacesManager.getSpace("FinanceProject");

See Also:

SpacesManagerFactory, SpacesManager

Field Summary

Fields inherited from class oracle.webcenter.spaces.BaseSpace

baseSpaceName

Constructor Summary

Space(java.lang.String spaceName)

Method Summary

abstract void	addCustomAttribute(java.lang.String name, java.lang.String value) This API adds the newly created custom attributes for a group space in metadata
abstract Space	clone(oracle.mds.core.MDSSession session, java.lang.String newSpaceName, java.lang.String newSpaceGUID, java.lang.String description, java.lang.String displayName, java.lang.String keywords, boolean closed) Clone method for a Space.
abstract void	createTags(java.lang.String tagwords, java.lang.String username, boolean shared) This API creates tags
abstract void	deleteCustomAttribute(java.lang.String name) This API deletes a custom attributes for a group space from the metadata
abstract void	editCustomAttribute(java.lang.String name, java.lang.String value) This API edits a custom attributes for a group space from the metadata
abstract java.lang.String	getAddMemberWelcomeMessage() This API gets the add member welcome message for a given group space
abstract java.util.List	getCustomAttribute() This API lists all the custom attributes set for the group space
abstract java.lang.String	getInviteMemberWelcomeMessage() This API gets the invite member welcome message for a given group space
abstract java.lang.String	getInviteNonMemberWelcomeMessage() This API gets the invite nonmember welcome message for a given group space
abstract MutableSpaceMetadata	getMetadataForUpdate() This API returns a wrapper to the SpaceMetadata Bean which can be updated and also provides an option to commit the changes made to the SpaceMetadata Bean
abstract java.lang.String	getMetadataPath() Gets the metadata path for a given space MDS instance
abstract java.lang.String	getMetadataRootDir() This API returns the root dir of the metadata
java.util.List<Service>	getProvisionedServices() provision a particular service for the specified scope.
abstract oracle.webcenter.webcenterapp.serviceusages.beans.ServiceConfig	getServiceConfigMetadata(oracle.mds.core.MDSSession session, boolean readOnly) Return the mutable ServiceConfig metadata for a given Space object.
abstract java.lang.String	getTagWords() This API gets the tags
abstract java.lang.String	getUserVisibleTagWords() This API gets the tags for a particular resource
abstract void	provisionService(Service service) provision a particular service for the specified scope.
abstract void	setAddMemberWelcomeMessage(java.lang.String welcomeMessage) This API sets the add member welcome message for a given Group Space
abstract void	setInviteMemberWelcomeMessage(java.lang.String welcomeMessage) This API sets the invite member welcome message for a given Group Space
abstract void	setInviteNonMemberWelcomeMessage(java.lang.String welcomeMessage) This API sets the invite nonmember welcome message for a given Group Space
abstract void	unProvisionService(Service service) Un-provision a particular service for the Space.

Methods inherited from class oracle.webcenter.spaces.BaseSpace

getClosed, getDescription, getDisplayName, getGSMetadata, getGUID, getKeywords, getMetadata, getName, getPreferenceMetadata, getScopeMOPath, getSecurityManager, getSecurityManager, setClosed, setDescription, setDisplayName, setKeywords

Methods inherited from class java.lang.Object

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

Constructor Detail

Space

public Space(java.lang.String spaceName)

Method Detail

getMetadataPath

public abstract java.lang.String getMetadataPath()

Gets the metadata path for a given space MDS instance

Specified by:

getMetadataPath in class BaseSpace

Returns:

Returns a string [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 root directory string path of the metadata

getServiceConfigMetadata

public abstract oracle.webcenter.webcenterapp.serviceusages.beans.ServiceConfig getServiceConfigMetadata(oracle.mds.core.MDSSession session,
                                                                                                         boolean readOnly)
                                                                                                  throws oracle.webcenter.webcenterapp.WebCenterException

Return the mutable ServiceConfig metadata for a given Space object. If the service config metadata does not exist for this Space, the WebCenter app's metadata will be returned.

Parameters:

session - MDSSession on which it should get the metadata

readOnly - Whether a read-only or updatable metadata is required.

Returns:

ServiceConfig metadata for the Space Object or the WebCenter app's metadata if such metadata does not exist for this Space.

Throws:

oracle.webcenter.webcenterapp.WebCenterException

unProvisionService

public abstract void unProvisionService(Service service)
                                 throws SpacesException

Un-provision a particular service for the Space. Unprovisioning a service would remove the service from given Space

Parameters:

service - Service object to be removed from the Space

Throws:

CommandException - Throws CommandException if service to be unprovisioned can't be unprovisioned

SpacesException - when any unexpected error happens

provisionService

public abstract void provisionService(Service service)
                               throws SpacesException

provision a particular service for the specified scope.

Parameters:

service -

Throws:

SpacesException

clone

public abstract Space clone(oracle.mds.core.MDSSession session,
                            java.lang.String newSpaceName,
                            java.lang.String newSpaceGUID,
                            java.lang.String description,
                            java.lang.String displayName,
                            java.lang.String keywords,
                            boolean closed)
                     throws SpacesException

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

Specified by:

clone in class BaseSpace

Parameters:

session - MDSSession on which clone should operate upon

newSpaceName - Name of the new Space

newSpaceGUID - GUID of the new Space

description - description of the Group Space

displayName - DisplayName of the Group Space

keywords - keywords for the Group Space

closed - status for the Group Space

Returns:

The Space class for newly cloned space

Throws:

SpacesException - Throws SpacesException if a clone for a given Space can not be created

setAddMemberWelcomeMessage

public abstract void setAddMemberWelcomeMessage(java.lang.String welcomeMessage)
                                         throws SpacesException

This API sets the add member welcome message for a given Group Space

Parameters:

welcomeMessage -

Throws:

SpacesException - if setting the message fails

getAddMemberWelcomeMessage

public abstract java.lang.String getAddMemberWelcomeMessage()
                                                     throws SpacesException

This API gets the add member welcome message for a given group space

Returns:

The welcome message

Throws:

SpacesException - if getter fails to read the message

getInviteMemberWelcomeMessage

public abstract java.lang.String getInviteMemberWelcomeMessage()
                                                        throws SpacesException

This API gets the invite member welcome message for a given group space

Returns:

The welcome message

Throws:

SpacesException - if getter fails to read the message

getInviteNonMemberWelcomeMessage

public abstract java.lang.String getInviteNonMemberWelcomeMessage()
                                                           throws SpacesException

This API gets the invite nonmember welcome message for a given group space

Returns:

The welcome message

Throws:

SpacesException - if getter fails to read the message

setInviteMemberWelcomeMessage

public abstract void setInviteMemberWelcomeMessage(java.lang.String welcomeMessage)
                                            throws SpacesException

This API sets the invite member welcome message for a given Group Space

Parameters:

welcomeMessage -

Throws:

SpacesException - if setting the message fails

setInviteNonMemberWelcomeMessage

public abstract void setInviteNonMemberWelcomeMessage(java.lang.String welcomeMessage)
                                               throws SpacesException

This API sets the invite nonmember welcome message for a given Group Space

Parameters:

welcomeMessage -

Throws:

SpacesException - if setting the message fails

getMetadataForUpdate

public abstract MutableSpaceMetadata getMetadataForUpdate()
                                                   throws SpacesException

This API returns a wrapper to the SpaceMetadata Bean which can be updated and also provides an option to commit the changes made to the SpaceMetadata Bean

Throws:

SpacesException

addCustomAttribute

public abstract void addCustomAttribute(java.lang.String name,
                                        java.lang.String value)
                                 throws SpacesException

This API adds the newly created custom attributes for a group space in metadata

Parameters:

name - the name fo the custom attribute

value - the value of the custom attribute

Throws:

SpacesException

deleteCustomAttribute

public abstract void deleteCustomAttribute(java.lang.String name)
                                    throws SpacesException

This API deletes a custom attributes for a group space from the metadata

Parameters:

name - custom attributes name to be deleted

Throws:

SpacesException

editCustomAttribute

public abstract void editCustomAttribute(java.lang.String name,
                                         java.lang.String value)
                                  throws SpacesException

This API edits a custom attributes for a group space from the metadata

Parameters:

name - custom attributes name to be deleted

value - custom attributes value to be deleted

Throws:

SpacesException

getCustomAttribute

public abstract java.util.List getCustomAttribute()
                                           throws SpacesException

This API lists all the custom attributes set for the group space

Returns:

List of custom attributes

Throws:

SpacesException

createTags

public abstract void createTags(java.lang.String tagwords,
                                java.lang.String username,
                                boolean shared)
                         throws SpacesException

This API creates tags

Parameters:

tagwords - tags that have to be created and saved to the backend

username - name of the user who creates tags

shared - whether the tags created are shared or not

Throws:

SpacesException

getUserVisibleTagWords

public abstract java.lang.String getUserVisibleTagWords()
                                                 throws SpacesException

This API gets the tags for a particular resource

Returns:

String of space-separated tags

Throws:

TaggingException

SpacesException

getTagWords

public abstract java.lang.String getTagWords()
                                      throws SpacesException

This API gets the tags

Returns:

String of tags

Throws:

SpacesException

getProvisionedServices

public java.util.List<Service> getProvisionedServices()
                                               throws SpacesException

provision a particular service for the specified scope.

Overrides:

getProvisionedServices in class BaseSpace

Returns:

List of Service which are provisioned for this Space

Throws:

SpacesException

Skip navigation links