com.microsoft.services.sharepoint

Class ListClient

java.lang.Object

com.microsoft.services.sharepoint.OfficeClient

com.microsoft.services.sharepoint.SharePointClient

com.microsoft.services.sharepoint.ListClient

public class ListClient
extends SharePointClient

The Class ListClient.

Constructor Summary

Constructors

Constructor and Description
ListClient(java.lang.String serverUrl, java.lang.String siteRelativeUrl, Credentials credentials) Instantiates a new sharepoint lists client.
ListClient(java.lang.String serverUrl, java.lang.String siteRelativeUrl, Credentials credentials, Logger logger) Instantiates a new sharepoint lists client.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	deleteListItem(SPListItem listItem, java.lang.String listName) Delete list item.
com.google.common.util.concurrent.ListenableFuture<java.util.List<java.lang.String>>	getColumnsFromDefaultView(java.lang.String listName) Gets columns from default view.
com.google.common.util.concurrent.ListenableFuture<SPList>	getList(java.lang.String listName) Gets the list.
com.google.common.util.concurrent.ListenableFuture<java.util.List<SPListField>>	getListFields(java.lang.String listName, Query query) Gets the list fields.
com.google.common.util.concurrent.ListenableFuture<java.util.List<SPListItem>>	getListItems(java.lang.String listName, Query query) Gets the list items.
com.google.common.util.concurrent.ListenableFuture<java.util.List<SPList>>	getLists(Query query) Gets lists.
com.google.common.util.concurrent.ListenableFuture<java.lang.String>	getUserProperties() Gets user properties.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	insertListItem(SPListItem listItem, SPList list) Insert list item.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	updateListItem(SPListItem listItem, SPList list) Update list item.

Methods inherited from class com.microsoft.services.sharepoint.SharePointClient

executeRequestJsonWithDigest, getFormDigest, getServerUrl, getSiteRelativeUrl, getSiteUrl, getUserByID, getWebTitle

Methods inherited from class com.microsoft.services.sharepoint.OfficeClient

executeRequest, executeRequest, executeRequestJson, executeRequestJson, generateODataQueryString, getCredentials, getDiscoveryInfo, getDiscoveryInfo, getLogger, isValidStatus, log, log, prepareRequest, queryEncode, urlEncode, UUIDtoString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListClient

public ListClient(java.lang.String serverUrl,
          java.lang.String siteRelativeUrl,
          Credentials credentials)

Instantiates a new sharepoint lists client.

Parameters:

serverUrl - the server url

siteRelativeUrl - the site relative url

credentials - the credentials

ListClient

public ListClient(java.lang.String serverUrl,
          java.lang.String siteRelativeUrl,
          Credentials credentials,
          Logger logger)

Instantiates a new sharepoint lists client.

Parameters:

serverUrl - the server url

siteRelativeUrl - the site relative url

credentials - the credentials

logger - the logger

Method Detail

getLists

public com.google.common.util.concurrent.ListenableFuture<java.util.List<SPList>> getLists(Query query)

Gets lists.

Parameters:

query - the query

Returns:

the lists

getList

public com.google.common.util.concurrent.ListenableFuture<SPList> getList(java.lang.String listName)

Gets the list.

Parameters:

listName - the list name

Returns:

the list

getListItems

public com.google.common.util.concurrent.ListenableFuture<java.util.List<SPListItem>> getListItems(java.lang.String listName,
                                                                                          Query query)

Gets the list items.

Parameters:

listName - the list name

query - the query

Returns:

the list items

getListFields

public com.google.common.util.concurrent.ListenableFuture<java.util.List<SPListField>> getListFields(java.lang.String listName,
                                                                                            Query query)

Gets the list fields.

Parameters:

listName - the list name

query - the query

Returns:

the list fields

insertListItem

public com.google.common.util.concurrent.ListenableFuture<java.lang.Void> insertListItem(SPListItem listItem,
                                                                                SPList list)

Insert list item.

Parameters:

listItem - the list item

list - the list

Returns:

the office future

updateListItem

public com.google.common.util.concurrent.ListenableFuture<java.lang.Void> updateListItem(SPListItem listItem,
                                                                                SPList list)

Update list item.

Parameters:

listItem - the list item

list - the list

Returns:

the office future

deleteListItem

public com.google.common.util.concurrent.ListenableFuture<java.lang.Void> deleteListItem(SPListItem listItem,
                                                                                java.lang.String listName)

Delete list item.

Parameters:

listItem - the list item

listName - the list name

Returns:

the office future

getColumnsFromDefaultView

public com.google.common.util.concurrent.ListenableFuture<java.util.List<java.lang.String>> getColumnsFromDefaultView(java.lang.String listName)

Gets columns from default view.

Parameters:

listName - the list name

Returns:

the columns from default view

getUserProperties

public com.google.common.util.concurrent.ListenableFuture<java.lang.String> getUserProperties()

Gets user properties.

Returns:

the user properties