|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.spaces.BaseSpace
public abstract class BaseSpace
This class is a base class for all group spaces and all group space templates. It offers common framework for space/template and the methods that can be used across multiple extending classes
Field Summary | |
---|---|
protected java.lang.String |
baseSpaceName |
Constructor Summary | |
---|---|
BaseSpace(java.lang.String baseSpaceName) Default Constructor |
Method Summary | |
---|---|
abstract BaseSpace |
clone(oracle.mds.core.MDSSession session, SpaceCreationOptions option) Clone method for a Space. |
abstract BaseSpace |
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 the new API clone(MDSSession session, String newSpaceName, SpaceCreationOptions option) |
abstract boolean |
getClosed() This method returns the closed status of the group space |
abstract java.lang.String |
getDescription() This method returns the description of the Group Space |
abstract java.lang.String |
getDisplayName() This method returns the displayName of the Group Space |
abstract GSMetadata |
getGSMetadata() This method returns the GSMetadata that contains limited details of the space object |
abstract java.lang.String |
getGUID(oracle.mds.core.MDSSession session) This API gets the GUID [globally unique identifier] for a given Space. |
abstract java.lang.String |
getKeywords() This method returns the keywords for the Group Space |
abstract oracle.webcenter.spaces.beans.SpaceMetadata |
getMetadata(oracle.mds.core.MDSSession session, boolean readOnly) This method is responsible for getting the mutable/immutable SpaceMetadata object for a given Space Object. |
abstract java.lang.String |
getMetadataPath() This API returns the MetadataPath |
abstract java.lang.String |
getMetadataRootDir() This API returns the metadataRootDir |
abstract java.lang.String |
getName(oracle.mds.core.MDSSession session) This API gets the name of the Space object from MDS metadata |
abstract java.util.List<java.lang.String> |
getOptionalProvisionedServices() This API returns the list of optional services provisioned for that scope |
abstract oracle.webcenter.spaces.beans.SpacePreferencesMetadata |
getPreferenceMetadata(oracle.mds.core.MDSSession session, boolean readOnly) This method is responsible for getting the mutable SpacePreferencesMetadata object for a given Spaces. |
abstract java.util.List<oracle.webcenter.framework.service.Service> |
getProvisionedServices() provision a particular service for the specified scope. |
protected static java.lang.String |
getScopeMOPath(java.lang.String scope) |
abstract oracle.webcenter.webcenterapp.security.WCSecurityManager |
getSecurityManager() This API instantiates Security metadata for a given Space and returns the instance. |
abstract oracle.webcenter.webcenterapp.security.WCSecurityManager |
getSecurityManager(oracle.security.jps.service.policystore.PolicyStore policyStore) This API instantiates Security metadata for a given Space and returns the instance. |
abstract void |
provisionService(oracle.webcenter.framework.service.Service service) provision a particular service for the specified scope. |
abstract void |
setClosed(boolean closed) This method sets whether the Group Space is closed |
abstract void |
setDescription(java.lang.String description) This method returns the description of the Group Space |
abstract void |
setDisplayName(java.lang.String displayName) This method sets the displayName of Group Space |
abstract void |
setKeywords(java.lang.String keywords) This method sets the keywords for Group Space |
abstract void |
unProvisionService(oracle.webcenter.framework.service.Service service) Un-provision a particular service for the Space. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String baseSpaceName
Constructor Detail |
---|
public BaseSpace(java.lang.String baseSpaceName)
Method Detail |
---|
public abstract java.lang.String getName(oracle.mds.core.MDSSession session) throws SpacesException
session
- MDSSession on which it should get the metadataSpacesException
- Throws SpacesException if the metadata for given Space is not foundpublic abstract java.lang.String getGUID(oracle.mds.core.MDSSession session) throws SpacesException
session
- MDSSession on which it should get the metadataSpacesException
- Throws SpacesException if the GUID metadata for given Space is not foundpublic abstract oracle.webcenter.spaces.beans.SpaceMetadata getMetadata(oracle.mds.core.MDSSession session, boolean readOnly) throws SpacesException
SpaceMetadata
object for a given Space Object. Depending upon the requirement, this API either returns read only metadata or writable metadata.session
- MDSSession on which it should get the metadatareadOnly
- Returns readOnly metadata or writable metadata depending upon the flag value. When false, returns writable metadataSpacesException
- Throws SpacesException if the metadata for given Space is not foundpublic abstract oracle.webcenter.spaces.beans.SpacePreferencesMetadata getPreferenceMetadata(oracle.mds.core.MDSSession session, boolean readOnly) throws SpacesException
session
- MDSSession on which it should get the metadatareadOnly
- Returns readOnly metadata or writable metadata depending upon the flag valueSpacesException
- Throws SpacesException if the metadata for given Space is not foundpublic abstract oracle.webcenter.webcenterapp.security.WCSecurityManager getSecurityManager(oracle.security.jps.service.policystore.PolicyStore policyStore) throws SpacesException, oracle.webcenter.webcenterapp.security.WCSecurityException
policyStore
- Policy Store instanceSpacesException
- if Security manager can not be instantiated for this Spaceoracle.webcenter.webcenterapp.security.WCSecurityException
public abstract oracle.webcenter.webcenterapp.security.WCSecurityManager getSecurityManager() throws SpacesException, oracle.webcenter.webcenterapp.security.WCSecurityException
SpacesException
- if Security manager can not be instantiated for this Spaceoracle.webcenter.webcenterapp.security.WCSecurityException
public abstract BaseSpace 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
session
- MDSSession on which clone should operate uponnewSpaceName
- Name of the new SpacenewSpaceGUID
- GUID of the new Spacedescription
- The description of the Group SpacedisplayName
- The display name of the Group Spacekeywords
- The keywords for the Group Spaceclosed
- status of the Group SpaceSpacesException
- Throws SpacesException if a clone for a given Space can not be createdpublic abstract BaseSpace clone(oracle.mds.core.MDSSession session, SpaceCreationOptions option) throws SpacesException
session
- MDSSession on which clone should operate uponoption
- The SpaceCreationOptions which contains space parameters used for creating spaceSpacesException
- Throws SpacesException if a clone for a given Space can not be createdpublic abstract java.lang.String getMetadataRootDir()
public abstract java.lang.String getMetadataPath()
public abstract void setDisplayName(java.lang.String displayName)
displayName
-public abstract java.lang.String getDisplayName()
public abstract void setKeywords(java.lang.String keywords)
keywords
-public abstract java.lang.String getKeywords()
public abstract void setClosed(boolean closed)
closed
-public abstract boolean getClosed()
public abstract void setDescription(java.lang.String description)
description
-public abstract java.lang.String getDescription()
public abstract java.util.List<java.lang.String> getOptionalProvisionedServices()
public abstract java.util.List<oracle.webcenter.framework.service.Service> getProvisionedServices() throws SpacesException
Service
which are provisioned for this SpaceSpacesException
protected static java.lang.String getScopeMOPath(java.lang.String scope)
public abstract GSMetadata getGSMetadata() throws SpacesException
SpacesException
public abstract void unProvisionService(oracle.webcenter.framework.service.Service service) throws SpacesException
service
- Service object to be removed from the SpaceCommandException
- Throws CommandException if service to be unprovisioned can't be unprovisionedSpacesException
- when any unexpected error happenspublic abstract void provisionService(oracle.webcenter.framework.service.Service service) throws SpacesException
service
-SpacesException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.6.0) E15995-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |