public class

SharepointListClientImpl

extends Object
implements SharepointListClient
java.lang.Object
   ↳ org.mule.modules.sharepoint.api.client.impl.SharepointListClientImpl

Class Overview

Default Implementation for Sharepoint List Client

Summary

Fields
private SharepointServiceProvider<? extends SharepointServiceConfig> serviceProvider
Public Constructors
SharepointListClientImpl(SharepointServiceProvider<? extends SharepointServiceConfig> serviceProvider)
Public Methods
String addAttachment(String listName, String listItemId, String filename, byte[] attachment)
void addDiscussionBoardItem(String listName, byte[] message)
AddListResponse.AddListResult addList(String listName, String description, int templateId)
AddListFromFeatureResponse.AddListFromFeatureResult addListFromFeature(String listName, String description, String featureId, int templateId)
AddWikiPageResponse.AddWikiPageResult addWikiPage(String strListName, String listRelPageUrl, String wikiContent)
boolean checkInFile(String pageUrl, String comment, String checkInType)
boolean checkOutFile(String pageUrl, String checkoutToLocal, String lastModified)
String createContentType(String listName, String displayName, String parentType, CreateContentType.Fields fields, CreateContentType.ContentTypeProperties contentTypeProperties, String addToView)
void deleteAttachment(String listName, String listItemId, String url)
DeleteContentTypeResponse.DeleteContentTypeResult deleteContentType(String listName, String contentTypeId)
DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult deleteContentTypeXmlDocument(String listName, String contentTypeId, String documentUri)
void deleteList(String listName)
GetAttachmentCollectionResponse.GetAttachmentCollectionResult getAttachmentCollection(String listName, String listItemId)
ListsSoap getConnection()
GetListResponse.GetListResult getList(String listName)
GetListAndViewResponse.GetListAndViewResult getListAndView(String listName, String viewName)
GetListCollectionResponse.GetListCollectionResult getListCollection()
GetListContentTypeResponse.GetListContentTypeResult getListContentType(String listName, String contentTypeId)
GetListContentTypesResponse.GetListContentTypesResult getListContentTypes(String listName, String contentTypeId)
GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult getListContentTypesAndProperties(String listName, String contentTypeId, String propertyPrefix, Boolean includeWebProperties)
GetListItemChangesResponse.GetListItemChangesResult getListItemChanges(String listName, GetListItemChanges.ViewFields viewFields, String since, GetListItemChanges.Contains contains)
GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult getListItemChangesSinceToken(String listName, String viewName, GetListItemChangesSinceToken.Query query, GetListItemChangesSinceToken.ViewFields viewFields, String rowLimit, GetListItemChangesSinceToken.QueryOptions queryOptions, String changeToken, GetListItemChangesSinceToken.Contains contains)
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)
GetListItemsResponse.GetListItemsResult getListItems(String listName, String viewName, GetListItems.Query query, GetListItems.ViewFields viewFields, String rowLimit, GetListItems.QueryOptions queryOptions, String webId)
GetVersionCollectionResponse.GetVersionCollectionResult getVersionCollection(String listId, String listItemId, String fieldName)
boolean undoCheckout(String pageUrl)
UpdateContentTypeResponse.UpdateContentTypeResult updateContentType(String listName, String contentTypeId, UpdateContentType.ContentTypeProperties contentTypeProperties, UpdateContentType.NewFields newFields, UpdateContentType.UpdateFields updateFields, UpdateContentType.DeleteFields deleteFields, String addToView)
UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult updateContentTypeXmlDocument(String listName, String contentTypeId, UpdateContentTypeXmlDocument.NewDocument newDocument)
UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult updateContentTypesXmlDocument(String listName, UpdateContentTypesXmlDocument.NewDocument newDocument)
UpdateListResponse.UpdateListResult updateList(String listName, UpdateList.ListProperties listProperties, UpdateList.NewFields newFields, UpdateList.UpdateFields updateFields, UpdateList.DeleteFields deleteFields, String listVersion)
UpdateListItemsResponse.UpdateListItemsResult updateListItems(String listName, UpdateListItems.Updates updates)
UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult updateListItemsWithKnowledge(String listName, UpdateListItemsWithKnowledge.Updates updates, String syncScope, UpdateListItemsWithKnowledge.Knowledge knowledge)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.mule.modules.sharepoint.api.client.SharepointListClient

Fields

private SharepointServiceProvider<? extends SharepointServiceConfig> serviceProvider

Public Constructors

public SharepointListClientImpl (SharepointServiceProvider<? extends SharepointServiceConfig> serviceProvider)

Parameters
serviceProvider

Public Methods

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

Parameters
listName
listItemId
filename
attachment

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

Parameters
listName
message

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

Parameters
listName
description
templateId

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

Parameters
listName
description
featureId
templateId

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

Parameters
strListName
listRelPageUrl
wikiContent

public boolean checkInFile (String pageUrl, String comment, String checkInType)

Parameters
pageUrl
comment
checkInType

public boolean checkOutFile (String pageUrl, String checkoutToLocal, String lastModified)

Parameters
pageUrl
checkoutToLocal
lastModified

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

Parameters
listName
displayName
parentType
fields
contentTypeProperties
addToView

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

Parameters
listName
listItemId
url

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

Parameters
listName
contentTypeId

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

Parameters
listName
contentTypeId
documentUri

public void deleteList (String listName)

Parameters
listName

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

Parameters
listName
listItemId

public ListsSoap getConnection ()

public GetListResponse.GetListResult getList (String listName)

Parameters
listName

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

Parameters
listName
viewName

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

Parameters
listName
contentTypeId

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

Parameters
listName
contentTypeId

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

Parameters
listName
contentTypeId
propertyPrefix
includeWebProperties

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

Parameters
listName
viewFields
since
contains

public 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

public 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

public 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

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

Parameters
listId
listItemId
fieldName

public boolean undoCheckout (String pageUrl)

Parameters
pageUrl

public 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

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

Parameters
listName
contentTypeId
newDocument

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

Parameters
listName
newDocument

public 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

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

Parameters
listName
updates

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

Parameters
listName
updates
syncScope
knowledge