|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.spaces.BaseSpace
oracle.webcenter.spaces.Space
public abstract class Space
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");
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 |
---|
public Space(java.lang.String spaceName)
Method Detail |
---|
public abstract java.lang.String getMetadataPath()
getMetadataPath
in class BaseSpace
public abstract java.lang.String getMetadataRootDir()
getMetadataRootDir
in class BaseSpace
public abstract oracle.webcenter.webcenterapp.serviceusages.beans.ServiceConfig getServiceConfigMetadata(oracle.mds.core.MDSSession session, boolean readOnly) throws oracle.webcenter.webcenterapp.WebCenterException
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.session
- MDSSession on which it should get the metadatareadOnly
- Whether a read-only or updatable metadata is required.oracle.webcenter.webcenterapp.WebCenterException
public abstract void unProvisionService(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(Service service) throws SpacesException
service
-SpacesException
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
in class BaseSpace
session
- MDSSession on which clone should operate uponnewSpaceName
- Name of the new SpacenewSpaceGUID
- GUID of the new Spacedescription
- description of the Group SpacedisplayName
- DisplayName of the Group Spacekeywords
- keywords for the Group Spaceclosed
- status for the Group SpaceSpacesException
- Throws SpacesException if a clone for a given Space can not be createdpublic abstract void setAddMemberWelcomeMessage(java.lang.String welcomeMessage) throws SpacesException
welcomeMessage
-SpacesException
- if setting the message failspublic abstract java.lang.String getAddMemberWelcomeMessage() throws SpacesException
SpacesException
- if getter fails to read the messagepublic abstract java.lang.String getInviteMemberWelcomeMessage() throws SpacesException
SpacesException
- if getter fails to read the messagepublic abstract java.lang.String getInviteNonMemberWelcomeMessage() throws SpacesException
SpacesException
- if getter fails to read the messagepublic abstract void setInviteMemberWelcomeMessage(java.lang.String welcomeMessage) throws SpacesException
welcomeMessage
-SpacesException
- if setting the message failspublic abstract void setInviteNonMemberWelcomeMessage(java.lang.String welcomeMessage) throws SpacesException
welcomeMessage
-SpacesException
- if setting the message failspublic abstract MutableSpaceMetadata getMetadataForUpdate() throws SpacesException
SpacesException
public abstract void addCustomAttribute(java.lang.String name, java.lang.String value) throws SpacesException
name
- the name fo the custom attributevalue
- the value of the custom attributeSpacesException
public abstract void deleteCustomAttribute(java.lang.String name) throws SpacesException
name
- custom attributes name to be deletedSpacesException
public abstract void editCustomAttribute(java.lang.String name, java.lang.String value) throws SpacesException
name
- custom attributes name to be deletedvalue
- custom attributes value to be deletedSpacesException
public abstract java.util.List getCustomAttribute() throws SpacesException
SpacesException
public abstract void createTags(java.lang.String tagwords, java.lang.String username, boolean shared) throws SpacesException
tagwords
- tags that have to be created and saved to the backendusername
- name of the user who creates tagsshared
- whether the tags created are shared or notSpacesException
public abstract java.lang.String getUserVisibleTagWords() throws SpacesException
TaggingException
SpacesException
public abstract java.lang.String getTagWords() throws SpacesException
SpacesException
public java.util.List<Service> getProvisionedServices() throws SpacesException
getProvisionedServices
in class BaseSpace
Service
which are provisioned for this SpaceSpacesException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.3.0) E15995-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |