com.sap.netweaver.bc.rf.mi.version

Interface IWorkspaceManager

All Known Subinterfaces:

IMutableWorkspaceManager

public interface IWorkspaceManager

Read-only interface describing a repository sub manager for the workspace versioning feature. For an explanation of terminological conventions, please see IBasicVersioningMananger.

Workspaces are collections that may be created incertain server-defined collections. Every resource which is a descendant of a workspace is called a 'workspace controlled resource' or wcr. In every worksapce controlled collection, it is possible to create vcrs using a given version history resource. The newly created vcr will behave essentially like a working resource, the main difference being the client controlled naming and the guarantee that two vcrs in the same workspace will not share their version history (unless they are not bindings to the same resource).

Precondition for the support of this interface is support of IAdvancedVersioningManager and the support of bindings, at least internally.

Method Summary

Set	getCheckedOutResources(IResourceHandle workspaceHandle) Returns the Set of resource handles referring to checked-out vcrs belonging to the workspace identified by the given resource handle.
Set	getWorkspaceCollectionSet(IResourceHandle resourceHandle) Return the Set of collection handles where workspaces can be created.
IResourceHandle	getWorkspaceResource(IResourceHandle resourceHandle) If the given resource handle belongs to a workspace controlled resource, a resource handle referring to it's workspace resource will be returned.

Method Detail

getWorkspaceCollectionSet

public Set getWorkspaceCollectionSet(IResourceHandle resourceHandle)
                              throws ResourceException

Return the Set of collection handles where workspaces can be created. This set may vary depending on the given resource handle, e.g. different parts of the repository namespace may have different workspace collection sets.

Parameters:

resourceHandle - a resource handle

Returns:

the Set of workspace collections for the given resource handle

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getWorkspaceResource

public IResourceHandle getWorkspaceResource(IResourceHandle resourceHandle)
                                     throws ResourceException

If the given resource handle belongs to a workspace controlled resource, a resource handle referring to it's workspace resource will be returned.

Parameters:

resourceHandle - a resource handle

Returns:

a resource handle referring to a workspace resource (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getCheckedOutResources

public Set getCheckedOutResources(IResourceHandle workspaceHandle)
                           throws ResourceException

Returns the Set of resource handles referring to checked-out vcrs belonging to the workspace identified by the given resource handle.

Parameters:

workspaceHandle - a workspace resource handle

Returns:

the resource handles referring to checked-out resources contained in the given workspace

Throws:

ResourceException - if the resource handle is invalid or the operation failed