oracle.webcenter.spaces
Interface SpacesManager

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

createGroupSpace

Create API creates a new Space object from an existing Space template. It calls the template's clone method to get the clone of the template and then constructs the Space Object out of it. It automatcally creates the MDS location for given Space name.

Create API creates a new Space object from an existing Space template. It calls the template's clone method to get the clone of the template and then constructs the Space Object out of it. It automatcally creates the MDS location for given Space name.

This method returns the names of spaces matching the specified search pattern, searching among the spaces that are 'visible' to the specified user.

Parameters:

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.

Returns:

list of spaces that are 'visible' to the specified user and which match the specified search pattern if any.

getSpaces

This method returns the names of spaces matching the specified search pattern, searching among the spaces that are 'visible' to the specified user.

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 subscribedOnlyfalse would return the list of discoverable spaces (because anonymous user would not be a member of any Space)

Parameters:

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.

Returns:

list of spaces that are 'visible' to the specified user and which match the specified search pattern if any.