|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SpacesManager
Spaces Manager Class is a manager class responsible for managing all Space
objects. It also acts as a frontend for all the external applications which try to get access to Space
. All the access to the Space
class should be made through getSpace() method of this class. Spaces can be created/deleted/modified using the APIs provided by this class. It also provides different sorts of querying mechanism for calling APIs to get the appropriate list of Space
objects. One should always get the SpacesManager
from SpacesManagerFactory
.
The following code snippet depicts how one can get hold of SpacesManager:
SpacesManagerFactory fact = FactoryFinder.getFactory(SpacesManagerFactory.class.getCanonicalName());
SpacesManager manager = fact.getSpacesManager();
Nested Class Summary | |
---|---|
static class |
SpacesManager.UpdateType In the refresh API we can use this to either update METADATA, security or both metadata and security |
Method Summary | |
---|---|
Space |
createGroupSpace(java.lang.String spaceName, Space parentSpace, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) Create API creates a new Space object from an existing Space template. |
Space |
createGroupSpace(java.lang.String spaceName, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) Create API creates a new Space object from an existing Space template. |
Space |
deleteGroupSpace(Space space) This API deletes the given Spaces metadata from MDS. |
java.util.List<java.lang.String> |
getPublicSpacesNamesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters) |
Space |
getSpace(oracle.mds.core.MDSSession session, java.lang.String name) Deprecated. use getSpace(name) |
Space |
getSpace(java.lang.String name) This API returns Space class object for a given name of the Space. |
Space |
getSpaceByScopeGUID(java.lang.String GUID) This API returns the Space object given its GUID |
Space |
getSpaceFromDisplayName(java.lang.String displayName) This API returns the Space object given its displayName |
java.util.List<Space> |
getSpaces(oracle.mds.query.Condition queryCondition, boolean subscribedOnly) Deprecated. use getSpaces(SpacesQueryParameters) |
java.util.List<Space> |
getSpaces(oracle.mds.core.MDSSession session, oracle.mds.query.Condition queryCondition, boolean subscribedOnly) Deprecated. use getSpaces(SpacesQueryParameters) |
java.util.List<GSMetadata> |
getSpaces(SpacesQueryOptions sqo) Deprecated. use getSpaces(SpacesQueryParameters) |
java.util.List<GSMetadata> |
getSpaces(SpacesQueryParameters sq) Evaluates a spaces query and returns a list of space metadata objects based on the result. |
java.util.List<Space> |
getSpacesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters) |
java.util.List<java.lang.String> |
getUserSpacesNamesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters) |
Future |
refreshGroupSpaceCache(java.util.List<java.lang.String> spaceNames, SpacesManager.UpdateType updateType, boolean syncMode, boolean cleanGSTableCache) Deprecated. |
void |
renameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName) This API changes the name of the existing space to a new name |
Method Detail |
---|
Space getSpace(java.lang.String name) throws SpacesException
session
- MDSSessionname
- : name of the SpaceSpacesException
- Throws SpacesException if @[link Space} with given name is not foundSpace getSpace(oracle.mds.core.MDSSession session, java.lang.String name) throws SpacesException
session
- MDSSessionname
- : name of the SpaceSpacesException
- Throws SpacesException if @[link Space} with given name is not foundSpace createGroupSpace(java.lang.String spaceName, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) throws SpacesException
spaceName
- The Name of the new Group SpacebaseTemplate
- Template on which the space should be based uponcustomAttributes
- Attribute map for custom attributes (name,value) pairsSpacesException
- Throws Exception if the API can not create a new Space based on given Space Template, or SpaceTemplate is not foundSpace createGroupSpace(java.lang.String spaceName, Space parentSpace, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) throws SpacesException
spaceName
- The Name of the new Group SpaceparentSpace
- - the parent group space of the space being created.baseTemplate
- Template on which the space should be based uponcustomAttributes
- Attribute map for custom attributes (name,value) pairsSpacesException
- Throws Exception if the API can not create a new Space based on given Space Template, or SpaceTemplate is not foundSpace deleteGroupSpace(Space space) throws SpacesException
space
- Space
object to be deletedSpacesException
- Throws Exception if given Space object is not found or it does not existjava.util.List<Space> getSpaces(oracle.mds.core.MDSSession session, oracle.mds.query.Condition queryCondition, boolean subscribedOnly) throws SpacesException
session
- MDS session based on which to retrieve the data.subscribedOnly
- true
if only the spaces that the user is member of are to be returned, false
if the union of spaces the user is member of and the set of discoverable spaces are to be returned.queryCondition
- Search pattern that would match the names of the spaces that are to be returned by this method. null
or empty string if this method should not perform any search but simply return the 'visible' spaces.SpacesException
- If there is a problem fetching metadata.java.util.List<Space> getSpaces(oracle.mds.query.Condition queryCondition, boolean subscribedOnly) throws SpacesException
Here 'visible' would mean either just the spaces that the user is subscribed to, or the subscribed spaces together with the spaces that are discoverable, depending upon the argument subscribedOnly
. If subscribedOnly
is true
this method will return just the spaces the user is subscribed to, otherwise it will return the union of these and the discoverable spaces metadata.
Thsi API determines the userName
from the context. If userName
is null
this method would assume it to be referring to the anonymous user. For example, userName
of null
and subscribedOnly
false
would return the list of discoverable spaces (because anonymous user would not be a member of any Space)
subscribedOnly
- true
if only the spaces that the user is member of are to be returned, false
if the union of spaces the user is member of and the set of discoverable spaces are to be returned.queryCondition
- Search pattern that would match the names of the spaces that are to be returned by this method. null
or empty string if this method should not perform any search but simply return the 'visible' spaces.SpacesException
- If there is a problem fetching metadata.java.util.List<Space> getSpacesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
java.util.List<java.lang.String> getPublicSpacesNamesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
java.util.List<java.lang.String> getUserSpacesNamesList(java.lang.String namePattern) throws SpacesException
namePattern
- to filter on. if null everything is returned.SpacesException
void renameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName) throws SpacesException
oldSpaceName
- Old Space NamenewSpaceName
- New Space NameSpacesException
java.util.List<GSMetadata> getSpaces(SpacesQueryOptions sqo) throws SpacesException
sqo
- space query object. results will be returned based on the space query object. this drives the where clause.searchPattern
- the search pattern, null or empty string can be passed in to skip the search patternstartIndex
-batchSize
-SpacesException
java.util.List<GSMetadata> getSpaces(SpacesQueryParameters sq) throws SpacesException
sq
- Spaces query to be evaluated.SpacesException
- If any problem occurs while querying or retrieving the space metadata.#createSpacesQuery
Space getSpaceFromDisplayName(java.lang.String displayName) throws SpacesException
displayName
- Gs displayNameSpacesException
Future refreshGroupSpaceCache(java.util.List<java.lang.String> spaceNames, SpacesManager.UpdateType updateType, boolean syncMode, boolean cleanGSTableCache) throws SpacesException
spaceNames
- is a list of group space names. An empty list or null indicates that we need to updated all the group space.updateType
- there are 3 options METADATA - updates only metadata, SECURITY - updates only security, ALL - updates both space and security.syncMode
- - true runs the project in synchronous mode. In async mode new thread will be spawned to run the update process.cleanGSTableCache
- - should be set to true only in case of app import This attribute will delete all those group spaces in the target instance which were not availiable in the source instance.SpacesException
- when error occurs while updating the header and detail repository.Space getSpaceByScopeGUID(java.lang.String GUID) throws SpacesException
displayName
- GUID the GUIDSpacesException
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |