Package com.priint.pubserver.document
Class Document
java.lang.Object
com.priint.pubserver.document.Document
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DocumentContent
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumMeta data attributes describing a PubServer repository item. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringPrefix for pubserver content within repository. -
Constructor Summary
ConstructorsConstructorDescriptionDocument()Instantiates a new Document.Instantiates a new Document.Instantiates a new Document.Instantiates a new Document.Instantiates a new Document. -
Method Summary
Modifier and TypeMethodDescriptionGets created.Gets created by.Retrieves the creation date as Date object, if string can be parsed as XML dateTime otherwise returns null.Gets description.getHash()Gets hash.Gets lock client id.Gets locked.Gets locked by.Gets locked on.Gets lock remote addr.Gets lock token.getName()Gets name.getPath()Gets path.Gets properties.Gets revision.getType()Gets type.Gets version.isActive()Is active boolean.voidSets active.voidsetCreated(String created) Sets created.voidsetCreatedBy(String createdBy) Sets created by.voidsetDateCreated(Date created) Saves a date into created string field, formatting according to XML dataTime specification.voidsetDescription(String description) Sets description.voidSets hash.voidsetLockClientId(String lockClientId) Sets lock client id.voidSets locked.voidsetLockedBy(String lockedBy) Sets locked by.voidsetLockedOn(String lockedOn) Sets locked on.voidsetLockRemoteAddr(String lockRemoteAddr) Sets lock remote addr.voidsetLockToken(String lockToken) Sets lock token.voidSets name.voidSets path.voidsetProperties(Map<Document.DocumentProperties, String> properties) Sets properties.voidsetRevision(String revision) Sets revision.voidSets type.voidsetVersion(String version) Sets version.
-
Field Details
-
DOCUMENT_NAMESPACE_PREFIX
Prefix for pubserver content within repository.- See Also:
-
-
Constructor Details
-
Document
public Document()Instantiates a new Document. -
Document
Instantiates a new Document.- Parameters:
path- the path
-
Document
Instantiates a new Document.- Parameters:
path- the pathversion- the version
-
Document
Instantiates a new Document.- Parameters:
path- the pathversion- the versioncreated- the createdcreatedBy- the created by
-
Document
Instantiates a new Document.- Parameters:
path- the pathversion- the versioncreated- the createdcreatedBy- the created by
-
-
Method Details
-
getPath
Gets path.- Returns:
- the path
-
setPath
Sets path.- Parameters:
path- the path
-
getVersion
Gets version.- Returns:
- the version
-
setVersion
Sets version.- Parameters:
version- the version
-
getCreated
Gets created.- Returns:
- the created
-
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
Sets created.- Parameters:
created- the created
-
setDateCreated
Saves a date into created string field, formatting according to XML dataTime specification.- Parameters:
created- the created
-
getCreatedBy
Gets created by.- Returns:
- the created by
-
setCreatedBy
Sets created by.- Parameters:
createdBy- the created by
-
getRevision
Gets revision.- Returns:
- the revision
-
setRevision
Sets revision.- Parameters:
revision- the revision
-
getName
Gets name.- Returns:
- the name
-
setName
Sets name.- Parameters:
name- the name
-
getType
Gets type.- Returns:
- the type
-
setType
Sets type.- Parameters:
type- the type
-
getProperties
Gets properties.- Returns:
- the properties
-
setProperties
Sets properties.- Parameters:
properties- the properties
-
getDescription
Gets description.- Returns:
- the description
-
setDescription
Sets description.- Parameters:
description- the description
-
isActive
Is active boolean.- Returns:
- the boolean
-
setActive
Sets active.- Parameters:
active- the active
-
getLocked
Gets locked.- Returns:
- the locked
-
setLocked
Sets locked.- Parameters:
locked- the locked
-
getLockedOn
Gets locked on.- Returns:
- the locked on
-
setLockedOn
Sets locked on.- Parameters:
lockedOn- the locked on
-
getLockedBy
Gets locked by.- Returns:
- the locked by
-
setLockedBy
Sets locked by.- Parameters:
lockedBy- the locked by
-
getLockRemoteAddr
Gets lock remote addr.- Returns:
- the lock remote addr
-
setLockRemoteAddr
Sets lock remote addr.- Parameters:
lockRemoteAddr- the lock remote addr
-
getLockClientId
Gets lock client id.- Returns:
- the lock client id
-
setLockClientId
Sets lock client id.- Parameters:
lockClientId- the lock client id
-
getLockToken
Gets lock token.- Returns:
- the lock token
-
setLockToken
Sets lock token.- Parameters:
lockToken- the lock token
-
getHash
Gets hash.- Returns:
- the hash
-
setHash
Sets hash.- Parameters:
hash- the hash
-