|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IDocumentManagementService
The DocumentManagementService provides all functionality for DMS operations in a CARNOT runtime environment. This includes: retrieving, adding, updating and deleting documents and folders, versioning documents, retrieving and updating document content. This class was generated by Apache CXF 2.6.1 2016-02-25T15:28:24.528+01:00 Generated source version: 2.6.1
| Method Summary | |
|---|---|
void |
bindRepository(RepositoryConfigurationXto repositoryConfiguration)
Binds a new repository instance. |
DocumentXto |
createDocument(String folderId,
boolean createMissingFolders,
DocumentInfoXto documentInfo,
DataHandler content,
DocumentVersionInfoXto versionInfo)
Creates document in a folder described by the document info. |
DocumentsXto |
createDocuments(InputDocumentsXto inputDocuments,
Boolean createMissingFolders)
Creates multiple documents in folders described by the corresponding document info. |
FolderXto |
createFolder(String parentFolderId,
FolderInfoXto folderInfo)
Creates a folder described by the folderInfo in the folder specified by parentFolderId. |
DocumentsXto |
findDocuments(DocumentQueryXto documentQuery)
Gets Documents based on the name pattern or XPath Query search. |
FoldersXto |
findFolders(FolderQueryXto folderQuery)
Gets folders based on the name pattern or XPath query. |
String |
getDefaultRepository()
Allows to identify the currently set default repository. |
DocumentXto |
getDocument(String documentId,
QName metaDataType)
Gets the document by ID or path. |
DataHandler |
getDocumentContent(String documentId)
Retrieves the content of the document identified by documentId. |
DocumentsXto |
getDocuments(org.eclipse.stardust.engine.api.ws.GetDocuments.DocumentIdsXto documentIds,
QName metaDataType)
Gets multiple documents by ID or path. |
DocumentTypeResultsXto |
getDocumentTypes(String modelId)
Gets a list of document types defined in all alive models. |
XmlValueXto |
getDocumentTypeSchema(String schemaLocation)
Gets the schema definition referenced by a document type schema location. |
DocumentsXto |
getDocumentVersions(String documentId,
QName metaDataType)
Gets all versions of the document by document ID (of any of its version). |
FolderXto |
getFolder(String folderId,
FolderLevelOfDetailXto folderLevelOfDetail,
QName documentMetaDataType,
QName folderMetaDataType)
Retrieves a folder. |
FoldersXto |
getFolders(org.eclipse.stardust.engine.api.ws.GetFolders.FolderIdsXto folderIds,
FolderLevelOfDetailXto folderLevelOfDetail,
QName documentMetaDataType,
QName folderMetaDataType)
Gets multiple folders by ID or path. |
AccessControlPoliciesXto |
getPolicies(String resourceId,
PolicyScopeXto policyScope)
Returns the Access Control Policies for the resource denoted by resourceId by the specified scope. |
PrivilegesXto |
getPrivileges(String resourceId)
Returns the privileges the session has for the resource denoted by resourceId, which must exist. |
RepositoryInstanceInfosXto |
getRepositoryInstanceInfos()
Provides information about all bound repositories. |
RepositoryProviderInfosXto |
getRepositoryProviderInfos()
Provides information about all available repository providers. |
RepositoryMigrationReportXto |
migrateRepository(int batchSize,
boolean evaluateTotalCount,
String repositoryId)
Migrates resources in the repository. |
DocumentXto |
moveDocument(String documentId,
String targetPath)
Allows to identify the currently set default repository. |
void |
removeDocument(String documentId)
Removes document. |
void |
removeDocumentVersion(String documentId,
String documentRevisionId)
Allows to identify the currently set default repository. |
void |
removeFolder(String folderId,
Boolean recursive)
Removes folder. |
String |
requestDocumentContentDownload(String documentId)
Initiates document content download via DmsContentServlet. |
String |
requestDocumentContentUpload(String documentId)
Initiates document content upload via DmsContentServlet. |
void |
setDefaultRepository(String repositoryId)
Allows to set a bound repository as default repository. |
void |
setPolicy(String resourceId,
AccessControlPolicyXto accessControlPolicy)
Binds the policy to the resource denoted by resourceId (overwrites the old version of the policy) If the policy does not contain any Access Control Entry then this policy is removed from the resource. |
void |
unbindRepository(String repositoryId)
Unbinds a previously bound repository. |
DocumentXto |
updateDocument(String documentId,
DocumentInfoXto documentInfo,
DataHandler content,
DocumentVersionInfoXto versionInfo)
Updates document. |
FolderXto |
updateFolder(FolderXto updateFolder)
Updates folder. |
DocumentXto |
versionDocument(String documentId,
String versionComment,
String versionLabel)
Creates a new version of the document. |
| Method Detail |
|---|
@RequestWrapper(localName="bindRepository",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.BindRepository")
@ResponseWrapper(localName="bindRepositoryResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.BindRepositoryResponse")
void bindRepository(RepositoryConfigurationXto repositoryConfiguration)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocumentVersions",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentVersions")
@ResponseWrapper(localName="getDocumentVersionsResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentVersionsResponse")
DocumentsXto getDocumentVersions(String documentId,
QName metaDataType)
throws BpmFault
BpmFault
@RequestWrapper(localName="removeDocumentVersion",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveDocumentVersion")
@ResponseWrapper(localName="removeDocumentVersionResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveDocumentVersionResponse")
void removeDocumentVersion(String documentId,
String documentRevisionId)
throws BpmFault
BpmFault
@RequestWrapper(localName="versionDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.VersionDocument")
@ResponseWrapper(localName="versionDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.VersionDocumentResponse")
DocumentXto versionDocument(String documentId,
String versionComment,
String versionLabel)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocument")
@ResponseWrapper(localName="getDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentResponse")
DocumentXto getDocument(String documentId,
QName metaDataType)
throws BpmFault
BpmFault
@RequestWrapper(localName="createDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateDocument")
@ResponseWrapper(localName="createDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateDocumentResponse")
DocumentXto createDocument(String folderId,
boolean createMissingFolders,
DocumentInfoXto documentInfo,
DataHandler content,
DocumentVersionInfoXto versionInfo)
throws BpmFault
BpmFault
@RequestWrapper(localName="getRepositoryInstanceInfos",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetRepositoryInstanceInfos")
@ResponseWrapper(localName="getRepositoryInstanceInfosResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetRepositoryInstanceInfosResponse")
RepositoryInstanceInfosXto getRepositoryInstanceInfos()
throws BpmFault
BpmFault
@RequestWrapper(localName="updateFolder",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UpdateFolder")
@ResponseWrapper(localName="updateFolderResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UpdateFolderResponse")
FolderXto updateFolder(FolderXto updateFolder)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocuments",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocuments")
@ResponseWrapper(localName="getDocumentsResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentsResponse")
DocumentsXto getDocuments(org.eclipse.stardust.engine.api.ws.GetDocuments.DocumentIdsXto documentIds,
QName metaDataType)
throws BpmFault
BpmFault
@RequestWrapper(localName="findDocuments",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.FindDocuments")
@ResponseWrapper(localName="findDocumentsResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.FindDocumentsResponse")
DocumentsXto findDocuments(DocumentQueryXto documentQuery)
throws BpmFault
BpmFault
@RequestWrapper(localName="createFolder",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateFolder")
@ResponseWrapper(localName="createFolderResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateFolderResponse")
FolderXto createFolder(String parentFolderId,
FolderInfoXto folderInfo)
throws BpmFault
BpmFault
@RequestWrapper(localName="setPolicy",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.SetPolicy")
@ResponseWrapper(localName="setPolicyResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.SetPolicyResponse")
void setPolicy(String resourceId,
AccessControlPolicyXto accessControlPolicy)
throws BpmFault
BpmFault
@RequestWrapper(localName="requestDocumentContentUpload",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RequestDocumentContentUpload")
@ResponseWrapper(localName="requestDocumentContentUploadResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RequestDocumentContentUploadResponse")
String requestDocumentContentUpload(String documentId)
throws BpmFault
BpmFault
@RequestWrapper(localName="setDefaultRepository",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.SetDefaultRepository")
@ResponseWrapper(localName="setDefaultRepositoryResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.SetDefaultRepositoryResponse")
void setDefaultRepository(String repositoryId)
throws BpmFault
BpmFault
@RequestWrapper(localName="moveDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.MoveDocument")
@ResponseWrapper(localName="moveDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.MoveDocumentResponse")
DocumentXto moveDocument(String documentId,
String targetPath)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocumentTypeSchema",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentTypeSchema")
@ResponseWrapper(localName="getDocumentTypeSchemaResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentTypeSchemaResponse")
XmlValueXto getDocumentTypeSchema(String schemaLocation)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocumentTypes",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentTypes")
@ResponseWrapper(localName="getDocumentTypesResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentTypesResponse")
DocumentTypeResultsXto getDocumentTypes(String modelId)
throws BpmFault
BpmFault
@RequestWrapper(localName="createDocuments",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateDocuments")
@ResponseWrapper(localName="createDocumentsResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.CreateDocumentsResponse")
DocumentsXto createDocuments(InputDocumentsXto inputDocuments,
Boolean createMissingFolders)
throws BpmFault
BpmFault
@RequestWrapper(localName="getFolders",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetFolders")
@ResponseWrapper(localName="getFoldersResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetFoldersResponse")
FoldersXto getFolders(org.eclipse.stardust.engine.api.ws.GetFolders.FolderIdsXto folderIds,
FolderLevelOfDetailXto folderLevelOfDetail,
QName documentMetaDataType,
QName folderMetaDataType)
throws BpmFault
BpmFault
@RequestWrapper(localName="findFolders",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.FindFolders")
@ResponseWrapper(localName="findFoldersResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.FindFoldersResponse")
FoldersXto findFolders(FolderQueryXto folderQuery)
throws BpmFault
BpmFault
@RequestWrapper(localName="removeFolder",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveFolder")
@ResponseWrapper(localName="removeFolderResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveFolderResponse")
void removeFolder(String folderId,
Boolean recursive)
throws BpmFault
BpmFault
@RequestWrapper(localName="updateDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UpdateDocument")
@ResponseWrapper(localName="updateDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UpdateDocumentResponse")
DocumentXto updateDocument(String documentId,
DocumentInfoXto documentInfo,
DataHandler content,
DocumentVersionInfoXto versionInfo)
throws BpmFault
BpmFault
@RequestWrapper(localName="migrateRepository",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.MigrateRepository")
@ResponseWrapper(localName="migrateRepositoryResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.MigrateRepositoryResponse")
RepositoryMigrationReportXto migrateRepository(int batchSize,
boolean evaluateTotalCount,
String repositoryId)
throws BpmFault
BpmFault
@RequestWrapper(localName="getFolder",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetFolder")
@ResponseWrapper(localName="getFolderResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetFolderResponse")
FolderXto getFolder(String folderId,
FolderLevelOfDetailXto folderLevelOfDetail,
QName documentMetaDataType,
QName folderMetaDataType)
throws BpmFault
BpmFault
@RequestWrapper(localName="requestDocumentContentDownload",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RequestDocumentContentDownload")
@ResponseWrapper(localName="requestDocumentContentDownloadResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RequestDocumentContentDownloadResponse")
String requestDocumentContentDownload(String documentId)
throws BpmFault
BpmFault
@RequestWrapper(localName="getRepositoryProviderInfos",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetRepositoryProviderInfos")
@ResponseWrapper(localName="getRepositoryProviderInfosResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetRepositoryProviderInfosResponse")
RepositoryProviderInfosXto getRepositoryProviderInfos()
throws BpmFault
BpmFault
@RequestWrapper(localName="getPolicies",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetPolicies")
@ResponseWrapper(localName="getPoliciesResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetPoliciesResponse")
AccessControlPoliciesXto getPolicies(String resourceId,
PolicyScopeXto policyScope)
throws BpmFault
BpmFault
@RequestWrapper(localName="getPrivileges",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetPrivileges")
@ResponseWrapper(localName="getPrivilegesResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetPrivilegesResponse")
PrivilegesXto getPrivileges(String resourceId)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDefaultRepository",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDefaultRepository")
@ResponseWrapper(localName="getDefaultRepositoryResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDefaultRepositoryResponse")
String getDefaultRepository()
throws BpmFault
BpmFault
@RequestWrapper(localName="unbindRepository",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UnbindRepository")
@ResponseWrapper(localName="unbindRepositoryResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.UnbindRepositoryResponse")
void unbindRepository(String repositoryId)
throws BpmFault
BpmFault
@RequestWrapper(localName="getDocumentContent",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentContent")
@ResponseWrapper(localName="getDocumentContentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.GetDocumentContentResponse")
DataHandler getDocumentContent(String documentId)
throws BpmFault
BpmFault
@RequestWrapper(localName="removeDocument",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveDocument")
@ResponseWrapper(localName="removeDocumentResponse",
targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
className="org.eclipse.stardust.engine.api.ws.RemoveDocumentResponse")
void removeDocument(String documentId)
throws BpmFault
BpmFault
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||