com.adobe.livecycle.crc.sharepoint.client
Interface IMSSharePointContentRepositoryConnectorServiceClient


public interface IMSSharePointContentRepositoryConnectorServiceClient

Microsoft SharePoint Content Repository Connector service client interface:

This interface contains all methods that can be invoked on the service using the service client

Since:
08 Oct 2009

Method Summary
 boolean cancelFileCheckOut(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl)
          Cancels the check-out of the document identified by the file URL.
 boolean checkInFile(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl, Boolean isMajor, String comment)
          Checks-in an existing file to the SharePoint server.
 boolean checkOutFile(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl)
          Check-out a document identified by the file URL, from the SharePoint repository.
 CreateDocumentResultType createDocument(LoginSettings loginSettings, String siteUrl, String documentLibraryName, Document inputDoc, String folderUrl, String newFileName, Boolean updateInSameTransaction, Map properties)
          Creates a new document in a SharePoint Document library.
 String createFolder(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String folderUrl, String newFolderName)
          Creates a new folder in SharePoint document library.
 void delete(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl)
          Deletes a file or folder, if it exists.
 Map getProperties(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl)
          Returns all the properties of a document from a SharePoint document library.
 Document retrieveDocumentContent(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl)
          Retrieves Document content as a com.adobe.Document object.
 SearchQueryResultType search(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String folderUrl, String keyword, String customScope, int maxResults)
          Queries at a given Microsoft SharePoint site.
 String setDocumentContent(LoginSettings loginSettings, String siteUrl, String documentLibraryName, Document inputDoc, String fileUrl)
          Updates the content of an existing document.
 void updateProperties(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl, Boolean updateInSameTransaction, Map propertiesMap)
          Updates the properties of an existing document.
 

Method Detail

search

SearchQueryResultType search(LoginSettings loginSettings,
                             String siteUrl,
                             String documentLibraryName,
                             String folderUrl,
                             String keyword,
                             String customScope,
                             int maxResults)
                             throws SharePointConnectorException
Queries at a given Microsoft SharePoint site.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Optional. Document library name. Specify a document library name if you want the search to be restricted to a specific document library.
folderUrl - Optional. Parent folder URL. Specify a folder URL if you want your search to be restricted to the specific document library and its subfolders only.
keyword - Required. Keyword to search for in SharePoint.
customScope - Optional. Name of the custom scope used to perform the search operation. When specified, results returned are those custom scope results that satisfy all the four criteria of:
  • SiteUrl,
  • documentLibraryName,
  • folderURL,
  • and
  • customScope.
maxResults - Optional. Maximum results to return after search. Default value is 10.
Returns:
An object of type SearchQueryResultType which contains the total search counts, total available, search status (Successful or UnSuccessful) and a list of searchDocuments. Each search document represents one document in SharePoint with following information about it:
  • Author
  • Absolute URL (absolute HTTP location of the document)
  • Relative URL (Parent folder and sub-folder path of the document)
  • Title
  • isDocument property
If the value of search counts equals the value of total available, it indicates that all results have been returned by this operation. The parameter 'total available' indicates the total available results for the search query on the SharePoint site. You can increase maxResults if the value of search counts is lesser than the value of total available.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Any other axis fault exceptions

createFolder

String createFolder(LoginSettings loginSettings,
                    String siteUrl,
                    String documentLibraryName,
                    String folderUrl,
                    String newFolderName)
                    throws SharePointConnectorException
Creates a new folder in SharePoint document library. Can also be used to create sub folders within an existing folder in the document library.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
folderUrl - Optional. Parent folder URL. If you want to create a folder directly within a document library, leave this paramter as blank.
newFolderName - Optional. Name of the new folder. The folder name should not be prefixed or suffixed with forward slash or backward slash.
Returns:
Returns the relative URL of the new folder. For example, folderURL + "/" + newFolderName.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - If parent folder is specified but does not exist.
SharePointConnectorException - If newFolderName specified is invalid (prefixed or suffixed with forward slash or backward slash).
SharePointConnectorException - Any other axis fault exceptions

delete

void delete(LoginSettings loginSettings,
            String siteUrl,
            String documentLibraryName,
            String fileUrl)
            throws SharePointConnectorException
Deletes a file or folder, if it exists. If the file or folder does not exist, no operation is performed.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL of an existing file or folder. The URL should not be prefixed or suffixed with forward slash or backward slash. No exception is thrown if the folder does not exist.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - Any other axis fault exceptions.

createDocument

CreateDocumentResultType createDocument(LoginSettings loginSettings,
                                        String siteUrl,
                                        String documentLibraryName,
                                        Document inputDoc,
                                        String folderUrl,
                                        String newFileName,
                                        Boolean updateInSameTransaction,
                                        Map properties)
                                        throws SharePointConnectorException
Creates a new document in a SharePoint Document library. If the doucment being created already exists, this operation has no effect. Note: You cannot update document properties using this method. Use updateProperties instead.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
inputDoc - Required. Contents of the file being created.
folderUrl - Optional. Parent folder of the new document. If the new document is required to be created directly at the document library level, do not provide a value for this parameter.
newFileName - Required. Name of the new file. This name is also used to identify if the file exists or not.
updateInSameTransaction - Optional. Flag that specifies whether to set either all or none of the properties. When set to True, either all properties or none are set (No properties are set if even a single property fails to be set). When set to False, all correct properties are set, and incorrect properties are not set.
properties - Optional. A hash map containing name-value pair of document properties.
Returns:
An object of CreateDocumentResultType. CreateDocumentResultType is a complex object containing:
  • absoluteUrl . The absolute URL of the created file.
  • relativeURL. The relative URL of the of the created file. The relative URL is relative to the document library, and does not contain the siteUrl and the documentLibraryName
  • fileUploadSuccess. A flag that indicates if the operation to create the document was a success or not.
Throws:
SharePointConnectorException - Authentication failure
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect DocumentLibrary value
SharePointConnectorException - Malformed or incorrect input. For example, extra slashes in documentLibraryName, folderUrl or newFileName.

getProperties

Map getProperties(LoginSettings loginSettings,
                  String siteUrl,
                  String documentLibraryName,
                  String fileUrl)
                  throws SharePointConnectorException
Returns all the properties of a document from a SharePoint document library.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL of an existing file. If the file does not exist, an exception is thrown.
Returns:
A map containing name-value pairs of document properties.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect file URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - Any other axis fault exceptions.

retrieveDocumentContent

Document retrieveDocumentContent(LoginSettings loginSettings,
                                 String siteUrl,
                                 String documentLibraryName,
                                 String fileUrl)
                                 throws SharePointConnectorException
Retrieves Document content as a com.adobe.Document object.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL of an existing file. If the file does not exist, an exception is thrown.
Returns:
A Document object with the content of the document specified in fileURL.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect file URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - Any other axis fault exceptions.

setDocumentContent

String setDocumentContent(LoginSettings loginSettings,
                          String siteUrl,
                          String documentLibraryName,
                          Document inputDoc,
                          String fileUrl)
                          throws SharePointConnectorException
Updates the content of an existing document.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
inputDoc - Required. Document object representing the new content of the file.
fileUrl - Required. Relative URL of an existing file. If the file does not exist, an exception is thrown.
Returns:
Returns the absolute URL of the document.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - If the document does not exist.
SharePointConnectorException - Incorrect file URL.
SharePointConnectorException - If the user does not have sufficient permissions over the document.
SharePointConnectorException - Any other axis fault exceptions.

updateProperties

void updateProperties(LoginSettings loginSettings,
                      String siteUrl,
                      String documentLibraryName,
                      String fileUrl,
                      Boolean updateInSameTransaction,
                      Map propertiesMap)
                      throws SharePointConnectorException
Updates the properties of an existing document. Note: Property names provided in this operation and those in SharePoint must be an exact match.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL of an existing file. If the file does not exist, an exception is thrown.
updateInSameTransaction - Optional. Flag that specifies whether to set all or none of the properties.
propertiesMap - Required. A hash map containing name-value pairs of file properties.
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect site URL.
SharePointConnectorException - Incorrect Document Library Name.
SharePointConnectorException - Incorrect FileUrl specified. The file does not exist, or is inaccessible.
SharePointConnectorException - If the document does not exist.
SharePointConnectorException - If the user does not have sufficient permissions over the document.
SharePointConnectorException - Any other axis fault exceptions.

checkInFile

boolean checkInFile(LoginSettings loginSettings,
                    String siteUrl,
                    String documentLibraryName,
                    String fileUrl,
                    Boolean isMajor,
                    String comment)
                    throws SharePointConnectorException
Checks-in an existing file to the SharePoint server.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL for an existing file. If the file does not exist an exception is thrown.
isMajor - Optional. A flag that indicates how the version of the document is updated.
comment - Optional. Comment associated with the check-in.
Returns:
true, if the file is checked-in (the file was checked-out before this operation). false, if the file is not checked-in (because the file is already checked-in).
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect siteUrl specified.
SharePointConnectorException - Incorrect DocumentLibrary specified.
SharePointConnectorException - Incorrect FileUrl specified.
SharePointConnectorException - Incorrect UpdateVersionType as per the documentLibrarySettings in SharePoint.

checkOutFile

boolean checkOutFile(LoginSettings loginSettings,
                     String siteUrl,
                     String documentLibraryName,
                     String fileUrl)
                     throws SharePointConnectorException
Check-out a document identified by the file URL, from the SharePoint repository. If the file is already checked-out to the same user, this method returns false. If not already checked-out, the file is checked-out to the user, and the method returns true.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL for an existing file. If the file does not exist, an exception is thrown.
Returns:
A flag indicating if the operation successfully checked-out the file(true), or if the file is already checked-out to the user(false).
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect siteUrl specified.
SharePointConnectorException - Incorrect DocumentLibrary specified.
SharePointConnectorException - Incorrect FileUrl specified. The file does not exist, or is inaccessible.
SharePointConnectorException - If the file is already checked-out by another user and the users have different check-in or check-out rights.

cancelFileCheckOut

boolean cancelFileCheckOut(LoginSettings loginSettings,
                           String siteUrl,
                           String documentLibraryName,
                           String fileUrl)
                           throws SharePointConnectorException
Cancels the check-out of the document identified by the file URL. If the file is checked-in, this method returns false and performs no further actions. If the file is already checked-out, this operation reverts the check-out operation and returns true.

Parameters:
loginSettings - Required. Configuration settings required to connect to the Microsoft SharePoint site.
siteUrl - Required. Microsoft SharePoint site URL.
documentLibraryName - Required. Document Library name.
fileUrl - Required. Relative URL for an existing file. If the file does not exist an exception is thrown.
Returns:
A flag indicating if the check-out was successfully reverted (true), or if the file was not checked-out (false)
Throws:
SharePointConnectorException - Authentication failure.
SharePointConnectorException - Incorrect siteUrl specified.
SharePointConnectorException - Incorrect DocumentLibrary specified.
SharePointConnectorException - Incorrect FileUrl specified. The file does not exist, or is inaccessible.
SharePointConnectorException - If the file is already checked-out by another user and the users have different check-in or check-out rights.