Class Document

java.lang.Object
com.priint.pubserver.document.Document
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DocumentContent

public class Document extends Object implements Serializable
A document is represented by its absolute path in the pubserver repository. A valid path would be e.g. "/pubserver/myplugin/myconfig123.xml". A document contains meta data for the content element of the document.
See Also:
  • Field Details

    • DOCUMENT_NAMESPACE_PREFIX

      public static final String DOCUMENT_NAMESPACE_PREFIX
      Prefix for pubserver content within repository.
      See Also:
  • Constructor Details

    • Document

      public Document()
      Instantiates a new Document.
    • Document

      public Document(String path)
      Instantiates a new Document.
      Parameters:
      path - the path
    • Document

      public Document(String path, String version)
      Instantiates a new Document.
      Parameters:
      path - the path
      version - the version
    • Document

      public Document(String path, String version, String created, String createdBy)
      Instantiates a new Document.
      Parameters:
      path - the path
      version - the version
      created - the created
      createdBy - the created by
    • Document

      public Document(String path, String version, Date created, String createdBy)
      Instantiates a new Document.
      Parameters:
      path - the path
      version - the version
      created - the created
      createdBy - the created by
  • Method Details

    • getPath

      public String getPath()
      Gets path.
      Returns:
      the path
    • setPath

      public void setPath(String path)
      Sets path.
      Parameters:
      path - the path
    • getVersion

      public String getVersion()
      Gets version.
      Returns:
      the version
    • setVersion

      public void setVersion(String version)
      Sets version.
      Parameters:
      version - the version
    • getCreated

      public String getCreated()
      Gets created.
      Returns:
      the created
    • getDateCreated

      public Date getDateCreated()
      Retrieves the creation date as Date object, if string can be parsed as XML dateTime otherwise returns null.
      Returns:
      newly created Date object or null
    • setCreated

      public void setCreated(String created)
      Sets created.
      Parameters:
      created - the created
    • setDateCreated

      public void setDateCreated(Date created)
      Saves a date into created string field, formatting according to XML dataTime specification.
      Parameters:
      created - the created
    • getCreatedBy

      public String getCreatedBy()
      Gets created by.
      Returns:
      the created by
    • setCreatedBy

      public void setCreatedBy(String createdBy)
      Sets created by.
      Parameters:
      createdBy - the created by
    • getRevision

      public String getRevision()
      Gets revision.
      Returns:
      the revision
    • setRevision

      public void setRevision(String revision)
      Sets revision.
      Parameters:
      revision - the revision
    • getName

      public String getName()
      Gets name.
      Returns:
      the name
    • setName

      public void setName(String name)
      Sets name.
      Parameters:
      name - the name
    • getType

      public String getType()
      Gets type.
      Returns:
      the type
    • setType

      public void setType(String type)
      Sets type.
      Parameters:
      type - the type
    • getProperties

      public Map<Document.DocumentProperties,String> getProperties()
      Gets properties.
      Returns:
      the properties
    • setProperties

      public void setProperties(Map<Document.DocumentProperties,String> properties)
      Sets properties.
      Parameters:
      properties - the properties
    • getDescription

      public String getDescription()
      Gets description.
      Returns:
      the description
    • setDescription

      public void setDescription(String description)
      Sets description.
      Parameters:
      description - the description
    • isActive

      public Boolean isActive()
      Is active boolean.
      Returns:
      the boolean
    • setActive

      public void setActive(Boolean active)
      Sets active.
      Parameters:
      active - the active
    • getLocked

      public String getLocked()
      Gets locked.
      Returns:
      the locked
    • setLocked

      public void setLocked(String locked)
      Sets locked.
      Parameters:
      locked - the locked
    • getLockedOn

      public String getLockedOn()
      Gets locked on.
      Returns:
      the locked on
    • setLockedOn

      public void setLockedOn(String lockedOn)
      Sets locked on.
      Parameters:
      lockedOn - the locked on
    • getLockedBy

      public String getLockedBy()
      Gets locked by.
      Returns:
      the locked by
    • setLockedBy

      public void setLockedBy(String lockedBy)
      Sets locked by.
      Parameters:
      lockedBy - the locked by
    • getLockRemoteAddr

      public String getLockRemoteAddr()
      Gets lock remote addr.
      Returns:
      the lock remote addr
    • setLockRemoteAddr

      public void setLockRemoteAddr(String lockRemoteAddr)
      Sets lock remote addr.
      Parameters:
      lockRemoteAddr - the lock remote addr
    • getLockClientId

      public String getLockClientId()
      Gets lock client id.
      Returns:
      the lock client id
    • setLockClientId

      public void setLockClientId(String lockClientId)
      Sets lock client id.
      Parameters:
      lockClientId - the lock client id
    • getLockToken

      public String getLockToken()
      Gets lock token.
      Returns:
      the lock token
    • setLockToken

      public void setLockToken(String lockToken)
      Sets lock token.
      Parameters:
      lockToken - the lock token
    • getHash

      public String getHash()
      Gets hash.
      Returns:
      the hash
    • setHash

      public void setHash(String hash)
      Sets hash.
      Parameters:
      hash - the hash