Class UpdateDocumentInfo

  • All Implemented Interfaces:
    java.io.Serializable

    public class UpdateDocumentInfo
    extends DocumentInfo
    Bean to hold information for UpdateDocument method.
    Author:
    tfr
    See Also:
    Serialized Form
    • Field Detail

      • hDoc

        protected java.lang.String hDoc
      • doResolveLinks

        protected java.lang.Boolean doResolveLinks
      • doCheckin

        protected java.lang.Boolean doCheckin
    • Constructor Detail

      • UpdateDocumentInfo

        public UpdateDocumentInfo​(java.lang.String ddcName,
                                  java.lang.String documentHDoc,
                                  java.util.Properties nameValuePairs,
                                  ContentStream[] content,
                                  java.lang.String versionComment)
        Creates a new UpdateDocumentInfo.
        Parameters:
        ddcName - The name of the database definition
        documentHDoc - The ID of the document (HDOC)
        nameValuePairs - A properties object containing the metadata. Only the contained properties will be updated.
        content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.
        versionComment - The comment for the version
      • UpdateDocumentInfo

        public UpdateDocumentInfo​(java.lang.String ddcName,
                                  java.lang.String documentHDoc,
                                  java.util.Map<java.lang.String,​java.lang.Object> nameValuePairs,
                                  ContentStream[] content,
                                  java.lang.String versionComment)
        Creates a new UpdateDocumentInfo.
        Parameters:
        ddcName - The name of the database definition
        documentHDoc - The ID of the document (HDOC)
        nameValuePairs - A Map object containing the metadata. Only the contained properties will be updated.
        content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.
        versionComment - The comment for the version
    • Method Detail

      • getDocumentHDoc

        public java.lang.String getDocumentHDoc()
        Returns:
        document's hDoc
      • getResolveLinks

        public java.lang.Boolean getResolveLinks()
        Returns:
        if links should be resolved
      • setResolveLinks

        public DocumentInfo setResolveLinks​(boolean resolveLinks)
        Parameters:
        resolveLinks - resolveLinks
        Returns:
        UpdateDocumentInfo
      • getCheckin

        public java.lang.Boolean getCheckin()
        Returns:
        if document should be checked-in
      • setCheckin

        public UpdateDocumentInfo setCheckin​(java.lang.Boolean checkin)
        Parameters:
        checkin - if set to true, the document will be checked-in
        Returns:
        UpdateDocumentInfo
      • setMetadata

        public UpdateDocumentInfo setMetadata​(java.util.Map<java.lang.String,​java.lang.Object> metadatas)
        Sets the metadata.
        Parameters:
        metadatas - A properties object containing the metadata.
        Returns:
        UpdateDocumentInfo
      • addVariable

        public UpdateDocumentInfo addVariable​(java.lang.String name,
                                              java.lang.String value)
        Adds a variable to the document.
        Overrides:
        addVariable in class DocumentInfo
        Parameters:
        name - The name of the variable.
        value - The value of the variable.
        Returns:
        UpdateDocumentInfo