org.alfresco.module.vti.handler

Interface DwsServiceHandler

All Known Implementing Classes:

AbstractAlfrescoDwsServiceHandler, AlfrescoDwsServiceHandler

public interface DwsServiceHandler

Document workspace site service fundamental API.

Author:

AndreyAk

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCreateDwsUrl(String url) Indicates whether the document workspace specified by the given url can be created.
DwsBean	createDws(String parentDwsUrl, String name, List<UserBean> users, String title, List<DocumentBean> documents, String host, String context, SessionUser user) Creates a document workspace site
void	createFolder(String url) Creates a subfolder in a document library of the current document workspace site
void	deleteDws(String dwsUrl, SessionUser user) Deletes the current document workspace site and its contents
void	deleteFolder(String url) Deletes a subfolder from a document library of the current document workspace site
DwsData	getDwsData(String documentURL, String lastUpdate) Returns information about a document workspace site and the lists it contains
DwsMetadata	getDWSMetaData(String documentURL, String id, boolean minimal) Returns information about a document workspace site and the lists it contains
void	handleRedirect(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Redirect request to the appropriate page
void	removeDwsUser(String dwsUrl, String id) Removes the specified user from the list of users for the current document workspace site
void	renameDws(String oldDwsUrl, String title) Changes the title of the current document workspace site
LinkBean	updateDwsData(LinkBean linkBean, CAMLMethod method, String dws) Update document workspace site data such as links

Method Detail

canCreateDwsUrl

boolean canCreateDwsUrl(String url)
                        throws DwsException

Indicates whether the document workspace specified by the given url can be created.

Parameters:

url - Specifies the document workspace to be created.

Returns:

Throws:

DwsException

getDWSMetaData

DwsMetadata getDWSMetaData(String documentURL,
                         String id,
                         boolean minimal)
                           throws Exception

Returns information about a document workspace site and the lists it contains

Parameters:

document - the site-based URL of a document in a document library in the document workspace site

id - an optional document globally unique identifier (GUID)

minimal - determines whether the output includes information about the schemas, lists, documents, links, and tasks lists of a document workspace site

Returns:

DwsMetadata information about a document workspace site and the lists it contains (DwsMetadata)

Throws:

Exception

getDwsData

DwsData getDwsData(String documentURL,
                 String lastUpdate)
                   throws org.alfresco.repo.site.SiteDoesNotExistException

Returns information about a document workspace site and the lists it contains

Parameters:

document - the site-based URL of a document in a document library in the document workspace site

lastUpdate - returned in the results of a previous call to the GetDwsData or GetDwsMetadata method

Returns:

DwsData information about a document workspace site (DwsData)

Throws:

org.alfresco.repo.site.SiteDoesNotExistException

createDws

DwsBean createDws(String parentDwsUrl,
                String name,
                List<UserBean> users,
                String title,
                List<DocumentBean> documents,
                String host,
                String context,
                SessionUser user)

Creates a document workspace site

Parameters:

parentDwsUrl - url of the parent dws

name - the optional URL of the new document workspace site. If an empty string is passed, the URL of the new SharePoint site is based on the title

users - an optional list of users to add to the new SharePoint site

title - the title of the new document workspace site

documents - an optional list of documents. Used by Microsoft Office Outlook 2003 when adding shared attachments to a new document workspace site

host - application host

context - application context

user - current user

Returns:

DwsBean information about a new document workspace site DwsData (DwsBean)

createFolder

void createFolder(String url)

Creates a subfolder in a document library of the current document workspace site

Parameters:

url - the proposed site-based URL of the folder to create

deleteFolder

void deleteFolder(String url)

Deletes a subfolder from a document library of the current document workspace site

Parameters:

url - The site-based URL of the folder to delete

deleteDws

void deleteDws(String dwsUrl,
             SessionUser user)

Deletes the current document workspace site and its contents

Parameters:

dwsUrl - url of dws to delete

user - current user

renameDws

void renameDws(String oldDwsUrl,
             String title)

Changes the title of the current document workspace site

Parameters:

oldDwsUrl - url of dws to rename

title - the new title for the document workspace site

removeDwsUser

void removeDwsUser(String dwsUrl,
                 String id)

Removes the specified user from the list of users for the current document workspace site

Parameters:

dwsUrl - URL of document workspace site

id - the ID of the user to be removed from the list of users

handleRedirect

void handleRedirect(javax.servlet.http.HttpServletRequest req,
                  javax.servlet.http.HttpServletResponse resp)
                    throws org.apache.commons.httpclient.HttpException,
                           IOException

Redirect request to the appropriate page

Parameters:

req - HTTP request

resp - HTTP response

Throws:

IOException

org.apache.commons.httpclient.HttpException

updateDwsData

LinkBean updateDwsData(LinkBean linkBean,
                     CAMLMethod method,
                     String dws)

Update document workspace site data such as links

Parameters:

linkBean - (LinkBean)

method -

dws - document workspace site name

Returns:

linkBean that was changed