Package com.saperion.structures

Class Description

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    DocumentInfo, LinkInfo
    public class Description
extends java.lang.Object
implements java.io.Serializable
    Description of a database definition (DDC) related item.
    An item could be a document DocumentInfo or LinkInfo and contains the descriptions for the DDC name, the meta data, a revision comment and the ACL names.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String acl  
      protected java.lang.String comment  
      protected java.lang.String ddc  
      protected java.util.Map<java.lang.String,​java.lang.Object> metadatas  

    • Constructor Summary

      Constructors 
      Constructor Description
      Description​(java.lang.String ddcName, java.util.Map<java.lang.String,​java.lang.Object> nameValuePairs, java.lang.String versionComment)
      Creates a new document description.

    • Field Detail

      • ddc

        protected java.lang.String ddc

      • metadatas

        protected java.util.Map<java.lang.String,​java.lang.Object> metadatas

      • comment

        protected java.lang.String comment

      • acl

        protected java.lang.String acl

    • Constructor Detail

      • Description

        public Description​(java.lang.String ddcName,
                   java.util.Map<java.lang.String,​java.lang.Object> nameValuePairs,
                   java.lang.String versionComment)
        Creates a new document description.
        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

    • Method Detail

      • getDdcName

        public java.lang.String getDdcName()
        Returns:
        ddc name

      • getMetadatas

        public java.util.Map<java.lang.String,​java.lang.Object> getMetadatas()
        Returns:
        properties as name value pairs

      • getVersionComment

        public java.lang.String getVersionComment()
        Returns:
        version comment

      • getAcls

        public java.lang.String getAcls()
        Returns:
        ACLs

      • setAcls

        public Description setAcls​(java.lang.String acls)
        Parameters:
        acls - acl string
        Returns:
        UpdateDocumentInfo