|
Oracle© Collaboration Suite Workspaces Web Services API Reference 10g Release 1 (10.1.2.2) Part No. B28209-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public SearchResult search(java.lang.String searchString, java.lang.String option, int startRange, int endRange) throws CwWSException
searchString
- - The pattern to be searchedoption
- - 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 searchstartRange
- - The start range of the objects from the result set th at should be returnedendRange
- - The end range of the objects from the result set that s should be returnedCwWSException
public CreateWorkspaceResponseItem createWorkspace(WorkspaceDefinition wspcDefBean) throws CwWSException
wspcDefBean
- - Specify various properties for the workspace like name, display name, description,template, initial set of members, etcCwWSException
- - 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 uniquepublic void deleteWorkspace(java.lang.String wspcId, boolean ignoreErrors) throws CwWSException
wspcId
- - unique ID of the workspace to be removedignoreErrors
- - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etcCwWSException
- - 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 Repositorypublic WorkspaceItem getWorkspaceById(java.lang.String wspcId) throws CwWSException
wspcId
- - The ID of the workspace requestedCwWSException
- - If the workspace does not exist or if the user does not have the access privilege to the workspacepublic WorkspaceItem getWorkspaceByPath(java.lang.String path) throws CwWSException
path
- - The path of the workspace requestedCwWSException
- - If the workspace does not exist or if the user does not have the access privilege to the workspacepublic void addToFavoriteWorkspaces(java.lang.String[] workspaceIds) throws CwWSException
workspaceIds
- - The workspaces to be addedCwWSException
public void removeFromFavoriteWorkspaces(java.lang.String[] workspaceIds) throws CwWSException
workspaceIds
- - The workspaces to be removedCwWSException
public CreateWorkspaceBulkResponseItem[] createWorkspaces(WorkspaceDefinition[] wspcDefBean) throws CwWSException
wspcDefBean
- - Specify various properties for the workspace like name, display name, description, template, initial set of members, etcCwWSException
- - 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.public BulkResponseItem[] deleteWorkspaces(java.lang.String[] wspcIds, boolean[] ignoreErrors) throws CwWSException
wspcIds
- - The IDs of the workspace to be removedignoreErrors
- - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etcCwWSException
- - 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 Repositorypublic WorkspaceSummary[] listMyWorkspaces(java.lang.String[] attrRequest) throws CwWSException
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_NAMECwWSException
public WorkspaceSummary[] listMyFavWorkspaces(java.lang.String[] attrRequest) throws CwWSException
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_NAMECwWSException
public void deleteWorkspaceByPath(java.lang.String wspcPath, boolean ignoreErrors) throws CwWSException
wspcPath
- - unique path of the workspace to be removedignoreErrors
- - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etcCwWSException
- - 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 Repositorypublic BulkResponseItem[] deleteWorkspacesByPath(java.lang.String[] wspcPaths, boolean[] ignoreErrors) throws CwWSException
wspcPaths
- - The Paths of the workspace to be removedignoreErrors
- - Specify whether to delete the workspace even though it encounters some errors like unable to connect to the native repository, etcCwWSException
- - 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 Repositorypublic void addToFavoriteWorkspacesByPath(java.lang.String[] wspcPaths) throws CwWSException
wspcPaths
- - Workspace paths, representing workspaces to be added to the favorites.CwWSException
- - If the argument passed is null or If the backend throws an exception.public void removeFromFavoriteWorkspacesByPath(java.lang.String[] wspcPaths) throws CwWSException
wspcPaths
- - Workspace paths.CwWSException
- - If the argument passed is null or If the backend throws an exception.public WorkspaceRecoveryInfoItem[] listMyWorkspacesRecoveryInfo() throws CwWSException
CwWSException
public void recoverWorkspace(java.lang.String workspaceUid, boolean force) throws CwWSException
workspaceUid
- - Uid of the workspace to be recoveredforce
- - if true, errors will be ignoredCwWSException
- - If the authenticated user does not have sufficient privileges to perform the action or if recovery fails
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |