Package com.opentext.livelink.service.docman

Class DocumentManagement_JAXWS

  • public class DocumentManagement_JAXWS
extends java.lang.Object
    DocumentManagement defines the service that is responsible for document management operations in Content Server.
    Version:
    2017-10-04

    • Constructor Detail

      • DocumentManagement_JAXWS

        public DocumentManagement_JAXWS()

    • Method Detail

      • addFavorite

        public void addFavorite​(long nodeID)
        Add a Favorite for the given object.
        Parameters:
        nodeID - ID of the node for the Favorite.

      • addMajorVersion

        public Version addMajorVersion​(long ID,
                               Metadata metadata,
                               Attachment attach)
        Add a major version to a node which uses advanced versioning.
        Parameters:
        ID - ID of the node.
        metadata - New metadata for the version; null if no changes.
        fileAtts - Description of the file uploaded as the initial version content, null if no changes
        inStream - Contents
        Returns:
        Returns a version object. Throws fault exception with fault codes: DocMan.ErrorCreatingVersion, DocMan.NodeDoesNotSupportAddingVersions, DocMan.NodeRetrievalError.

      • addMajorVersionContext

        public java.lang.String addMajorVersionContext​(long ID,
                                               Metadata metadata)
        Store the meta-data for adding a major version to a node which uses advanced versioning in a method context on the server. It will actually be created when ContentService.UploadContent() is called.
        Parameters:
        ID - ID of the node.
        metadata - New metadata for the version; null if no changes.
        Returns:
        ContextID used to upload the major version contents using the ContentService. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • addNodeRight

        public void addNodeRight​(long ID,
                         NodeRight nodeRight)
        Adds a right to a node. Owner, OwnerGroup and Public Access rights will be restored if they have been removed.
        Parameters:
        ID - The ID of the node to add a right to.
        nodeRight - The node right to add.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorAddingNodeRight - An error occured when trying to add the node right.
        DocMan.InvalidNodeRight - The NodeRight object is invalid.
        DocMan.InvalidNodeRightID - The NodeRight's right ID is invalid.
        DocMan.InvalidNodeRightPermissions - The NodeRight's NodePermissions object is invalid.
        DocMan.InvalidNodeRightType - The NodeRight's type is invalid.
        DocMan.NodeRetrievalError - An error occured when trying to get the node. Possibly an invalid node ID.
        DocMan.PermissionsError - The current user does not have the permissions to perform the operation.

      • addToCollection

        public void addToCollection​(long collectionID,
                            CollectionItem[] collectionItems)
        Adds items to a collection.
        Parameters:
        collectionID - The ID of the collection to add to.
        collectionItems - The list of items to add to the collection.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorAddingNodeToCollection - An error occured when trying to add a node to the collection.
        DocMan.InvalidCollectionID - An error occured when trying to get the collection node. Possibly an invalid node ID.
        DocMan.InvalidCollectionItemID - An error occured when trying to get a collection item node. Possibly an invalid node ID.
        DocMan.InvalidCollectionItemVersion - An error occured when trying to get a collection item version. Possibly an invalid version number.
        DocMan.InvalidNodeType - The node ID given is not an ID of a collection node.
        Since:
        10.0.9

      • addVersion

        public Version addVersion​(long ID,
                          Metadata metadata,
                          Attachment attach)
        Add a version to a node; if node uses advanced versioning, a minor version will be added.
        Parameters:
        ID - ID of the node
        metadata - New metadata for the version; null if no changes.
        fileAtts - Description of the file uploaded as the initial version content, null if no changes
        inStream - Contents
        Returns:
        Returns a version object. Throws fault exception with fault codes: DocMan.ErrorCreatingVersion, DocMan.NodeDoesNotSupportAddingVersions, DocMan.NodeRetrievalError.

      • addVersionContext

        public java.lang.String addVersionContext​(long ID,
                                          Metadata metadata)
        Store the meta-data for adding a version to a node in a method context on the server; if node uses advanced versioning, a minor version will be added. It will actually be created when ContentService.UploadContent() is called.
        Parameters:
        ID - ID of the node
        metadata - New metadata for the version; null if no changes.
        Returns:
        ContextID used to upload the Node version contents using the ContentService. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • copyNode

        public Node copyNode​(long ID,
                     long parentID,
                     java.lang.String newName,
                     CopyOptions copyOptions)
        Copies a node.
        Parameters:
        ID - the ID of the node to be copied.
        parentID - the parent ID of the destination for the new node.
        newName - the name for the new node. If null the copied node will inherit the original node's name (including all multilingual names).
        copyOptions - the option flags for how the copy operation will be performed. NOTE: values set in CopyOptions for: CopyCurrent, CurrentUserAsOwner, KeepVersionLocks and KeepReservedState will not be respected on the server. The latter two (KeepVersionLocks, KeepReservedState) will both be set to FALSE. This is because the behaviour of CopyNode has to be consistent with that of the normal UI (Content Server web interface).
        Returns:
        The copied node.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.NodeCopyError - The was an error copying the node.
        DocMan.NodeRetrievalError - The was an error retrieving the source node.
        DocMan.ParentNodeRetrievalError - There was an error retrieving the parent node.

      • createCategory

        public Node createCategory​(long parentID,
                           java.lang.String name,
                           java.lang.String comment,
                           Attribute[] attributes,
                           Metadata metadata)
        Create a new category.
        Parameters:
        parentID - ParentID of node in which the new category will be created.
        name - Name of the category.
        comment - Description of the category.
        attributes - The array of attributes, in order, which comprise the category.
        metadata - Metadata for the category, or null to inherit parent's metadata.
        Returns:
        Returns the newly created category Node. Throws fault exception with fault codes: DocMan.NoAttributesSpecified, DocMan.NodeAllocationError, DocMan.DuplicateName.

      • createDocument

        public Node createDocument​(long parentID,
                           java.lang.String name,
                           java.lang.String comment,
                           boolean advancedVersionControl,
                           Metadata metadata,
                           Attachment attach)
        Create a new document with the contents of the document
        Parameters:
        parentID - ParentID of node in which the new document will be created
        name - Name of the document.
        comment - Description of the document.
        advancedVersionControl - Indicates Major/Minor versioning for document.
        metadata - Metadata for the document (such as Categories, External Attributes, etc.), or null to inherit parent's metadata. NOTE: Use DocMan.GetAttributeGroupTemplate( 'ExternalAtt', 'ExternalAtt') to retrieve an AttributeGroup template with the External Attribute fields.
        fileAtts - Description of the file uploaded as the initial version content.
        inStream - Contents
        Returns:
        Returns the newly created document Node. Throws fault exception with fault codes: DocMan.CreationOfSpecifiedNodeTypeNotSupported, DocMan.ErrorGettingParentNode, DocMan.NodeCreationError, DocMan.NodeDoesNotSupportAddingVersions, DocMan.NodeTypeNotSpecified, DocMan.ParentIdNotSpecified, DocMan.DuplicateName.

      • createDocumentContext

        public java.lang.String createDocumentContext​(long parentID,
                                              java.lang.String name,
                                              java.lang.String comment,
                                              boolean advancedVersionControl,
                                              Metadata metadata)
        Store the meta-data for creating a new document in a method context on the server. It will actually be created when ContentService.UploadContent() is called.
        Parameters:
        parentID - ParentID of node in which the new document will be created
        name - Name of the document.
        comment - Description of the document.
        advancedVersionControl - Indicates Major/Minor versioning for document.
        metadata - Metadata for the document, or null to inherit parent's metadata.
        Returns:
        ContextID used to upload the document contents using the ContentService. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • createFolder

        public Node createFolder​(long parentID,
                         java.lang.String name,
                         java.lang.String comment,
                         Metadata metadata)
        Create a new folder.
        Parameters:
        parentID - ParentID of node in which the new folder will be created.
        name - Name of the folder.
        comment - Description of the folder.
        metadata - Metadata for the folder, or null to inherit parent's metadata.
        Returns:
        Returns the newly created folder Node. Throws fault exception with fault codes: DocMan.CreationOfSpecifiedNodeTypeNotSupported, DocMan.ErrorGettingParentNode, DocMan.NodeCreationError, DocMan.NodeTypeNotSpecified, DocMan.ParentIdNotSpecified, DocMan.DuplicateName.

      • createNode

        public Node createNode​(Node node)
        Create a node.
        Parameters:
        node - Node to be created.
        Returns:
        Returns the newly created object which is a subclass of Node corresponding to the specified type. Throws fault exception with fault codes: DocMan.CreationOfSpecifiedNodeTypeNotSupported, DocMan.ErrorGettingParentNode, DocMan.NodeCreationError, DocMan.NodeTypeNotSpecified, DocMan.ParentIdNotSpecified, DocMan.DuplicateName.

      • createNodeAndVersion

        public Node createNodeAndVersion​(Node node,
                                 Attachment attach)
        Create a (versionable) node with provided content as initial version.
        Parameters:
        node - Node to be created.
        fileAtts - Description of the file uploaded as the initial version content.
        inStream - Contents
        Returns:
        Returns the newly created object which is a subclass of Node corresponding to the specified type. Throws fault exception with fault codes: DocMan.CreationOfSpecifiedNodeTypeNotSupported, DocMan.ErrorGettingParentNode, DocMan.NodeCreationError, DocMan.NodeDoesNotSupportAddingVersions, DocMan.NodeTypeNotSpecified, DocMan.ParentIdNotSpecified, DocMan.DuplicateName.

      • createNodeAndVersionContext

        public java.lang.String createNodeAndVersionContext​(Node node)
        Store the meta-data for creating a (versionable) node in a method context on the server. It will actually be created when ContentService.UploadContent() is called.
        Parameters:
        node - Node to be created.
        Returns:
        ContextID used to upload the Node version contents using the ContentService. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • createRelease

        public CompoundDocRelease createRelease​(long ID,
                                        boolean major,
                                        java.lang.String releaseName)
        Create a CompoundDoc release.
        Parameters:
        ID - ID of the CompoundDoc node from which to make release.
        major - Boolean indicating if major release or minor release (aka revision).
        releaseName - Name of new release (specify null to use default name).
        Returns:
        Returns new CompoundDocRelease object. Throws fault exception with fault codes: DocMan.ErrorCreatingRelease, DocMan.ErrorStartingTransaction, DocMan.InvalidNodeType, DocMan.NodeRetrievalError, DocMan.PermissionsError, DocMan.PreReleaseCheckFailed.

      • createRendition

        public Version createRendition​(long nodeID,
                               long versionNum,
                               java.lang.String renditionType,
                               Attachment attach)
        Create a rendition of a document version.
        Parameters:
        nodeID - ID of the document node containing the version to be renditioned.
        versionNum - The version number of the version to be renditioned.
        renditionType - The identifier of the type of rendition (for example, PDF, EPS, TXT). Must be unique for this version.
        fileAtts - Information about the uploaded file.
        inStream - The content stream of the file.
        Returns:
        Returns the new rendition. Throws fault exception with fault codes: DocMan.RenditionRetrievalError, DocMan.AddRenditionError, DocMan.InvalidFileAttributes, DocMan.VersionRetrievalError, DocMan.InvalidNodeType, DocMan.NodeRetrievalError.

      • createRenditionContext

        public java.lang.String createRenditionContext​(long nodeID,
                                               long versionNum,
                                               java.lang.String renditionType)
        Store the meta-data for creating a rendition of a document version in a method context on the server. It will actually be created when ContentService.UploadContent() is called.
        Parameters:
        nodeID - ID of the document node containing the version to be renditioned.
        versionNum - The version number of the version to be renditioned.
        renditionType - The identifier of the type of rendition (for example, PDF, EPS, TXT). Must be unique for this version.
        Returns:
        ContextID used to upload the rendition contents using the Content Service. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • createShortcut

        public Node createShortcut​(long parentID,
                           java.lang.String name,
                           java.lang.String comment,
                           long sourceID,
                           Metadata metadata)
        Creates a shortcut to an object in Content Server.
        Parameters:
        parentID - The ID of the parent object to create the shortcut in.
        name - The name of the shortcut, or null to inherit the source object's name.
        comment - The description of the shortcut, or null to inherit the source object's description.
        sourceID - The ID of the source object to create the shortcut to.
        metadata - The metadata for the shortcut, or null to inherit parent's metadata.
        Returns:
        Returns the newly created shortcut node. Throws fault exception with fault codes: DocMan.NodeRetrievalError, DocMan.ErrorGettingParentNode, DocMan.NodeCreationError, DocMan.DuplicateName.

      • createSimpleDocument

        public long createSimpleDocument​(long parentID,
                                 java.lang.String name,
                                 Attachment attach)
        Creates a simple document.
        Parameters:
        parentID - The ID of the parent object to create the document in.
        name - The name of the document.
        fileAtts - A description of the file uploaded as the initial version content.
        inStream - The document contents.
        Returns:
        The ID of the document.
        Since:
        10.0.10

      • createSimpleDocumentContext

        public java.lang.String createSimpleDocumentContext​(long parentID,
                                                    java.lang.String name)
        Stores the meta-data for creating a new simple document in a method context on the server.
        Parameters:
        parentID - The ID of the parent object to create the document in.
        name - The name of the document.
        Returns:
        The context ID used to upload the document using the ContentService.
        Since:
        10.0.10

      • createSimpleFolder

        public long createSimpleFolder​(long parentID,
                               java.lang.String name)
        Creates a simple folder.
        Parameters:
        parentID - The ID of the parent object to create the folder in.
        name - The name of the folder to create.
        Returns:
        The ID of the folder.
        Since:
        10.0.10

      • createURL

        public Node createURL​(long parentID,
                      java.lang.String name,
                      java.lang.String comment,
                      java.lang.String location,
                      Metadata metadata)
        Create a new URL.
        Parameters:
        parentID - ParentID of node in which the new URL will be created.
        name - Name of the URL.
        comment - Description of the URL.
        location - Location that the URL points to.
        metadata - Metadata for the URL, or null to inherit parent's metadata.
        Returns:
        Returns the newly created URL Node. Throws fault exception with fault codes: DocMan.CouldNotAllocateNode, DocMan.NoLocationSpecified, DocMan.DuplicateName.

      • deleteNode

        public void deleteNode​(long ID)
        Delete a node.
        Parameters:
        ID - ID of the node to be deleted.

      • deleteRelease

        public void deleteRelease​(long ID,
                          long major,
                          long minor)
        Delete a release.
        Parameters:
        ID - ID of the compound doc whose release is to be deleted.
        major - Major number of the release to delete.
        minor - Minor number of the release to delete.

      • deleteRendition

        public void deleteRendition​(long nodeID,
                            long versionNum,
                            java.lang.String renditionType)
        Delete a rendition of a document version.
        Parameters:
        nodeID - ID of the document node containing the target version.
        versionNum - The version number of the target version.
        renditionType - The identifier of the type of rendition (for example, PDF, EPS, TXT).

      • deleteVersion

        public void deleteVersion​(long ID,
                          long versionNum)
        Delete a version.
        Parameters:
        ID - ID of the node from which version is to be deleted.
        versionNum - Version number of the version to delete.

      • getAllFavorites

        public Node[] getAllFavorites()
        Get all of the user's Favorites. The nodes for the Favorites are retrieved using partial data (see DocumentManagement's ListNodes).
        Returns:
        The user's favorite Nodes. Throws fault exception with fault codes: DocMan.ErrorGettingFavoritesPreferences, DocMan.ErrorGettingFavorites, DocMan.ErrorPopulatingSDO, DocMan.ErrorAllocatingSDO

      • getAllMultilingualMetadata

        public MultilingualMetadata[] getAllMultilingualMetadata​(long nodeID)
        Gets a list of all multilingual metadata for a node.
        Parameters:
        nodeID - The ID of the node to get the metadata from.
        Returns:
        Returns an array of all the multilingual metadata for the node. Throws fault exception with fault codes: DocMan.InvalidNodeID.

      • getAttributeGroupDefinition

        public AttributeGroupDefinition getAttributeGroupDefinition​(java.lang.String type,
                                                            java.lang.String key)
        Get AttributeGroupDefinition for given type and key.
        Parameters:
        type - Type of the AttributeGroup.
        key - Key identifying the AttributeGroup.
        Returns:
        Returns AttributeGroupDefinition object for use in inspecting AttributeGroup. Throws fault exception with fault codes: DocMan.ErrorGettingAttributeGroupDefinition.

      • getAttributeGroupTemplate

        public AttributeGroup getAttributeGroupTemplate​(java.lang.String type,
                                                java.lang.String key)
        Get default AttributeGroup values for Attribute Group of given type and key.
        Parameters:
        type - Type of the AttributeGroup.
        key - Key identifying the AttributeGroup.
        Returns:
        Returns AttributeGroup object for use in node creation or update. Throws fault exception with fault codes: DocMan.ErrorGettingAttributeGroupTemplate.

      • getCategoryDefinition

        public AttributeGroupDefinition getCategoryDefinition​(long categoryID)
        Get AttributeGroupDefinition object for category ID.
        Parameters:
        categoryID - ID of the category node.
        Returns:
        Returns AttributeGroupDefinition object for use in inspecting AttributeGroup. Throws fault exception with fault codes: DocMan.ErrorGettingAttributeGroupDefinition.

      • getCategoryDefinitions

        public AttributeGroupDefinition[] getCategoryDefinitions​(long[] categoryIDs)
        Get a list of AttributeGroupDefinition objects for the list of category IDs.
        Parameters:
        categoryIDs - IDs of the category nodes.
        Returns:
        Returns a list of AttributeGroupDefinition objects for use in inspecting AttributeGroup. Throws fault exception with fault codes: DocMan.ErrorGettingAttributeGroupDefinition.

      • getCategoryInheritance

        public CategoryInheritance[] getCategoryInheritance​(long nodeID)
        Gets the inheritability of the categories on the specified node.
        Parameters:
        nodeID - Node ID.
        Returns:
        Returns a list of Category Inheritance objects.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorGettingCategoryInheritance - Error getting category inheritance.

      • getCategoryTemplate

        public AttributeGroup getCategoryTemplate​(long categoryID)
        Get default AttributeGroup values for category ID.
        Parameters:
        categoryID - ID of the category node.
        Returns:
        Returns AttributeGroup object for use in node creation or update. Throws fault exception with fault codes: DocMan.ErrorGettingAttributeGroupTemplate.

      • getMetadataLanguages

        public MetadataLanguage[] getMetadataLanguages()
        Gets the list of enabled metadata languages.
        Returns:
        The enabled metadata languages.
        Since:
        10.0.5

      • getMultilingualMetadata

        public MultilingualMetadata[] getMultilingualMetadata​(long nodeID,
                                                      java.lang.String[] languageCodes)
        Gets the multilingual metadata for a node in the specified languages.
        Parameters:
        nodeID - The ID of the node to get the metadata from.
        languageCodes - The language codes for the language of the metadata. If null, uses the current user's preferred language.
        Returns:
        Returns the multilingual metadata for the node in the specified languages. Throws fault exception with fault codes: DocMan.InvalidNodeID, DocMan.InvalidLanguageCode, DocMan.Error.

      • getNode

        public Node getNode​(long ID)
        Get node object.
        Parameters:
        ID - ID of the node.
        Returns:
        Returns the specified node. If node cannot be found, returns null. Throws fault exception with fault codes: DocMan.ErrorAllocatingSDO, DocMan.ErrorPopulatingSDO, DocMan.NodeRetrievalError.

      • getNodeAuditRecords

        public NodeAuditRecord[] getNodeAuditRecords​(long ID)
        Get the list of audit records for a node.
        Parameters:
        ID - ID of the node for which audit records will be returned.
        Returns:
        Returns an array of NodeAuditRecord objects. Throws fault exception with fault codes: DocMan.ErrorLoadingPagedNodeEvents, DocMan.InvalidNodeType, DocMan.NodeRetrievalError, DocMan.PermissionsError.

      • getNodeByGUID

        public Node getNodeByGUID​(java.lang.String guid)
        Retrieves a node by its GUID.
        Parameters:
        guid - The GUID of the node.
        Returns:
        Returns the specified node if found, error otherwise. Throws fault exception with fault codes: DocMan.InvalidGUID, DocMan.NodeRetrievalError, DocMan.ErrorAllocatingSDO, DocMan.ErrorPopulatingSDO.

      • getNodeByName

        public Node getNodeByName​(long parentID,
                          java.lang.String name)
        Get a node by parent ID and name.
        Parameters:
        parentID - ID of the parent node.
        name - Name of the node.
        Returns:
        Returns the specified node (or appropriate subclass based on node's type). If node cannot be found, returns null. Throws fault exception with fault codes: DocMan.NodeRetrievalError, DocMan.ParentNodeRetrievalError.

      • getNodeByNickname

        public Node getNodeByNickname​(java.lang.String nickname)
        Get a node by its nickname.
        Parameters:
        nickname - Nickname of the node.
        Returns:
        Returns the specified node (or appropriate subclass based on node's type). If node cannot be found, returns null. Throws fault exception with fault codes: DocMan.CannotFindNode.

      • getNodeByPath

        public Node getNodeByPath​(long rootID,
                          java.lang.String[] pathElements)
        Get a node by root ID and path.
        Parameters:
        rootID - ID of the path root.
        pathElements - Full path elements relative to root.
        Returns:
        Returns the specified node (or appropriate subclass based on node's type). If node cannot be found, returns null. Throws fault exception with fault codes: DocMan.NoPathSpecified.

      • getNodeGUID

        public java.lang.String getNodeGUID​(long nodeID)
        Retrieves the GUID for a node.
        Parameters:
        nodeID - The ID of the node.
        Returns:
        Returns the GUID for the node if found, error otherwise.Throws fault exception with fault codes: DocMan.NodeRetrievalError.

      • getNodeRights

        public NodeRights getNodeRights​(long ID)
        Get the set of rights for a node.
        Parameters:
        ID - ID of the node to which rights will be returned.
        Returns:
        Returns a NodeRights object. Throws fault exception with fault codes: DocMan.ErrorGettingNodeRights, DocMan.NodeRetrievalError, DocMan.PermissionsError.

      • getNodes

        public Node[] getNodes​(long[] IDs)
        Get node objects.
        Parameters:
        IDs - List of IDs of nodes to retrieve.
        Returns:
        Returns an array of nodes. If any node cannot be found, a null node will be in the corresponding position in the array. Throws fault exception with fault codes: DocMan.NodeRetrievalError.

      • getNodesByNickname

        public Node[] getNodesByNickname​(java.lang.String[] nicknames)
        Get a list of nodes given a list of nicknames.
        Parameters:
        nicknames - Nicknames of the nodes.
        Returns:
        Returns a list of the nodes specified by the nicknames. Throws fault exception with fault codes: DocMan.CannotFindNode.

      • getNodesInContainer

        public Node[] getNodesInContainer​(long containerID,
                                  GetNodesInContainerOptions options)
        Gets nodes that are in the provided container.
        Parameters:
        containerID - The ID of the container.
        options - The options to use for getting the nodes.
        Returns:
        Returns an array of nodes that are in the container. Throws fault exception with fault codes: DocMan.ErrorGettingParentNode, DocMan.ErrorListingNodes, DocMan.InvalidOptions.

      • getNodeTemplate

        public Node getNodeTemplate​(long parentID,
                            java.lang.String nodeType)
        Gets a template of a node for subsequent creation using CreateNode.
        Parameters:
        parentID - ParentID of node in which the new node will be created.
        nodeType - Type of node to be created.
        Returns:
        Returns a template object which is a subclass of Node corresponding to the specified type, and which should be cast accordingly. Throws fault exception with fault codes: DocMan.NodeAllocationError, DocMan.NodeCreationError, DocMan.PopulateTemplateError.

      • getNodeTypes

        public java.lang.String[] getNodeTypes()
        Gets a list of node types.
        Returns:
        Returns a list of node type names, which can be used to call GetNodeTemplate.

      • getPagedNodeAuditData

        public PagedNodeAuditData getPagedNodeAuditData​(long ID,
                                                PageHandle pageHandle)
        Get the list of audit records for a node, page by page.
        Parameters:
        ID - ID of the node for which audit records will be returned.
        pageHandle - Handle for pagination - specify null to get first page.
        Returns:
        Returns NodeAuditRecord objects and PageHandle for subsequent calls. Throws fault exception with fault codes: DocMan.ErrorDeletingPageHandle, DocMan.ErrorLoadingPagedNodeEvents, DocMan.ErrorUpdatingPageHandle, DocMan.InvalidNodeType, DocMan.InvalidPageHandle, DocMan.NodeRetrievalError, DocMan.PermissionsError.

      • getRelease

        public CompoundDocRelease getRelease​(long ID,
                                     long major,
                                     long minor)
        Get a release.
        Parameters:
        ID - ID of the compound doc of the release to get.
        major - Major number of the release to get.
        minor - Minor number of the release to get.
        Returns:
        Returns CompoundDocRelease object. Throws fault exception with fault codes: DocMan.ErrorGettingRelease, DocMan.InvalidNodeType, DocMan.NodeRetrievalError.

      • getRenditionContents

        public Attachment getRenditionContents​(long nodeID,
                                       long versionNum,
                                       java.lang.String renditionType)
        Retrieve a rendition's file contents.
        Parameters:
        nodeID - ID of the document node containing the target version.
        versionNum - The version number of the target version
        renditionType - The identifier of the type of rendition being retrieved (for example, PDF, EPS, TXT).
        outStream - The output stream to write the contents to.
        Returns:
        Returns an object containing information about the file downloaded. Throws fault exception with fault codes: DocMan.FetchVersionToStreamError, DocMan.NodeRetrievalError, DocMan.RenditionNotYetLoaded, DocMan.RenditionRetrievalError, DocMan.VersionRetrievalError.

      • getRenditionContentsContext

        public java.lang.String getRenditionContentsContext​(long nodeID,
                                                    long versionNum,
                                                    java.lang.String renditionType)
        Store the meta-data for getting a rendition's file contents in a method context on the server. It will actually be fetched when ContentService.DownloadContent() is called.
        Parameters:
        nodeID - ID of the document node containing the target version.
        versionNum - The version number of the target version.
        renditionType - The identifier of the type of rendition to retrieve (for example, PDF, EPS, TXT).
        Returns:
        ContextID used to download the rendition contents using the Content Service. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • getRootNode

        public Node getRootNode​(java.lang.String rootType)
        Get a root node by root node type, one of 'EnterpriseWS', 'PersonalWS', 'CategoriesWS', 'ReportsWS', 'System'.
        Parameters:
        rootType - Type of root node.
        Returns:
        Returns the specified root node. Throws fault exception with fault codes: DocMan.ErrorAllocatingSDO, DocMan.ErrorGettingRootNode, DocMan.ErrorPopulatingSDO, DocMan.UnknownRootType.

      • getRootNodeTypes

        public java.lang.String[] getRootNodeTypes()
        Gets a list of all root node types that are available.
        Returns:
        All root node types.
        Since:
        10.0.2

      • getVersion

        public Version getVersion​(long ID,
                          long versionNum)
        Get version object.
        Parameters:
        ID - ID of the node.
        versionNum - Version Number of the version.
        Returns:
        Returns a version object. Throws fault exception with fault codes: DocMan.NodeRetrievalError, DocMan.VersionRetrievalError.

      • getVersionByGUID

        public Version getVersionByGUID​(java.lang.String guid)
        Retrieves a version by its GUID.
        Parameters:
        guid - The GUID of the version.
        Returns:
        Returns the specified version if found, error otherwise. Throws fault exception with fault codes: DocMan.InvalidGUID, DocMan.VersionRetrievalError, DocMan.ErrorAllocatingSDO.

      • getVersionContents

        public Attachment getVersionContents​(long ID,
                                     long versionNum)
        Get version's contents.
        Parameters:
        ID - ID of the node.
        versionNum - Version Number of the version.
        outStream - The output stream to write the contents to
        Returns:
        Information about the file downloaded. Throws fault exception with fault codes: DocMan.NodeRetrievalError, DocMan.VersionNotYetLoaded, DocMan.VersionRetrievalError.

      • getVersionContentsContext

        public java.lang.String getVersionContentsContext​(long ID,
                                                  long versionNum)
        Store the meta-data for getting a version's contents in a method context on the server. It will actually be fetched when ContentService.DownloadContent() is called.
        Parameters:
        ID - ID of the node.
        versionNum - Version Number of the version.
        Returns:
        ContextID to retrieve the version contents using the ContentService. Throws fault exception with fault codes: DocMan.ErrorSavingMethodContext.

      • getVersionGUID

        public java.lang.String getVersionGUID​(long nodeID,
                                       long versionNumber)
        Retrieves the GUID for a specific version of a node.
        Parameters:
        nodeID - The ID of the node.
        versionNumber - The version number of the node.
        Returns:
        Returns the GUID for the version if found, error otherwise.Throws fault exception with fault codes: DocMan.NodeRetrievalError, DocMan.VersionRetrievalError.

      • listNodes

        public Node[] listNodes​(long parentID,
                        boolean partialData)
        Get list of child nodes with name and description based on the user's preferred language.
        Parameters:
        parentID - ID of the parent node.
        partialData - True if node list is to be calculated quickly, with partial data (no Metadata, for example). If false, call will be expensive in time.
        Returns:
        Returns array of nodes for the children. Throws fault exception with fault codes: DocMan.ErrorGettingParentNode, DocMan.ErrorListingNodes.

      • listNodesByName

        public Node[] listNodesByName​(long parentID)
        Get list of child nodes with name and description based on the core values.
        Parameters:
        parentID - ID of the parent node.
        Returns:
        Returns array of nodes for the children. Throws fault exception with fault codes: DocMan.ErrorGettingParentNode, DocMan.ErrorListingNodes.

      • listNodesByPage

        public NodePageResult listNodesByPage​(long parentID,
                                      NodePageSpecification pageSpec)
        Get a page of child nodes with name and description based on the user's preferred language.
        Parameters:
        parentID - ID of the parent node.
        pageSpec - Description of page required.
        Returns:
        Returns NodePageResult which contains nodes and page count. Throws fault exception with fault codes: DocMan.ErrorGettingParentNode, DocMan.ErrorPopulatingSDO, DocMan.ListContentsByPageError, DocMan.TypeFilterNotSupported, DocMan.InvalidPageNumber.

      • listNodesByPageAndName

        public NodePageResult listNodesByPageAndName​(long parentID,
                                             NodePageSpecification pageSpec)
        Get a page of child nodes with name and description based on the core values.
        Parameters:
        parentID - ID of the parent node.
        pageSpec - Description of page required.
        Returns:
        Returns NodePageResult which contains nodes and page count. Throws fault exception with fault codes: DocMan.ErrorGettingParentNode, DocMan.ErrorPopulatingSDO, DocMan.ListContentsByPageError, DocMan.TypeFilterNotSupported, DocMan.InvalidPageNumber.

      • listReferences

        public Node[] listReferences​(long ID)
        Get list of () nodes which reference specified node.
        Parameters:
        ID - ID of the node.
        Returns:
        Returns array of (Alias or Generation) reference Nodes. Throws fault exception with fault codes: DocMan.ErrorPopulatingSDO, DocMan.NodeInfoReferencesError, DocMan.NodeRetrievalError.

      • listReleases

        public CompoundDocRelease[] listReleases​(long ID)
        List all releases of compound document node.
        Parameters:
        ID - ID of the compound doc of the releases to get.
        Returns:
        Returns array of CompoundDocRelease objects. Throws fault exception with fault codes: DocMan.DatabaseError, DocMan.InvalidNodeType, DocMan.NodeRetrievalError.

      • listRenditions

        public Version[] listRenditions​(long nodeID,
                                long versionNum)
        Get a list of renditions for the specified node version.
        Parameters:
        nodeID - ID of the node to which the version belongs.
        versionNum - Number of the version to which the rendition belongs.
        Returns:
        Returns an array of renditions for the version. Throws fault exception with fault codes: DocMan.CouldNotListRenditions, DocMan.VersionRetrievalError, DocMan.NodeRetrievalError.

      • lockRelease

        public void lockRelease​(long ID,
                        long major,
                        long minor)
        Lock a release.
        Parameters:
        ID - ID of the compound doc whose release is to be locked.
        major - Major number of the release to lock.
        minor - Minor number of the release to lock.

      • lockVersion

        public void lockVersion​(long ID,
                        long versionNum)
        Lock a version.
        Parameters:
        ID - ID of the node from which version is to be locked.
        versionNum - Version number of the version to lock.

      • moveNode

        public void moveNode​(long ID,
                     long parentID,
                     java.lang.String newName,
                     MoveOptions moveOptions)
        Moves a node to a new destination.
        Parameters:
        ID - The ID of the node to move.
        parentID - The ID of the parent node to move the node to.
        newName - The new name of the node. If null or the empty string is given it will keep the same name.
        moveOptions - The options for how the move operation will be performed.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.NodeMoveError - There was an error moving the node.
        DocMan.NodeRetrievalError - The was an error retrieving the source node.
        DocMan.ParentNodeRetrievalError - There was an error retrieving the parent node.

      • promoteVersion

        public Version promoteVersion​(long ID,
                              long versionNum,
                              Metadata metadata)
        Promote a version.
        Parameters:
        ID - ID of the node.
        versionNum - Version Number of the version.
        metadata - New metadata for the version; null if no changes.
        Returns:
        Returns new version object. Throws fault exception with fault codes: DocMan.ErrorPromotingVersion, DocMan.ErrorSettingAttributes, DocMan.NodeRetrievalError, DocMan.PermissionsError, DocMan.VersionRetrievalError.

      • purgeVersions

        public void purgeVersions​(long ID,
                          int numberToKeep)
        Purge node versions.
        Parameters:
        ID - ID of the node.
        numberToKeep - Number of versions to keep.

      • rearrangeNodes

        public void rearrangeNodes​(long ID,
                           NodePosition[] positions)
        Rearrange the positions of child nodes within a Compound Document.
        Parameters:
        ID - ID of the Compound Document node.
        positions - Array of position pairs (child ID, position) (use position 0 to designate node as the 'Master Document').

      • removeFavorite

        public void removeFavorite​(long nodeID)
        Remove the Favorite, if any, for the given object.
        Parameters:
        nodeID - ID of the node whose Favorite will be removed.

      • removeFromCollection

        public void removeFromCollection​(long collectionID,
                                 CollectionItem[] collectionItems)
        Removes items from a collection.
        Parameters:
        collectionID - The ID of the collection to remove from.
        collectionItems - The list of items to remove from the collection.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorRemovingNodeFromCollection - An error occured when trying to remove a node from the collection.
        DocMan.InvalidCollectionID - An error occured when trying to get the collection node. Possibly an invalid node ID.
        DocMan.InvalidCollectionItemID - An error occured when trying to get a collection item node. Possibly an invalid node ID.
        DocMan.InvalidCollectionItemVersion - An error occured when trying to get a collection item version. Possibly an invalid version number.
        DocMan.InvalidNodeType - The node ID given is not an ID of a collection node.
        Since:
        10.0.9

      • removeNodeRight

        public void removeNodeRight​(long ID,
                            NodeRight nodeRight)
        Removes a right from a node.
        Parameters:
        ID - The ID of the node to remove a right from.
        nodeRight - The node right to remove.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorDeletingNodeRight - An error occured when trying to remove the node right.
        DocMan.InvalidNodeRight - The NodeRight object is invalid.
        DocMan.InvalidNodeRightID - The NodeRight's right ID is invalid.
        DocMan.InvalidNodeRightPermissions - The NodeRight's NodePermissions object is invalid.
        DocMan.InvalidNodeRightType - The NodeRight's type is invalid.
        DocMan.NodeRetrievalError - An error occured when trying to get the node. Possibly an invalid node ID.
        DocMan.PermissionsError - The current user does not have the permissions to perform the operation.

      • renameNode

        public void renameNode​(long ID,
                       java.lang.String newName)
        Rename node object.
        Parameters:
        ID - ID of the node.
        newName - Name to be given to the specified node.

      • repositionNode

        public void repositionNode​(long ID,
                           long position)
        Change the position of a node object within a Compound Document.
        Parameters:
        ID - ID of the node.
        position - Ordering number of node (use 0 to designate node as the 'Master Document'.

      • reserveNode

        public void reserveNode​(long ID,
                        java.lang.Long userID)
        Reserve node object.
        Parameters:
        ID - ID of the node.
        userID - ID of user or group reserving the node, null for current user.

      • runReport

        public ReportResult runReport​(long reportID,
                              DataValue[] inputs)
        Runs a LiveReport.
        Parameters:
        reportID - The ID of the LiveReport.
        inputs - The user input values.
        Returns:
        The result of running the LiveReport.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorRunningReport - An error occured when trying to run the report.
        DocMan.InvalidNodeType - The node ID given is not an ID of a report node.
        DocMan.InvalidReportID - An error occured when trying to get the report node. Possibly an invalid node ID.
        DocMan.InvalidReportInputs - The given inputs do not match the expected inputs for the report.
        DocMan.PermissionsError - The user does not have permissions to run the report.
        Since:
        10.0.9

      • setCategoryInheritance

        public void setCategoryInheritance​(long nodeID,
                                   CategoryInheritance[] categoryInheritanceObjs)
        Sets the inheritability of the categories on the specified node.
        Parameters:
        nodeID - Node ID
        categoryInheritanceObjs - Category Inheritance Objects
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorSettingCategoryInheritance - Error setting category inheritance.

      • setNodeMetadata

        public void setNodeMetadata​(long nodeID,
                            Metadata metadata)
        Sets the metadata for a node.
        Parameters:
        nodeID - The ID of the node to set the metadata for.
        metadata - The metadata to set.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorGettingNode - An error occured when trying to get the node. Possibly an invalid node ID.
        DocMan.ErrorUpdatingAttributes - An error occured when trying to update the metadata for the node.
        Since:
        10.0.10

      • setNodeRights

        public void setNodeRights​(long ID,
                          NodeRights rights)
        Set the rights for a node.
        Parameters:
        ID - The ID of the node to set the rights for.
        rights - The node rights to set.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorUpdatingNodeRights - An error occured when trying to set the node rights.
        DocMan.InvalidNodeRight - A NodeRight object is invalid.
        DocMan.InvalidNodeRightID - A NodeRight's right ID is invalid.
        DocMan.InvalidNodeRightPermissions - A NodeRight's NodePermissions object is invalid.
        DocMan.InvalidNodeRights - The NodeRights object is invalid.
        DocMan.InvalidNodeRightType - A NodeRight's type is invalid.
        DocMan.NodeRetrievalError - An error occured when trying to get the node. Possibly an invalid node ID.
        DocMan.PermissionsError - The current user does not have the permissions to perform the operation.

      • unlockRelease

        public void unlockRelease​(long ID,
                          long major,
                          long minor)
        Unlock a release.
        Parameters:
        ID - ID of the compound doc whose release is to be unlocked.
        major - Major number of the release to unlock.
        minor - Minor number of the release to unlock.

      • unlockVersion

        public void unlockVersion​(long ID,
                          long versionNum)
        Unlock a version.
        Parameters:
        ID - ID of the node from which version is to be unlocked.
        versionNum - Version number of the version to unlock.

      • unreserveNode

        public void unreserveNode​(long ID)
        Reserve node object.
        Parameters:
        ID - ID of the node.

      • updateCategory

        public AttributeGroupDefinition updateCategory​(long categoryID,
                                               Attribute[] attributes)
        Update a Category's attribute definition list (create a new version of the Category).
        Parameters:
        categoryID - ID of the category node.
        attributes - The array of attributes, in order, which comprise the category.
        Returns:
        Returns the new AttributeGroupDefinition object. Throws fault exception with fault codes: DocMan.CategoryIdDoesNotCorrespondToACategoryNode, DocMan.ErrorGettingCategoryDefinition, DocMan.ErrorUpdatingDefinition, DocMan.NodeRetrievalError.

      • updateMultilingualMetadata

        public void updateMultilingualMetadata​(long nodeID,
                                       MultilingualMetadata[] metadata)
        Updates a node's multilingual metadata for the languages given.
        Parameters:
        nodeID - The ID of the node to update.
        metadata - The list of metadata that contains the information for the update.

      • updateNode

        public void updateNode​(Node node)
        Update node's properties.
        Parameters:
        node - The modified node SDO.

      • updateNodeRight

        public void updateNodeRight​(long ID,
                            NodeRight nodeRight)
        Updates a right for a node.
        Parameters:
        ID - The ID of the node to update a right for.
        nodeRight - The node right to update.
        Throws:
        SoapFaultException - with fault codes:
        DocMan.ErrorUpdatingNodeRight - An error occured when trying to update the node right.
        DocMan.InvalidNodeRight - The NodeRight object is invalid.
        DocMan.InvalidNodeRightID - The NodeRight's right ID is invalid.
        DocMan.InvalidNodeRightPermissions - The NodeRight's NodePermissions object is invalid.
        DocMan.InvalidNodeRightType - The NodeRight's type is invalid.
        DocMan.NodeRetrievalError - An error occured when trying to get the node. Possibly an invalid node ID.
        DocMan.PermissionsError - The current user does not have the permissions to perform the operation.

      • updateNodeRights

        public NodeRightUpdateInfo updateNodeRights​(ChunkedOperationContext context)
        A chunked method used to update the rights of a node and optionally its children. Each call to this method will complete one chunk of the whole operation, and may need to be called multiple times if many nodes will be affected. UpdateNodeRightsContext() must be called first to create a context for this operation.
        Parameters:
        context - The ChunkedOperationContext for this operation.
        Returns:
        Returns the results of the last chunk of node right updates. Throws fault exception with fault codes: DocMan.CouldNotRetrieveNodeCrawler, DocMan.ErrorCachingNodeCrawler, DocMan.InvalidChunkContext, DocMan.NodeCrawlerError.

      • updateNodeRightsContext

        public ChunkedOperationContext updateNodeRightsContext​(long nodeID,
                                                       RightOperation operation,
                                                       NodeRight[] rights,
                                                       RightPropagation propagation)
        Create the context to be used by UpdateNodeRights() to complete its operation over a series of method calls.
        Parameters:
        nodeID - The ID of the target node.
        operation - One of the following: RightOperation.Add - Add the specified rights to all affected nodes. RightOperation.Delete - Delete the specified rights from all affected nodes. RightOperation.Replace - Replace the set of rights for all affected nodes with the specified rights.
        rights - The list of rights to add, delete, or replace.
        propagation - Specifies the scope of the changes. One of: RightPropagation.TargetOnly, RightPropagation.TargetAndChildren, or RightPropagation.ChildrenOnly
        Returns:
        Returns the context object used by UpdateNodeRights(). Throws fault exception with fault codes: DocMan.ErrorCachingNodeCrawler.

      • updateVersion

        public void updateVersion​(Version version)
        Update a version (Comment and MimeType are the only modifiable properties).
        Parameters:
        version - Version to update.

      • upgradeCategoryItems

        public CategoryItemsUpgradeInfo upgradeCategoryItems​(ChunkedOperationContext context)
        A chunked method used to upgrade nodes to the latest version of a category definition. Each call to this method will complete one chunk of the whole operation, and may need to be called multiple times if many nodes will be affected. UpgradeCategoryItemsContext() must be called first to create a context for this operation.
        Parameters:
        context - The ChunkedOperationContext for this operation.
        Returns:
        Returns the results of the last chunk of definition updates. Throws fault exception with fault codes: DocMan.CacheReadError, DocMan.CacheWriteError, DocMan.InvalidChunkContext, DocMan.InvalidChunkSize, DocMan.NodeUpgradeError.

      • upgradeCategoryItemsContext

        public ChunkedOperationContext upgradeCategoryItemsContext​(long categoryID,
                                                           long version,
                                                           boolean addVersion)
        Used with UpgradeCategoryItems() to upgrade nodes to the latest version of a category definition.
        Parameters:
        categoryID - The ID of the category whose items to upgrade.
        version - The version of the category to upgrade to.
        addVersion - Specify whether to apply the upgraded category definition to a new version for each (versionable) node.
        Returns:
        Returns the context object used by UpgradeCategoryItems(). Throws fault exception with fault codes: DocMan.CacheWriteError, DocMan.InvalidCategoryID, DocMan.InvalidVersionNumber.