org.alfresco.module.vti.web.ws

Class AbstractListEndpoint

java.lang.Object

org.alfresco.module.vti.web.VtiUtilBase

org.alfresco.module.vti.web.ws.AbstractEndpoint

org.alfresco.module.vti.web.ws.AbstractListEndpoint

All Implemented Interfaces:

VtiEndpoint

Direct Known Subclasses:

AbstractListItemsEndpoint, AddListEndpoint, DeleteListEndpoint, GetListCollectionEndpoint, GetListEndpoint, UpdateListItemsEndpoint

public abstract class AbstractListEndpoint
extends AbstractEndpoint

Parent class of List Endpoints, which need to return details of a List.

Author:

Nick Burch

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_LOCALE
protected ListServiceHandler	handler
protected String	prefix

Fields inherited from class org.alfresco.module.vti.web.ws.AbstractEndpoint

DWS, name, namespace, soapPart, soapUri, soapUriPrefix

Constructor Summary

Constructors

Constructor and Description
AbstractListEndpoint(ListServiceHandler handler) constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(VtiSoapRequest soapRequest, VtiSoapResponse soapResponse) Deletes document workspace
protected abstract ListInfoBean	executeListAction(VtiSoapRequest soapRequest, String dws, String listName, String description, int templateID) Does the List work, and returns the detail of the List
protected void	executeListActionDetails(VtiSoapRequest soapRequest, VtiSoapResponse soapResponse, String siteName, String listName, org.dom4j.Element requestElement, org.jaxen.SimpleNamespaceContext nc)
protected String	formatListDate(Date date)
protected void	renderFields(String siteName, ListInfoBean list, org.dom4j.Element fieldsElement)
protected void	renderList(VtiSoapRequest soapRequest, VtiSoapResponse soapResponse, String siteName, ListInfoBean list)
protected void	renderListDefinition(ListInfoBean list, String siteName, String siteUrl, org.dom4j.Element listE)

Methods inherited from class org.alfresco.module.vti.web.ws.AbstractEndpoint

buildResultTag, buildXPath, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, generateXml, getContext, getDwsForCreationFromUri, getDwsFromUri, getFileName, getHost, getMessage, getName, getNamespace, getResponseTagName, getResultTagName, getUrlHelper, setName, setNamespace, setUrlHelper

Methods inherited from class org.alfresco.module.vti.web.VtiUtilBase

endTag, processTag, singleTag, singleTag, startTag, startTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOCALE

protected static final String DEFAULT_LOCALE

See Also:

Constant Field Values

handler

protected ListServiceHandler handler

prefix

protected String prefix

Constructor Detail

AbstractListEndpoint

public AbstractListEndpoint(ListServiceHandler handler)

constructor

Parameters:

handler -

Method Detail

executeListAction

protected abstract ListInfoBean executeListAction(VtiSoapRequest soapRequest,
                             String dws,
                             String listName,
                             String description,
                             int templateID)
                                           throws Exception

Does the List work, and returns the detail of the List

Throws:

Exception

execute

public void execute(VtiSoapRequest soapRequest,
           VtiSoapResponse soapResponse)
             throws Exception

Deletes document workspace

Parameters:

soapRequest - Vti soap request (VtiSoapRequest)

soapResponse - Vti soap response (VtiSoapResponse)

Throws:

Exception

executeListActionDetails

protected void executeListActionDetails(VtiSoapRequest soapRequest,
                            VtiSoapResponse soapResponse,
                            String siteName,
                            String listName,
                            org.dom4j.Element requestElement,
                            org.jaxen.SimpleNamespaceContext nc)
                                 throws Exception

Throws:

Exception

renderList

protected void renderList(VtiSoapRequest soapRequest,
              VtiSoapResponse soapResponse,
              String siteName,
              ListInfoBean list)
                   throws Exception

Throws:

Exception

renderListDefinition

protected void renderListDefinition(ListInfoBean list,
                        String siteName,
                        String siteUrl,
                        org.dom4j.Element listE)

renderFields

protected void renderFields(String siteName,
                ListInfoBean list,
                org.dom4j.Element fieldsElement)
                     throws Exception

Throws:

Exception

formatListDate

protected String formatListDate(Date date)