org.alfresco.module.vti.handler

Interface ListServiceHandler

All Known Implementing Classes:

AbstractAlfrescoListServiceHandler, AlfrescoListServiceHandler

public interface ListServiceHandler

Site list service fundamental API.

Author:

Nick Burch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListServiceHandler.ListItemOperationType The different kinds of operation which can be performed on items within a list.

Method Summary

Methods

Modifier and Type	Method and Description
ListInfoBean	createList(String listName, String description, String dws, int templateId) Creates a Data List of the given type
void	deleteList(String listName, String dws) Deletes a Data List
List<ListTypeBean>	getAvailableListTypes() Returns the list of available List Types
ListInfoBean	getList(String listName, String dws) Fetches an existing Data List.
List<ListInfoBean>	getListCollection(String siteName) Returns the names and GUIDs for all the lists in the site.
void	updateListItem(ListInfoBean list, ListServiceHandler.ListItemOperationType operation, String id, Map<org.alfresco.service.namespace.QName,String> fields) Performs the specified add/update/delete operations against a single list item.

Method Detail

getList

ListInfoBean getList(String listName,
                   String dws)
                     throws org.alfresco.repo.site.SiteDoesNotExistException,
                            org.alfresco.service.cmr.model.FileNotFoundException

Fetches an existing Data List. This should ideally be called for a List Name, but optionally could be called for a list ID (GUID)

Throws:

org.alfresco.repo.site.SiteDoesNotExistException

org.alfresco.service.cmr.model.FileNotFoundException

createList

ListInfoBean createList(String listName,
                      String description,
                      String dws,
                      int templateId)
                        throws org.alfresco.repo.site.SiteDoesNotExistException,
                               org.alfresco.service.cmr.repository.DuplicateChildNodeNameException,
                               org.alfresco.service.cmr.dictionary.InvalidTypeException

Creates a Data List of the given type

Throws:

org.alfresco.repo.site.SiteDoesNotExistException

org.alfresco.service.cmr.repository.DuplicateChildNodeNameException

org.alfresco.service.cmr.dictionary.InvalidTypeException

deleteList

void deleteList(String listName,
              String dws)
                throws org.alfresco.repo.site.SiteDoesNotExistException,
                       org.alfresco.service.cmr.model.FileNotFoundException

Deletes a Data List

Parameters:

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

Throws:

org.alfresco.repo.site.SiteDoesNotExistException

org.alfresco.service.cmr.model.FileNotFoundException

getAvailableListTypes

List<ListTypeBean> getAvailableListTypes()

Returns the list of available List Types

getListCollection

List<ListInfoBean> getListCollection(String siteName)
                                     throws org.alfresco.repo.site.SiteDoesNotExistException

Returns the names and GUIDs for all the lists in the site.

Parameters:

siteName - the name of site

Returns:

the list of site' lists

Throws:

org.alfresco.repo.site.SiteDoesNotExistException

updateListItem

void updateListItem(ListInfoBean list,
                  ListServiceHandler.ListItemOperationType operation,
                  String id,
                  Map<org.alfresco.service.namespace.QName,String> fields)
                    throws org.alfresco.service.cmr.model.FileNotFoundException

Performs the specified add/update/delete operations against a single list item.

Throws:

org.alfresco.service.cmr.model.FileNotFoundException