Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-04


oracle.webcenter.spaces
Class Space

java.lang.Object
  extended by oracle.webcenter.spaces.BaseSpace
      extended by 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)
          Add the newly created custom attributes for a space in metadata
abstract  void addListener(oracle.webcenter.spaces.GroupSpaceListener listener)
          Add space event listener
abstract  Space clone(oracle.mds.core.MDSSession session, SpaceCreationOptions option)
          Clone method for a Space.
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)
          Deprecated. use clone(MDSSession session, String newSpaceName, SpaceCreationOptions option)
abstract  void createTags(java.lang.String tagwords, java.lang.String username, boolean shared)
          Create tags
abstract  void deleteCustomAttribute(java.lang.String name)
          Delete a custom attributes for a space from the metadata
abstract  void editCustomAttribute(java.lang.String name, java.lang.String value)
          Edit a custom attributes for a space from the metadata
abstract  java.lang.String getAddMemberWelcomeMessage()
          Get the add member welcome message for a given space
abstract  java.util.List<Space> getChildren()
          Returns all the child space objects for this space.
abstract  java.util.List getCustomAttribute()
          API List all the custom attributes set for the space
abstract  java.lang.String getInviteMemberWelcomeMessage()
          Get the invite member welcome message for a given space
abstract  java.lang.String getInviteNonMemberWelcomeMessage()
          Get the invite nonmember welcome message for a given space
abstract  MutableSpaceMetadata getMetadataForUpdate()
          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()
          Returns the root dir of the metadata
abstract  Space getParent()
          Returns the parent space object for this space.
abstract  java.util.List<oracle.webcenter.framework.service.Service> getProvisionedServices()
          provision a particular service for the specified scope.
abstract  Space getRootAncestor()
          Returns the root ancestor space object for this space.
abstract  Space getSecurityParent()
          Returns the parent space object that contains the security information for this child space.
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  oracle.webcenter.webcenterapp.languagesupport.beans.WCLanguagesMetadata getSupportedLanguagesMetadata(oracle.mds.core.MDSSession session, boolean readOnly)
          This method returns the supported languages metadata for this space.
abstract  java.lang.String getTagWords()
          Get the tags
abstract  java.lang.String getUserVisibleTagWords()
          Get the tags for a particular resource
abstract  void removeListener(oracle.webcenter.spaces.GroupSpaceListener listener)
          Remove space event listener
abstract  void setAddMemberWelcomeMessage(java.lang.String welcomeMessage)
          Set the add member welcome message for a given Group Space
abstract  void setInheritFromParent(boolean value)
          Sets the inheritance flag for this space object.
abstract  void setInviteMemberWelcomeMessage(java.lang.String welcomeMessage)
          Set the invite member welcome message for a given Group Space
abstract  void setInviteNonMemberWelcomeMessage(java.lang.String welcomeMessage)
          Set the invite nonmember welcome message for a given Group Space
abstract  void setParent(Space parentSpace)
           

 

Methods inherited from class oracle.webcenter.spaces.BaseSpace
getClosed, getDescription, getDisplayName, getGSMetadata, getGUID, getKeywords, getMetadata, getName, getOptionalProvisionedServices, getPreferenceMetadata, getScopeMOPath, getSecurityManager, getSecurityManager, 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

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

EL: #{spaceContext.space[spaceName].metadataPath}
#{spaceContext.currentSpace.metadataPath}

Specified by:
getMetadataPath in class BaseSpace
Returns:
Returns a string [metadata path]

getMetadataRootDir

public abstract java.lang.String getMetadataRootDir()
Returns the root dir of the metadata

EL: #{spaceContext.space[spaceName].metadataRootDir}
#{spaceContext.currentSpace.metadataRootDir}

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

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
Deprecated. use clone(MDSSession session, String newSpaceName, SpaceCreationOptions option)
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

clone

public abstract Space clone(oracle.mds.core.MDSSession session,
                            SpaceCreationOptions option)
                     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
option - The SpaceCreationOptions which contains space parameters used for creating 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
Set 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
Get the add member welcome message for a given space
Returns:
The welcome message
Throws:
SpacesException - if getter fails to read the message

getInviteMemberWelcomeMessage

public abstract java.lang.String getInviteMemberWelcomeMessage()
                                                        throws SpacesException
Get the invite member welcome message for a given space
Returns:
The welcome message
Throws:
SpacesException - if getter fails to read the message

getInviteNonMemberWelcomeMessage

public abstract java.lang.String getInviteNonMemberWelcomeMessage()
                                                           throws SpacesException
Get the invite nonmember welcome message for a given 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
Set 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
Set 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
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
Add the newly created custom attributes for a 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
Delete a custom attributes for a 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
Edit a custom attributes for a 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
API List all the custom attributes set for the 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
Create 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
Get the tags for a particular resource
Returns:
String of space-separated tags
Throws:
TaggingException
SpacesException

getTagWords

public abstract java.lang.String getTagWords()
                                      throws SpacesException
Get the tags
Returns:
String of tags
Throws:
SpacesException

getProvisionedServices

public abstract java.util.List<oracle.webcenter.framework.service.Service> getProvisionedServices()
                                                                                           throws SpacesException
provision a particular service for the specified scope.
Specified by:
getProvisionedServices in class BaseSpace
Returns:
List of Service which are provisioned for this Space
Throws:
SpacesException

getChildren

public abstract java.util.List<Space> getChildren()
                                           throws SpacesException
Returns all the child space objects for this space.

EL: #{spaceContext.space[spaceName].children}
#{spaceContext.currentSpace.children}

Returns:
- a list of child space objects for this space object.
Throws:
SpacesException - - if any error encountered.

getParent

public abstract Space getParent()
                         throws SpacesException
Returns the parent space object for this space.

EL: #{spaceContext.space[spaceName].parent}
#{spaceContext.currentSpace.parent}

Returns:
- the parent space object if present, null otherwise.
Throws:
SpacesException - - if any error encountered.

getRootAncestor

public abstract Space getRootAncestor()
                               throws SpacesException
Returns the root ancestor space object for this space.

EL: #{spaceContext.space[spaceName].rootAncestor}
#{spaceContext.currentSpace.rootAncestor}

Returns:
- the root space object.
Throws:
SpacesException - - if any error encountered.

getSecurityParent

public abstract Space getSecurityParent()
                                 throws SpacesException
Returns the parent space object that contains the security information for this child space.

EL: #{spaceContext.space[spaceName].securityParent}
#{spaceContext.currentSpace.securityParent}

Returns:
- the security parent for this space object if found, null otherwise.
Throws:
SpacesException - - if any error encountered.

setInheritFromParent

public abstract void setInheritFromParent(boolean value)
                                   throws SpacesException
Sets the inheritance flag for this space object. A space object can inherit the security information from its security parent or it can have it's own security settings. A space object can have its own security settings even if it is part of a space hierarhy. If the space inherits the security from its parent, and this method is called with argument false, then the all the security information from the current security parent is copied into this child space object.
Parameters:
value - - if true, indicates to inherit security from parent, if false, the space will have its own security settings.
Throws:
SpacesException - - if any error encountered.

setParent

public abstract void setParent(Space parentSpace)
                        throws SpacesException
Throws:
SpacesException

addListener

public abstract void addListener(oracle.webcenter.spaces.GroupSpaceListener listener)
Add space event listener
Parameters:
listener - the gs s listener

removeListener

public abstract void removeListener(oracle.webcenter.spaces.GroupSpaceListener listener)
Remove space event listener
Parameters:
listener - the page service listener

getSupportedLanguagesMetadata

public abstract oracle.webcenter.webcenterapp.languagesupport.beans.WCLanguagesMetadata getSupportedLanguagesMetadata(oracle.mds.core.MDSSession session,
                                                                                                                      boolean readOnly)
                                                                                                               throws SpacesException
This method returns the supported languages metadata for this space. A MutableMO is returned if readOnly is false. Otherwise, the object will be readOnly.
Parameters:
session - - A MDSSession object
readOnly - - A boolean to indicate whether the returned MO is readOnly or not
Returns:
WCLanguagesMetadata - the Language Metadata object for this space
Throws:
SpacesException - - in case of any error

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-04


Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved.