IDocumentManagementService (stardust-engine-ws-cxf)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.stardust.engine.api.ws
Interface IDocumentManagementService

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 2013-03-05T11:35:31.328+01:00 Generated source version: 2.6.1

Method Summary
`DocumentXto`	`createDocument(java.lang.String folderId, boolean createMissingFolders, DocumentInfoXto documentInfo, javax.activation.DataHandler content, DocumentVersionInfoXto versionInfo)` Creates document in a folder described by the document info.
`DocumentsXto`	`createDocuments(InputDocumentsXto inputDocuments, java.lang.Boolean createMissingFolders)` Creates multiple documents in folders described by the corresponding document info.
`FolderXto`	`createFolder(java.lang.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.
`DocumentXto`	`getDocument(java.lang.String documentId, javax.xml.namespace.QName metaDataType)` Gets the document by ID or path.
`javax.activation.DataHandler`	`getDocumentContent(java.lang.String documentId)` Retrieves the content of the document identified by documentId.
`DocumentsXto`	`getDocuments(org.eclipse.stardust.engine.api.ws.GetDocuments.DocumentIdsXto documentIds, javax.xml.namespace.QName metaDataType)` Gets multiple documents by ID or path.
`DocumentTypeResultsXto`	`getDocumentTypes(java.lang.String modelId)` Gets a list of document types defined in all alive models.
`XmlValueXto`	`getDocumentTypeSchema(java.lang.String schemaLocation)` Gets the schema definition referenced by a document type schema location.
`DocumentsXto`	`getDocumentVersions(java.lang.String documentId, javax.xml.namespace.QName metaDataType)` Gets all versions of the document by document ID (of any of its version).
`FolderXto`	`getFolder(java.lang.String folderId, FolderLevelOfDetailXto folderLevelOfDetail, javax.xml.namespace.QName documentMetaDataType, javax.xml.namespace.QName folderMetaDataType)` Retrieves a folder.
`FoldersXto`	`getFolders(org.eclipse.stardust.engine.api.ws.GetFolders.FolderIdsXto folderIds, FolderLevelOfDetailXto folderLevelOfDetail, javax.xml.namespace.QName documentMetaDataType, javax.xml.namespace.QName folderMetaDataType)` Gets multiple folders by ID or path.
`AccessControlPoliciesXto`	`getPolicies(java.lang.String resourceId, PolicyScopeXto policyScope)` Returns the Access Control Policies for the resource denoted by resourceId by the specified scope.
`PrivilegesXto`	`getPrivileges(java.lang.String resourceId)` Returns the privileges the session has for the resource denoted by resourceId, which must exist.
`RepositoryMigrationReportXto`	`migrateRepository(int batchSize, boolean evaluateTotalCount)` Migrates resources in the repository.
`void`	`removeDocument(java.lang.String documentId)` Removes document.
`void`	`removeFolder(java.lang.String folderId, java.lang.Boolean recursive)` Removes folder.
`java.lang.String`	`requestDocumentContentDownload(java.lang.String documentId)` Initiates document content download via DmsContentServlet.
`java.lang.String`	`requestDocumentContentUpload(java.lang.String documentId)` Initiates document content upload via DmsContentServlet.
`void`	`setPolicy(java.lang.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.
`DocumentXto`	`updateDocument(java.lang.String documentId, DocumentInfoXto documentInfo, javax.activation.DataHandler content, DocumentVersionInfoXto versionInfo)` Updates document.
`FolderXto`	`updateFolder(FolderXto updateFolder)` Updates folder.
`DocumentXto`	`versionDocument(java.lang.String documentId, java.lang.String versionComment, java.lang.String versionLabel)` Creates a new version of the document.

Method Detail

getDocumentVersions

@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(java.lang.String documentId,
                                                                javax.xml.namespace.QName metaDataType)
                                 throws BpmFault

Gets all versions of the document by document ID (of any of its version).

Throws:: BpmFault

versionDocument

@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(java.lang.String documentId,
                                                           java.lang.String versionComment,
                                                           java.lang.String versionLabel)
                            throws BpmFault

Creates a new version of the document.

Throws:: BpmFault

getDocument

@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(java.lang.String documentId,
                                                       javax.xml.namespace.QName metaDataType)
                        throws BpmFault

Gets the document by ID or path.

Throws:: BpmFault

createDocument

@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(java.lang.String folderId,
                                                          boolean createMissingFolders,
                                                          DocumentInfoXto documentInfo,
                                                          javax.activation.DataHandler content,
                                                          DocumentVersionInfoXto versionInfo)
                           throws BpmFault

Creates document in a folder described by the document info.

Throws:: BpmFault

updateFolder

@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

Updates folder.

Throws:: BpmFault

getDocuments

@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,
                                                         javax.xml.namespace.QName metaDataType)
                          throws BpmFault

Gets multiple documents by ID or path.

Throws:: BpmFault

findDocuments

@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

Gets Documents based on the name pattern or XPath Query search.

Throws:: BpmFault

createFolder

@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(java.lang.String parentFolderId,
                                                      FolderInfoXto folderInfo)
                       throws BpmFault

Creates a folder described by the folderInfo in the folder specified by parentFolderId.

Throws:: BpmFault

setPolicy

@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(java.lang.String resourceId,
                                              AccessControlPolicyXto accessControlPolicy)
               throws BpmFault

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.

Throws:: BpmFault

requestDocumentContentUpload

@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")
java.lang.String requestDocumentContentUpload(java.lang.String documentId)
                                              throws BpmFault

Initiates document content upload via DmsContentServlet.

Throws:: BpmFault

getDocumentTypeSchema

@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(java.lang.String schemaLocation)
                                  throws BpmFault

Gets the schema definition referenced by a document type schema location.

Throws:: BpmFault

getDocumentTypes

@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(java.lang.String modelId)
                                        throws BpmFault

Gets a list of document types defined in all alive models. Can be limited to a specified modelId.

Throws:: BpmFault

createDocuments

@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,
                                                            java.lang.Boolean createMissingFolders)
                             throws BpmFault

Creates multiple documents in folders described by the corresponding document info.

Throws:: BpmFault

getFolders

@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,
                                                     javax.xml.namespace.QName documentMetaDataType,
                                                     javax.xml.namespace.QName folderMetaDataType)
                      throws BpmFault

Gets multiple folders by ID or path.

Throws:: BpmFault

findFolders

@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

Gets folders based on the name pattern or XPath query.

Throws:: BpmFault

removeFolder

@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(java.lang.String folderId,
                                                 java.lang.Boolean recursive)
                  throws BpmFault

Removes folder.

Throws:: BpmFault

updateDocument

@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(java.lang.String documentId,
                                                          DocumentInfoXto documentInfo,
                                                          javax.activation.DataHandler content,
                                                          DocumentVersionInfoXto versionInfo)
                           throws BpmFault

Updates document.

Throws:: BpmFault

migrateRepository

@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)
                                               throws BpmFault

Migrates resources in the repository. This migration process works sequential from the current version to the next higher version. The count of resources migrated in one execution is limited by the parameter batchSize. Subsequent calls will migrate further resources if there are resources for migration available. After all resources for the migration from one version to the next are processed subsequent calls will start the migration to the next higher repository structure version. The migration is complete if the current version of the repository reaches the target version defined by the repository. Important Note Please ensure there is no other write access on the repository to avoid race conditions! Since there is no locking mechanism this should be run in read-only maintenance window! The MigrationReport returned by each call contains information about: Total resources that need migration to the next version, resources already migrated, current version, next version and target version of the repository structure.

Throws:: BpmFault

getFolder

@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(java.lang.String folderId,
                                                   FolderLevelOfDetailXto folderLevelOfDetail,
                                                   javax.xml.namespace.QName documentMetaDataType,
                                                   javax.xml.namespace.QName folderMetaDataType)
                    throws BpmFault

Retrieves a folder.

Throws:: BpmFault

requestDocumentContentDownload

@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")
java.lang.String requestDocumentContentDownload(java.lang.String documentId)
                                                throws BpmFault

Initiates document content download via DmsContentServlet.

Throws:: BpmFault

getPolicies

@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(java.lang.String resourceId,
                                                                    PolicyScopeXto policyScope)
                                     throws BpmFault

Returns the Access Control Policies for the resource denoted by resourceId by the specified scope. All: Policies that are currently set. Applicable: Policy template which has to be used if no policy is set. (Empty if policies were set once, use 'All' scope to retrieve Policies in this case.) Effective: Effective policies, including implicit Policies from e.g. Administrator or Everyone group.

Throws:: BpmFault

getPrivileges

@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(java.lang.String resourceId)
                            throws BpmFault

Returns the privileges the session has for the resource denoted by resourceId, which must exist.

Throws:: BpmFault

getDocumentContent

@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")
javax.activation.DataHandler getDocumentContent(java.lang.String documentId)
                                                throws BpmFault

Retrieves the content of the document identified by documentId.

Throws:: BpmFault

removeDocument

@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(java.lang.String documentId)
                    throws BpmFault

Removes document.

Throws:: BpmFault