Oracle© Collaboration Suite Workspaces Web Services API Reference
10g Release 1 (10.1.2.2)

Part No. B28209-01


oracle.workspaces.ws
Interface HomeService


public interface HomeService

HomeService provides methods to manage workspaces life-cycle operations such as creation and deletion , retreival of workspaces by ID/path, listing of workspaces etc.

The Axis specific code snippet given below illustrates workspace creation.

    // Invoke an instance of the home service locator.
    HomeServiceServiceLocator hssl = new HomeServiceServiceLocator();
    // Get a handle to the home service
    HomeService homeService = hssl.getHomeService();
    // Create a workspace definition object.
    WorkspaceDefinition wspcDef = new WorkspaceDefinition();
    // Set all attributes required such as name, display name, description etc .
    wspcDef.setName("WorkspaceName1");
    wspcDef.setDisplayName("WorkspaceName1");
    wspcDef.setDescription("Workspace1 description");
    wspcDef.setDefaultMemberRoleType("WRITER");
    wspcDef.setMemberAccessSetting("ENABLED");
    wspcDef.setPubliclyListed(true);
    wspcDef.setAllowPartialSuccess(true);
    CreateWorkspaceResponseItem resp = homeService.createWorkspace(wspcDef);
    WorkspaceItem wspc = resp.getWorkspaceItem();
 

The Collaborative Workspace environment provides users with the ability to search for all kinds of content that may be contained in one or several workspaces to which they have access. One can search workspace properties or workspace content.The name, display name and description of workspaces are searched during property search. While searching within a workspace , content within library, meetings, discussions, inbox or all of these can be searched. The Axis specific code snippet given below explains search implementation.

   // This will search for string "CWWSTEST" in the properties of all workspaces   the logged in user has access to and return the values in range from 2 to 4.
   SearchResult value = homeService.search("CWWSTEST","WORKSPACE_PROPERTIES", 2,4);
   SearchItem[] searchItems = value.getSearchItems();
 

Method Summary
 void addToFavoriteWorkspaces(java.lang.String[] workspaceIds)
          Adds the specified workspaces to the favorite list
 void addToFavoriteWorkspacesByPath(java.lang.String[] wspcPaths)
          Adds the list of workspaces specified to the favorite workspace listing for this user.
 CreateWorkspaceResponseItem createWorkspace(WorkspaceDefinition wspcDefBean)
          Create a workspace with the supplied configurations
 CreateWorkspaceBulkResponseItem[] createWorkspaces(WorkspaceDefinition[] wspcDefBean)
          Create workspaces with the supplied configurations
 void deleteWorkspace(java.lang.String wspcId, boolean ignoreErrors)
          Remove an existing workspace given the id of the workspace
 void deleteWorkspaceByPath(java.lang.String wspcPath, boolean ignoreErrors)
          Remove an existing workspace given the path of the workspace
 BulkResponseItem[] deleteWorkspaces(java.lang.String[] wspcIds, boolean[] ignoreErrors)
          Remove existing workspaces given their ids
 BulkResponseItem[] deleteWorkspacesByPath(java.lang.String[] wspcPaths, boolean[] ignoreErrors)
          Deletes the list of workspaces, given the workspace paths.
 WorkspaceItem getWorkspaceById(java.lang.String wspcId)
          Get workspace given the id
 WorkspaceItem getWorkspaceByPath(java.lang.String path)
          Get the workspace given its path
 WorkspaceSummary[] listMyFavWorkspaces(java.lang.String[] attrRequest)
          List favorite workspaces for the current user
 WorkspaceSummary[] listMyWorkspaces(java.lang.String[] attrRequest)
          List all workspaces for the current user
 WorkspaceRecoveryInfoItem[] listMyWorkspacesRecoveryInfo()
          Returns information about workspaces of which the current user is an administrator and on which manual recovery needs to be run
 void recoverWorkspace(java.lang.String workspaceUid, boolean force)
          Recover a workspace
 void removeFromFavoriteWorkspaces(java.lang.String[] workspaceIds)
          Removes the specified workspaces from the favorite list
 void removeFromFavoriteWorkspacesByPath(java.lang.String[] wspcPaths)
          Removes the list of workspaces from the favorite workspace listing of this user.
 SearchResult search(java.lang.String searchString, java.lang.String option, int startRange, int endRange)
          Search

 

Method Detail

search

public SearchResult search(java.lang.String searchString,
                           java.lang.String option,
                           int startRange,
                           int endRange)
                    throws CwWSException
Search
Parameters:
searchString - - The pattern to be searched
option - - This is the filter/context in which search should be carried out. Valid options are: ALL_WORKSPACE_CONTENT, FILES, DISCUSSIONS, MEETINGS, INBOX, WORKSPACE_PROPERTIES for inter-workspace search
startRange - - The start range of the objects from the result set th at should be returned
endRange - - The end range of the objects from the result set that s should be returned
Returns:
SearchResult - The results of the search
Throws:
CwWSException

createWorkspace

public CreateWorkspaceResponseItem createWorkspace(WorkspaceDefinition wspcDefBean)
                                            throws CwWSException
Create a workspace with the supplied configurations
Parameters:
wspcDefBean - - Specify various properties for the workspace like name, display name, description,template, initial set of members, etc
Returns:
CwWSWorkspaceResponse - Contains the workspace item if created successfully. Also contains the status, whether the creation was a partial success and if yes, the exceptions that caused the partial success.
Throws:
CwWSException - - If the user does not have the privilege to create the workspace or if the workspace to be created does not pass the valiation rules, e.g., the name must be unique

deleteWorkspace

public void deleteWorkspace(java.lang.String wspcId,
                            boolean ignoreErrors)
                     throws CwWSException
Remove an existing workspace given the id of the workspace
Parameters:
wspcId - - unique ID of the workspace to be removed
ignoreErrors - - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etc
Throws:
CwWSException - - If the user does not have the privilege to delete the workspace or if the workspace contains resources, and there are active sessions connected to the workspace or if a SQL exception is encountered in accessing the CW Repository

getWorkspaceById

public WorkspaceItem getWorkspaceById(java.lang.String wspcId)
                               throws CwWSException
Get workspace given the id
Parameters:
wspcId - - The ID of the workspace requested
Returns:
WorkspaceItem - The workspace item corresponding to the id supplied
Throws:
CwWSException - - If the workspace does not exist or if the user does not have the access privilege to the workspace

getWorkspaceByPath

public WorkspaceItem getWorkspaceByPath(java.lang.String path)
                                 throws CwWSException
Get the workspace given its path
Parameters:
path - - The path of the workspace requested
Returns:
WorkspaceItem - The workspace item corresponding to the path supplied
Throws:
CwWSException - - If the workspace does not exist or if the user does not have the access privilege to the workspace

addToFavoriteWorkspaces

public void addToFavoriteWorkspaces(java.lang.String[] workspaceIds)
                             throws CwWSException
Adds the specified workspaces to the favorite list
Parameters:
workspaceIds - - The workspaces to be added
Throws:
CwWSException

removeFromFavoriteWorkspaces

public void removeFromFavoriteWorkspaces(java.lang.String[] workspaceIds)
                                  throws CwWSException
Removes the specified workspaces from the favorite list
Parameters:
workspaceIds - - The workspaces to be removed
Throws:
CwWSException

createWorkspaces

public CreateWorkspaceBulkResponseItem[] createWorkspaces(WorkspaceDefinition[] wspcDefBean)
                                                   throws CwWSException
Create workspaces with the supplied configurations
Parameters:
wspcDefBean - - Specify various properties for the workspace like name, display name, description, template, initial set of members, etc
Returns:
CreateWorkspaceBulkResponseItem - Returns all the workspace items if successfully created, status of creation, whether partial success and also the errors for the unsuccessful ones.
Throws:
CwWSException - - If the user does not have the privilege to create the workspace or if the workspace to be created does not pass the valiation rules, e.g., the name must be unique.

deleteWorkspaces

public BulkResponseItem[] deleteWorkspaces(java.lang.String[] wspcIds,
                                           boolean[] ignoreErrors)
                                    throws CwWSException
Remove existing workspaces given their ids
Parameters:
wspcIds - - The IDs of the workspace to be removed
ignoreErrors - - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etc
Returns:
BulkResponseItem - indicates the workspaces for which the delete failed and the exceptions
Throws:
CwWSException - - If the user does not have the privilege to delete the workspace or if the workspace contains resources, and there are active sessions connected to the workspace or if a SQL exception is encountered in accessing the CW Repository

listMyWorkspaces

public WorkspaceSummary[] listMyWorkspaces(java.lang.String[] attrRequest)
                                    throws CwWSException
List all workspaces for the current user
Parameters:
attrRequest - - Array representing the properties that the client is interested in retrieving - extra attributes which can be requested for are DEFAULT_MEMBER_ROLE_TYPE, MEMBERSHIP_NOTIFICATION_OPTION, WORKSPACE_PATH, WELCOME_MESSAGE and WORKSPACE_TEMPLATE_NAME
Returns:
WorkspaceSummary[] - Represents a summary of a workspace.
Throws:
CwWSException

listMyFavWorkspaces

public WorkspaceSummary[] listMyFavWorkspaces(java.lang.String[] attrRequest)
                                       throws CwWSException
List favorite workspaces for the current user
Parameters:
attrRequest - - Array representing the properties that the client is interested in retrieving - extra attributes which can be requested for are DEFAULT_MEMBER_ROLE_TYPE, MEMBERSHIP_NOTIFICATION_OPTION, WORKSPACE_PATH, WELCOME_MESSAGE and WORKSPACE_TEMPLATE_NAME
Returns:
WorkspaceSummary[] - Represents a summary of a workspace.
Throws:
CwWSException

deleteWorkspaceByPath

public void deleteWorkspaceByPath(java.lang.String wspcPath,
                                  boolean ignoreErrors)
                           throws CwWSException
Remove an existing workspace given the path of the workspace
Parameters:
wspcPath - - unique path of the workspace to be removed
ignoreErrors - - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etc
Throws:
CwWSException - - If the user does not have the privilege to delete the workspace or if the workspace contains resources, and there are active sessions connected to the workspace or if a SQL exception is encountered in accessing the CW Repository

deleteWorkspacesByPath

public BulkResponseItem[] deleteWorkspacesByPath(java.lang.String[] wspcPaths,
                                                 boolean[] ignoreErrors)
                                          throws CwWSException
Deletes the list of workspaces, given the workspace paths.
Parameters:
wspcPaths - - The Paths of the workspace to be removed
ignoreErrors - - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etc
Returns:
BulkResponseItem[] - indicates the workspaces for which the delete failed and the exceptions
Throws:
CwWSException - - If the user does not have the privilege to delete the workspace or if the workspace contains resources, and there are active sessions connected to the workspace or if a SQL exception is encountered in accessing the CW Repository

addToFavoriteWorkspacesByPath

public void addToFavoriteWorkspacesByPath(java.lang.String[] wspcPaths)
                                   throws CwWSException
Adds the list of workspaces specified to the favorite workspace listing for this user.
Parameters:
wspcPaths - - Workspace paths, representing workspaces to be added to the favorites.
Throws:
CwWSException - - If the argument passed is null or If the backend throws an exception.

removeFromFavoriteWorkspacesByPath

public void removeFromFavoriteWorkspacesByPath(java.lang.String[] wspcPaths)
                                        throws CwWSException
Removes the list of workspaces from the favorite workspace listing of this user.
Parameters:
wspcPaths - - Workspace paths.
Throws:
CwWSException - - If the argument passed is null or If the backend throws an exception.

listMyWorkspacesRecoveryInfo

public WorkspaceRecoveryInfoItem[] listMyWorkspacesRecoveryInfo()
                                                         throws CwWSException
Returns information about workspaces of which the current user is an administrator and on which manual recovery needs to be run
Throws:
CwWSException

recoverWorkspace

public void recoverWorkspace(java.lang.String workspaceUid,
                             boolean force)
                      throws CwWSException
Recover a workspace
Parameters:
workspaceUid - - Uid of the workspace to be recovered
force - - if true, errors will be ignored
Throws:
CwWSException - - If the authenticated user does not have sufficient privileges to perform the action or if recovery fails

Copyright © 2001, 2006, Oracle. All rights reserved.