|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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 |
---|
SearchQueryResultType search(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String folderUrl, String keyword, String customScope, int maxResults) throws SharePointConnectorException
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
,customScope
.maxResults
- Optional. Maximum results to return after search. Default value is 10.
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:
isDocument
propertymaxResults
if the value of search counts is lesser than the
value of total available.
SharePointConnectorException
- Authentication failure.
SharePointConnectorException
- Incorrect site URL.
SharePointConnectorException
- Any other axis fault exceptionsString createFolder(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String folderUrl, String newFolderName) throws SharePointConnectorException
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.
folderURL
+ "/
" + newFolderName
.
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 exceptionsvoid delete(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl) throws SharePointConnectorException
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.
SharePointConnectorException
- Authentication failure.
SharePointConnectorException
- Incorrect site URL.
SharePointConnectorException
- Incorrect Document Library Name.
SharePointConnectorException
- Any other axis fault exceptions.CreateDocumentResultType createDocument(LoginSettings loginSettings, String siteUrl, String documentLibraryName, Document inputDoc, String folderUrl, String newFileName, Boolean updateInSameTransaction, Map properties) throws SharePointConnectorException
updateProperties
instead.
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.
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.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
.Map getProperties(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl) throws SharePointConnectorException
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.
map
containing name-value pairs of document properties.
SharePointConnectorException
- Authentication failure.
SharePointConnectorException
- Incorrect site URL.
SharePointConnectorException
- Incorrect file URL.
SharePointConnectorException
- Incorrect Document Library Name.
SharePointConnectorException
- Any other axis fault exceptions.Document retrieveDocumentContent(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl) throws SharePointConnectorException
com.adobe.Document
object.
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.
Document
object with the content of the document specified in fileURL
.
SharePointConnectorException
- Authentication failure.
SharePointConnectorException
- Incorrect site URL.
SharePointConnectorException
- Incorrect file URL.
SharePointConnectorException
- Incorrect Document Library Name.
SharePointConnectorException
- Any other axis fault exceptions.String setDocumentContent(LoginSettings loginSettings, String siteUrl, String documentLibraryName, Document inputDoc, String fileUrl) throws SharePointConnectorException
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.
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.void updateProperties(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl, Boolean updateInSameTransaction, Map propertiesMap) throws SharePointConnectorException
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.
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.boolean checkInFile(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl, Boolean isMajor, String comment) throws SharePointConnectorException
isMajor
set to true
updates the major versionisMajor
set to false
updates the minor versionisMajor
set to NULL
throws an exception
indicating that there might be an error in the input parameter
isMajor
set to true
updates the major version.isMajor
set to false
updates the major version.isMajor
set to NULL
keeps the same version.
isMajor
parameter does not have any effect on the check-in operation.
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.
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).
SharePointConnectorException
- Authentication failure.
SharePointConnectorException
- Incorrect siteUrl
specified.
SharePointConnectorException
- Incorrect DocumentLibrary
specified.
SharePointConnectorException
- Incorrect FileUrl
specified.
SharePointConnectorException
- Incorrect UpdateVersionType
as per the documentLibrarySettings
in SharePoint.boolean checkOutFile(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl) throws SharePointConnectorException
false
. If not already checked-out, the file is checked-out
to the user, and the method returns true
.
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.
true
),
or if the file is already checked-out to the user(false
).
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.boolean cancelFileCheckOut(LoginSettings loginSettings, String siteUrl, String documentLibraryName, String fileUrl) throws SharePointConnectorException
false
and performs no further actions. If the file is already checked-out,
this operation reverts the check-out operation and returns true
.
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.
true
),
or if the file was not checked-out (false
)
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |