Summary: Methods | [Expand All]
public interface

SharepointListClient

org.mule.modules.sharepoint.api.client.SharepointListClient
Known Indirect Subclasses

Class Overview

Client interface for Sharepoint API operations

Summary

Public Methods
abstract String addAttachment(String listName, String listItemId, String filename, byte[] attachment)
abstract void addDiscussionBoardItem(String listName, byte[] message)
abstract AddListResponse.AddListResult addList(String listName, String description, int templateId)
abstract AddListFromFeatureResponse.AddListFromFeatureResult addListFromFeature(String listName, String description, String featureId, int templateId)
abstract AddWikiPageResponse.AddWikiPageResult addWikiPage(String strListName, String listRelPageUrl, String wikiContent)
abstract boolean checkInFile(String pageUrl, String comment, String checkinType)
abstract boolean checkOutFile(String pageUrl, String checkoutToLocal, String lastmodified)
abstract String createContentType(String listName, String displayName, String parentType, CreateContentType.Fields fields, CreateContentType.ContentTypeProperties contentTypeProperties, String addToView)
abstract void deleteAttachment(String listName, String listItemId, String url)
abstract DeleteContentTypeResponse.DeleteContentTypeResult deleteContentType(String listName, String contentTypeId)
abstract DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult deleteContentTypeXmlDocument(String listName, String contentTypeId, String documentUri)
abstract void deleteList(String listName)
abstract GetAttachmentCollectionResponse.GetAttachmentCollectionResult getAttachmentCollection(String listName, String listItemId)
abstract GetListResponse.GetListResult getList(String listName)
abstract GetListAndViewResponse.GetListAndViewResult getListAndView(String listName, String viewName)
abstract GetListCollectionResponse.GetListCollectionResult getListCollection()
abstract GetListContentTypeResponse.GetListContentTypeResult getListContentType(String listName, String contentTypeId)
abstract GetListContentTypesResponse.GetListContentTypesResult getListContentTypes(String listName, String contentTypeId)
abstract GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult getListContentTypesAndProperties(String listName, String contentTypeId, String propertyPrefix, Boolean includeWebProperties)
abstract GetListItemChangesResponse.GetListItemChangesResult getListItemChanges(String listName, GetListItemChanges.ViewFields viewFields, String since, GetListItemChanges.Contains contains)
abstract GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult getListItemChangesSinceToken(String listName, String viewName, GetListItemChangesSinceToken.Query query, GetListItemChangesSinceToken.ViewFields viewFields, String rowLimit, GetListItemChangesSinceToken.QueryOptions queryOptions, String changeToken, GetListItemChangesSinceToken.Contains contains)
abstract GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult getListItemChangesWithKnowledge(String listName, String viewName, GetListItemChangesWithKnowledge.Query query, GetListItemChangesWithKnowledge.ViewFields viewFields, String rowLimit, GetListItemChangesWithKnowledge.QueryOptions queryOptions, String syncScope, GetListItemChangesWithKnowledge.Knowledge knowledge, GetListItemChangesWithKnowledge.Contains contains)
abstract GetListItemsResponse.GetListItemsResult getListItems(String listName, String viewName, GetListItems.Query query, GetListItems.ViewFields viewFields, String rowLimit, GetListItems.QueryOptions queryOptions, String webId)
abstract GetVersionCollectionResponse.GetVersionCollectionResult getVersionCollection(String listId, String listItemId, String fieldName)
abstract boolean undoCheckout(String pageUrl)
abstract UpdateContentTypeResponse.UpdateContentTypeResult updateContentType(String listName, String contentTypeId, UpdateContentType.ContentTypeProperties contentTypeProperties, UpdateContentType.NewFields newFields, UpdateContentType.UpdateFields updateFields, UpdateContentType.DeleteFields deleteFields, String addToView)
abstract UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult updateContentTypeXmlDocument(String listName, String contentTypeId, UpdateContentTypeXmlDocument.NewDocument newDocument)
abstract UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult updateContentTypesXmlDocument(String listName, UpdateContentTypesXmlDocument.NewDocument newDocument)
abstract UpdateListResponse.UpdateListResult updateList(String listName, UpdateList.ListProperties listProperties, UpdateList.NewFields newFields, UpdateList.UpdateFields updateFields, UpdateList.DeleteFields deleteFields, String listVersion)
abstract UpdateListItemsResponse.UpdateListItemsResult updateListItems(String listName, UpdateListItems.Updates updates)
abstract UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult updateListItemsWithKnowledge(String listName, UpdateListItemsWithKnowledge.Updates updates, String syncScope, UpdateListItemsWithKnowledge.Knowledge knowledge)

Public Methods

public abstract String addAttachment (String listName, String listItemId, String filename, byte[] attachment)

Parameters
listName
listItemId
filename
attachment
Throws
SharepointRuntimeException

public abstract void addDiscussionBoardItem (String listName, byte[] message)

Parameters
listName
message
Throws
SharepointRuntimeException

public abstract AddListResponse.AddListResult addList (String listName, String description, int templateId)

Parameters
listName
description
templateId
Throws
SharepointRuntimeException

public abstract AddListFromFeatureResponse.AddListFromFeatureResult addListFromFeature (String listName, String description, String featureId, int templateId)

Parameters
listName
description
featureId
templateId
Throws
SharepointRuntimeException

public abstract AddWikiPageResponse.AddWikiPageResult addWikiPage (String strListName, String listRelPageUrl, String wikiContent)

Parameters
strListName
listRelPageUrl
wikiContent
Throws
SharepointRuntimeException

public abstract boolean checkInFile (String pageUrl, String comment, String checkinType)

Parameters
pageUrl
comment
checkinType
Throws
SharepointRuntimeException

public abstract boolean checkOutFile (String pageUrl, String checkoutToLocal, String lastmodified)

Parameters
pageUrl
checkoutToLocal
lastmodified
Throws
SharepointRuntimeException

public abstract String createContentType (String listName, String displayName, String parentType, CreateContentType.Fields fields, CreateContentType.ContentTypeProperties contentTypeProperties, String addToView)

Parameters
listName
displayName
parentType
fields
contentTypeProperties
addToView
Throws
SharepointRuntimeException

public abstract void deleteAttachment (String listName, String listItemId, String url)

Parameters
listName
listItemId
url
Throws
SharepointRuntimeException

public abstract DeleteContentTypeResponse.DeleteContentTypeResult deleteContentType (String listName, String contentTypeId)

Parameters
listName
contentTypeId
Throws
SharepointRuntimeException

public abstract DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult deleteContentTypeXmlDocument (String listName, String contentTypeId, String documentUri)

Parameters
listName
contentTypeId
documentUri
Throws
SharepointRuntimeException

public abstract void deleteList (String listName)

Parameters
listName
Throws
SharepointRuntimeException

public abstract GetAttachmentCollectionResponse.GetAttachmentCollectionResult getAttachmentCollection (String listName, String listItemId)

Parameters
listName
listItemId
Throws
SharepointRuntimeException

public abstract GetListResponse.GetListResult getList (String listName)

Parameters
listName
Throws
SharepointRuntimeException

public abstract GetListAndViewResponse.GetListAndViewResult getListAndView (String listName, String viewName)

Parameters
listName
viewName
Throws
SharepointRuntimeException

public abstract GetListCollectionResponse.GetListCollectionResult getListCollection ()

Throws
SharepointRuntimeException

public abstract GetListContentTypeResponse.GetListContentTypeResult getListContentType (String listName, String contentTypeId)

Parameters
listName
contentTypeId
Throws
SharepointRuntimeException

public abstract GetListContentTypesResponse.GetListContentTypesResult getListContentTypes (String listName, String contentTypeId)

Parameters
listName
contentTypeId
Throws
SharepointRuntimeException

public abstract GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult getListContentTypesAndProperties (String listName, String contentTypeId, String propertyPrefix, Boolean includeWebProperties)

Parameters
listName
contentTypeId
propertyPrefix
includeWebProperties
Throws
SharepointRuntimeException

public abstract GetListItemChangesResponse.GetListItemChangesResult getListItemChanges (String listName, GetListItemChanges.ViewFields viewFields, String since, GetListItemChanges.Contains contains)

Parameters
listName
viewFields
since
contains
Throws
SharepointRuntimeException

public abstract GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult getListItemChangesSinceToken (String listName, String viewName, GetListItemChangesSinceToken.Query query, GetListItemChangesSinceToken.ViewFields viewFields, String rowLimit, GetListItemChangesSinceToken.QueryOptions queryOptions, String changeToken, GetListItemChangesSinceToken.Contains contains)

Parameters
listName
viewName
query
viewFields
rowLimit
queryOptions
changeToken
contains
Throws
SharepointRuntimeException

public abstract GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult getListItemChangesWithKnowledge (String listName, String viewName, GetListItemChangesWithKnowledge.Query query, GetListItemChangesWithKnowledge.ViewFields viewFields, String rowLimit, GetListItemChangesWithKnowledge.QueryOptions queryOptions, String syncScope, GetListItemChangesWithKnowledge.Knowledge knowledge, GetListItemChangesWithKnowledge.Contains contains)

Parameters
listName
viewName
query
viewFields
rowLimit
queryOptions
syncScope
knowledge
contains
Throws
SharepointRuntimeException

public abstract GetListItemsResponse.GetListItemsResult getListItems (String listName, String viewName, GetListItems.Query query, GetListItems.ViewFields viewFields, String rowLimit, GetListItems.QueryOptions queryOptions, String webId)

Parameters
listName
viewName
query
viewFields
rowLimit
queryOptions
webId
Throws
SharepointRuntimeException

public abstract GetVersionCollectionResponse.GetVersionCollectionResult getVersionCollection (String listId, String listItemId, String fieldName)

Parameters
listId
listItemId
fieldName
Throws
SharepointRuntimeException

public abstract boolean undoCheckout (String pageUrl)

Parameters
pageUrl
Throws
SharepointRuntimeException

public abstract UpdateContentTypeResponse.UpdateContentTypeResult updateContentType (String listName, String contentTypeId, UpdateContentType.ContentTypeProperties contentTypeProperties, UpdateContentType.NewFields newFields, UpdateContentType.UpdateFields updateFields, UpdateContentType.DeleteFields deleteFields, String addToView)

Parameters
listName
contentTypeId
contentTypeProperties
newFields
updateFields
deleteFields
addToView
Throws
SharepointRuntimeException

public abstract UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult updateContentTypeXmlDocument (String listName, String contentTypeId, UpdateContentTypeXmlDocument.NewDocument newDocument)

Parameters
listName
contentTypeId
newDocument
Throws
SharepointRuntimeException

public abstract UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult updateContentTypesXmlDocument (String listName, UpdateContentTypesXmlDocument.NewDocument newDocument)

Parameters
listName
newDocument
Throws
SharepointRuntimeException

public abstract UpdateListResponse.UpdateListResult updateList (String listName, UpdateList.ListProperties listProperties, UpdateList.NewFields newFields, UpdateList.UpdateFields updateFields, UpdateList.DeleteFields deleteFields, String listVersion)

Parameters
listName
listProperties
newFields
updateFields
deleteFields
listVersion
Throws
SharepointRuntimeException

public abstract UpdateListItemsResponse.UpdateListItemsResult updateListItems (String listName, UpdateListItems.Updates updates)

Parameters
listName
updates
Throws
SharepointRuntimeException

public abstract UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult updateListItemsWithKnowledge (String listName, UpdateListItemsWithKnowledge.Updates updates, String syncScope, UpdateListItemsWithKnowledge.Knowledge knowledge)

Parameters
listName
updates
syncScope
knowledge
Throws
SharepointRuntimeException