org.alfresco.module.vti.web.ws

Class AbstractListItemsEndpoint

java.lang.Object

org.alfresco.module.vti.web.VtiUtilBase

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

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

org.alfresco.module.vti.web.ws.AbstractListItemsEndpoint

All Implemented Interfaces:

VtiEndpoint

Direct Known Subclasses:

GetListItemsEndpoint

public abstract class AbstractListItemsEndpoint
extends AbstractListEndpoint

Parent class of the GetListItems* methods from lists web service (Get all Items, Get Items Since ... etc)

Author:

PavelYur

Field Summary

Fields

Modifier and Type	Field and Description
protected MethodHandler	methodHandler

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

DEFAULT_LOCALE, handler, prefix

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

DWS, name, namespace, soapPart, soapUri, soapUriPrefix

Constructor Summary

Constructors

Constructor and Description
AbstractListItemsEndpoint(ListServiceHandler listHander, MethodHandler handler) constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected ListInfoBean	executeListAction(VtiSoapRequest soapRequest, String dws, String listName, String description, int templateID) Not used, we are too specific
protected void	executeListActionDetails(VtiSoapRequest soapRequest, VtiSoapResponse soapResponse, String siteName, String listName, org.dom4j.Element requestElement, org.jaxen.SimpleNamespaceContext nc) Returns information about items in the list based on the specified query
protected abstract DocsMetaInfo	getListInfo(String siteName, ListInfoBean list, String initialUrl, Date since)
void	setPathHelper(VtiPathHelper pathHelper)

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

execute, formatListDate, renderFields, renderList, renderListDefinition

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

methodHandler

protected MethodHandler methodHandler

Constructor Detail

AbstractListItemsEndpoint

public AbstractListItemsEndpoint(ListServiceHandler listHander,
                         MethodHandler handler)

constructor

Parameters:

handler - that provides methods for operating with documents and folders

Method Detail

setPathHelper

public void setPathHelper(VtiPathHelper pathHelper)

Parameters:

pathHelper - the pathHelper to set

executeListActionDetails

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

Returns information about items in the list based on the specified query

Overrides:

executeListActionDetails in class AbstractListEndpoint

Throws:

Exception

getListInfo

protected abstract DocsMetaInfo getListInfo(String siteName,
                       ListInfoBean list,
                       String initialUrl,
                       Date since)

executeListAction

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

Not used, we are too specific

Specified by:

executeListAction in class AbstractListEndpoint

Throws:

Exception