PSComment (PageSeeder Bridge 0.8.3 API)

java.lang.Object
- org.pageseeder.bridge.model.PSComment

All Implemented Interfaces:

Serializable, PSEntity
```
public final class PSComment
extends Object
implements PSEntity
```
Represents a PageSeeder comment.

Version:

28 April 2014

Author:

Christophe Lauret

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PSComment.Attachment` An attachment to the comment.
`static class`	`PSComment.Author` The author of a comment.
`static class`	`PSComment.Context` The context of the comment which may be either a group or a URI.

Constructor Summary

Constructors
Constructor and Description

PSComment()

Constructors
Constructor and Description
`PSComment()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttachment(PSDocument document)` Adds the specified document as an attachment.
`void`	`addAttachment(PSDocument document, String fragment)` Adds the specified document as an attachment.
`EntityValidity`	`checkValid()` Determines whether this object is valid based on known PageSeeder constraints.
`PSMember`	`getAssignedTo()`
`List<PSComment.Attachment>`	`getAttachments()`
`PSComment.Author`	`getAuthor()`
`String`	`getContent()`
`PSComment.Context`	`getContext()`
`Date`	`getDue()`
`Long`	`getId()`
`String`	`getIdentifier()` Returns the identifier to use when connecting to PageSeeder based on the ID available.
`String`	`getKey()`
`List<String>`	`getLabels()`
`String`	`getLabelsAsString()`
`String`	`getMediaType()`
`String`	`getPriority()`
`Map<String,String>`	`getProperties()`
`String`	`getPropertiesAsString()`
`String`	`getStatus()`
`String`	`getTitle()`
`String`	`getType()`
`boolean`	`hasAttachments()`
`boolean`	`hasLabels()`
`boolean`	`hasProperties()`
`boolean`	`isIdentifiable()` Determines whether the entity can be identified in PageSeeder.
`boolean`	`isValid()` Determines whether the entity is valid based on known PageSeeder constraints.
`void`	`setAssignedto(PSMember assignedto)`
`void`	`setAttachments(List<PSComment.Attachment> attachments)`
`void`	`setAuthor(PSComment.Author author)` Sets the author directly.
`void`	`setAuthor(PSMember member)` Sets the author as a PageSeeder member.
`void`	`setAuthor(String name, String email)` Sets the author as an external user.
`void`	`setContent(String content)`
`void`	`setContext(PSDocument document)` Set the context as a document.
`void`	`setContext(PSDocument document, String fragment)` Set the context as a document fragment.
`void`	`setContext(PSExternalURI externaluri)` Set the context as an external URI.
`void`	`setContext(PSExternalURI externaluri, String fragment)` Set the context as an external URI fragment.
`void`	`setContext(PSGroup group)` Set the context as a group.
`void`	`setDue(Date due)`
`void`	`setId(Long id)`
`void`	`setLabels(List<String> labels)`
`void`	`setLabels(String labels)`
`void`	`setMediaType(String mediatype)`
`void`	`setPriority(String priority)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setProperties(String properties)`
`void`	`setStatus(String status)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PSComment
```
public PSComment()
```
- Method Detail
  - getId
```
public Long getId()
```
    Specified by:
    
    getId in interface PSEntity
    
    Returns:
    the id
  - getTitle
```
public String getTitle()
```
    Returns:
    the title
  - getContent
```
public String getContent()
```
    Returns:
    the content
  - getMediaType
```
public String getMediaType()
```
    Returns:
    the mediatype
  - getType
```
public String getType()
```
    Returns:
    the type
  - setId
```
public void setId(Long id)
```
    Parameters:
    id - the id to set
  - setTitle
```
public void setTitle(String title)
```
    Parameters:
    title - the title to set
  - setContent
```
public void setContent(String content)
```
    Parameters:
    content - the content to set
  - setMediaType
```
public void setMediaType(String mediatype)
```
    Parameters:
    mediatype - the mediatype to set
  - setType
```
public void setType(String type)
```
    Parameters:
    type - the type to set
  - hasAttachments
```
public boolean hasAttachments()
```
    Returns:
    the list of attachments
  - getAttachments
```
public List<PSComment.Attachment> getAttachments()
```
    Returns:
    the list of attachments
  - addAttachment
```
public void addAttachment(PSDocument document)
```
    Adds the specified document as an attachment.
    
    Parameters:
    document - The document to attach to the comment.
  - addAttachment
```
public void addAttachment(PSDocument document,
                 String fragment)
```
    Adds the specified document as an attachment.
    
    Parameters:
    document - The document to attach to the comment.
    fragment - The fragment ID of where the comment is attached (null for default fragment)
  - setAttachments
```
public void setAttachments(List<PSComment.Attachment> attachments)
```
    Parameters:
    attachments - the attachments to set
  - hasLabels
```
public boolean hasLabels()
```
    Returns:
    the labels
  - getLabels
```
public List<String> getLabels()
```
    Returns:
    the labels
  - getLabelsAsString
```
public String getLabelsAsString()
```
    Returns:
    The labels as a comma-separated list.
  - setLabels
```
public void setLabels(List<String> labels)
```
    Parameters:
    labels - the labels to set
  - setLabels
```
public void setLabels(String labels)
```
    Parameters:
    labels - The labels as a comma-separated list.
  - hasProperties
```
public boolean hasProperties()
```
    Returns:
    the labels
  - getProperties
```
public Map<String,String> getProperties()
```
    Returns:
    the properties
  - getPropertiesAsString
```
public String getPropertiesAsString()
```
    Returns:
    The labels as a comma-separated list.
  - setProperties
```
public void setProperties(Map<String,String> properties)
```
    Parameters:
    properties - the properties to set
  - setProperties
```
public void setProperties(String properties)
```
    Parameters:
    properties - the properties to set
  - getAuthor
```
public PSComment.Author getAuthor()
```
    Returns:
    the author
  - setAuthor
```
public void setAuthor(PSComment.Author author)
```
    Sets the author directly.
    
    Parameters:
    author - the author to set
  - setAuthor
```
public void setAuthor(PSMember member)
```
    Sets the author as a PageSeeder member.
    Implementation note: This method creates a new Author instance.
    
    Parameters:
    member - the member to set as the author
  - setAuthor
```
public void setAuthor(String name,
             String email)
```
    Sets the author as an external user.
    Implementation note: This method creates a new Author instance.
    
    Parameters:
    name - the name of the author
    email - the email of the author
  - getContext
```
public PSComment.Context getContext()
```
    Returns:
    the context
  - setContext
```
public void setContext(PSGroup group)
```
    Set the context as a group.
    Implementation note: This method creates a new context instance.
    
    Parameters:
    group - The group to use as context.
  - setContext
```
public void setContext(PSDocument document)
```
    Set the context as a document.
    Implementation note: This method creates a new context instance.
    
    Parameters:
    document - The document to use as context
  - setContext
```
public void setContext(PSExternalURI externaluri)
```
    Set the context as an external URI.
    Implementation note: This method creates a new context instance.
    
    Parameters:
    externaluri - The external URI to use as context
  - setContext
```
public void setContext(PSDocument document,
              String fragment)
```
    Set the context as a document fragment.
    Implementation note: This method creates a new context instance.
    
    Parameters:
    document - The document
    fragment - The document fragment to use as context
  - setContext
```
public void setContext(PSExternalURI externaluri,
              String fragment)
```
    Set the context as an external URI fragment.
    Implementation note: This method creates a new context instance.
    
    Parameters:
    externaluri - The external URI to use as context
    fragment - The external URI fragment to use as context
  - getStatus
```
public String getStatus()
```
    Returns:
    the status
  - getPriority
```
public String getPriority()
```
    Returns:
    the priority
  - getAssignedTo
```
public PSMember getAssignedTo()
```
    Returns:
    the assignedto
  - getDue
```
public Date getDue()
```
    Returns:
    the due
  - setStatus
```
public void setStatus(String status)
```
    Parameters:
    status - the status to set
  - setPriority
```
public void setPriority(String priority)
```
    Parameters:
    priority - the priority to set
  - setAssignedto
```
public void setAssignedto(PSMember assignedto)
```
    Parameters:
    assignedto - the assignedto to set
  - setDue
```
public void setDue(Date due)
```
    Parameters:
    due - the due to set
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface PSEntity
    
    Returns:
    the public ID for the PageSeeder entity.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: PSEntity
    
    Determines whether the entity is valid based on known PageSeeder constraints.
    
    Specified by:
    
    isValid in interface PSEntity
    
    Returns:
    true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.
  - isIdentifiable
```
public boolean isIdentifiable()
```
    Description copied from interface: PSEntity
    
    Determines whether the entity can be identified in PageSeeder.
    To be identifiable, the entity must have either a private id or a public id.
    If the public ID does not correspond to a single attribute in PageSeeder, then a combination of attributes may be used to determine whether it is possible to identify the entity.
    
    Specified by:
    
    isIdentifiable in interface PSEntity
    
    Returns:
    true if the object can be identified in PageSeeder; false if it is not possible to identify the entity form its attributes or keys.
  - getIdentifier
```
public String getIdentifier()
```
    Description copied from interface: PSEntity
    
    Returns the identifier to use when connecting to PageSeeder based on the ID available.
    When both the private and public identifier are available, the private identifier takes precedence over the public one.
    When the public identifier cannot be used on its own, then only the private ID is returned.
    In general, if the PSEntity.isIdentifiable() method return true, this method should return a value. When it is not the case, it should be clearly documented.
    
    Specified by:
    
    getIdentifier in interface PSEntity
    
    Returns:
    the identifier to use when connecting to PageSeeder.
  - checkValid
```
public EntityValidity checkValid()
```
    Description copied from interface: PSEntity
    
    Determines whether this object is valid based on known PageSeeder constraints.
    
    Specified by:
    
    checkValid in interface PSEntity
    
    Returns:
    true if the object is intrinsically valid based on its internal values; false if any of its attributes violates a PageSeeder constraint.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PSComment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PSComment

Method Detail

getId

getTitle

getContent

getMediaType

getType

setId

setTitle

setContent

setMediaType

setType

hasAttachments

getAttachments

addAttachment

addAttachment

setAttachments

hasLabels

getLabels

getLabelsAsString

setLabels

setLabels

hasProperties

getProperties

getPropertiesAsString

setProperties

setProperties

getAuthor

setAuthor

setAuthor

setAuthor

getContext

setContext

setContext

setContext

setContext

setContext

getStatus

getPriority

getAssignedTo

getDue

setStatus

setPriority

setAssignedto

setDue

getKey

isValid

isIdentifiable

getIdentifier

checkValid

toString