Serialized Form (PageSeeder Bridge 0.8.3 API)

Package org.pageseeder.bridge
- Class org.pageseeder.bridge.APIException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.pageseeder.bridge.FailedPrecondition extends APIException implements Serializable
  
  serialVersionUID:
  
  -521141112817296283L
- Class org.pageseeder.bridge.InvalidEntityException extends APIException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _entityType
```
Class<T> _entityType
```
      The type of entity.
    - _validity
```
EntityValidity _validity
```
      The type of entity.
- Class org.pageseeder.bridge.PSSession extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _jsessionid
```
String _jsessionid
```
      The session ID in PageSeeder.
    - timestamp
```
long timestamp
```
      Indicates when the user was last successfully connected to PageSeeder.
      This time stamp is used to determine whether the session is still likely to be valid.
Package org.pageseeder.bridge.model
- Class org.pageseeder.bridge.model.PSAddressable extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - scheme
```
String scheme
```
      The scheme.
    - host
```
String host
```
      The host.
    - port
```
int port
```
      The host.
    - path
```
String path
```
      The path.
- Class org.pageseeder.bridge.model.PSComment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
Long id
```
      The XLink ID of the comment.
    - title
```
String title
```
      The title of the comment (required)
    - content
```
String content
```
      The content of the comment (required)
    - mediatype
```
String mediatype
```
      The content type of the comment, defaults to 'text/plain'
    - type
```
String type
```
      The type of the comment to further qualify the comment.
    - labels
```
List<E> labels
```
      The list of labels on the comment.
    - properties
```
Map<K,V> properties
```
      A pipe-separated list of properties as value pairs (e.g. x=1|y=2|)
    - author
```
PSComment.Author author
```
      The author of the comment.
    - status
```
String status
```
      The status for task e.g. 'Open', 'Resolved', 'Closed'
    - priority
```
String priority
```
      The priority for task e.g. 'High', 'Medium', 'Low'
    - assignedto
```
PSMember assignedto
```
      The member ID of the member the task should be assigned to.
    - due
```
Date due
```
      The task due date format is ISO-8601 e.g. 2010-10-25, 2010-10-25T12:26 (defaults to T18:00)
    - context
```
PSComment.Context context
```
      The context of this comment
    - attachments
```
List<E> attachments
```
      The list of attachments for this comment
- Class org.pageseeder.bridge.model.PSComment.Attachment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _uri
```
PSURI _uri
```
      The URI of the attachment.
    - _fragment
```
String _fragment
```
      The fragment the comment is attached to.
- Class org.pageseeder.bridge.model.PSComment.Author extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _name
```
String _name
```
      The name of the author (required) yes string
    - _member
```
PSMember _member
```
      When the author is a member
    - _email
```
String _email
```
      The email of the author yes email
- Class org.pageseeder.bridge.model.PSComment.Context extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _group
```
PSGroup _group
```
      The group the comment is attached to.
    - _uri
```
PSURI _uri
```
      The URI the comment is attached to.
    - _fragment
```
String _fragment
```
      The fragment (for a URI only)
- Class org.pageseeder.bridge.model.PSDetails extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fields
```
String[] fields
```
      Internal array to store the field values.
- Class org.pageseeder.bridge.model.PSDocument extends PSURI implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
String type
```
      The document type (PSML only)
- Class org.pageseeder.bridge.model.PSExternalURI extends PSURI implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - folder
```
boolean folder
```
      If this URL is a folder
- Class org.pageseeder.bridge.model.PSFolder extends PSURI implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.pageseeder.bridge.model.PSGroup extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - id
```
Long id
```
      PageSeeder database ID.
    - name
```
String name
```
      The full name of the group
    - owner
```
String owner
```
      The owner of the group
    - description
```
String description
```
      The description of the group
    - defaultRole
```
PSRole defaultRole
```
      The default role when users are invited
    - defaultNotification
```
PSNotification defaultNotification
```
      The default role when users are invited
    - detailsType
```
String detailsType
```
      The type of details
    - template
```
String template
```
      The template folder for customizations (aka style owner)
- Class org.pageseeder.bridge.model.PSGroupFolder extends PSAddressable implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - id
```
Long id
```
      ID of the Group URI in PageSeeder
    - isExternal
```
boolean isExternal
```
      Whether it points to an external location
- Class org.pageseeder.bridge.model.PSMember extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - id
```
Long id
```
      The PageSeeder database ID.
    - username
```
String username
```
      The username of the member.
    - firstname
```
String firstname
```
      The first name of the member.
    - surname
```
String surname
```
      The last name of the member.
    - email
```
String email
```
      The email address of the member.
    - activated
```
boolean activated
```
      Whether the member has been activated.
- Class org.pageseeder.bridge.model.PSMembership extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - id
```
Long id
```
      The PageSeeder id of the member.
    - group
```
PSGroup group
```
      The PageSeeder group the member belongs to
    - member
```
PSMember member
```
      The member instance
    - listed
```
boolean listed
```
      Indicates whether the email address is visible to others in the group
    - notification
```
PSNotification notification
```
      Notification setting of the member for the group.
    - role
```
PSRole role
```
      Role of the member in the group.
    - created
```
Date created
```
      Membership created date (since 5.7)
    - details
```
PSDetails details
```
      Membership detail fields if any
- Class org.pageseeder.bridge.model.PSPredicate extends Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - type
```
String type
```
      The type of search result requested.
    - facets
```
Map<K,V> facets
```
      Facets.
    - page
```
int page
```
      Facets.
    - pageSize
```
int pageSize
```
      Facets.
    - from
```
long from
```
    - to
```
long to
```
    - sortBy
```
String sortBy
```
- Class org.pageseeder.bridge.model.PSProject extends PSGroup implements Serializable
  
  serialVersionUID:
  
  1L
- Class org.pageseeder.bridge.model.PSResult extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fields
```
List<E> fields
```
      Fields inside the single result.
    - group
```
PSGroup group
```
      The group this result is part of.
- Class org.pageseeder.bridge.model.PSResult.Field extends Object implements Serializable
  
  serialVersionUID:
  
  20140219L
  - Serialized Fields
    - _name
```
String _name
```
      The name of the index field.
    - _value
```
String _value
```
      The value of the index field.
- Class org.pageseeder.bridge.model.PSThreadStatus extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - _threadID
```
String _threadID
```
      The thread ID.
    - name
```
String name
```
      The thread name.
    - username
```
String username
```
      The author's username.
    - groupID
```
Long groupID
```
      The context group id.
    - status
```
PSThreadStatus.Status status
```
      The thread status.
    - messages
```
List<E> messages
```
      The thread's list of messages.
- Class org.pageseeder.bridge.model.PSURI extends PSAddressable implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - id
```
Long id
```
      The URI ID of the document
    - docid
```
String docid
```
      The document ID of the document
    - description
```
String description
```
      The description of the document
    - title
```
String title
```
      The user title of the document
    - mediatype
```
String mediatype
```
      The media type
    - created
```
Date created
```
      The created date
    - modified
```
Date modified
```
      The modified date
    - labels
```
List<E> labels
```
      List of labels on the document
- Class org.pageseeder.bridge.model.PSXRef extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
Long id
```
      The XRef ID
    - sourceURIId
```
Long sourceURIId
```
      The ID of the source document.
    - sourceFragment
```
String sourceFragment
```
      The source fragment.
    - sourceURITitle
```
String sourceURITitle
```
      The source document tile
    - sourceDocid
```
String sourceDocid
```
      The Document ID of the source document.
    - sourceMediaType
```
String sourceMediaType
```
      The source document media type
    - sourceHref
```
String sourceHref
```
      The href pointing to the source document.
    - targetURIId
```
Long targetURIId
```
      The ID of the target document.
    - targetURITitle
```
String targetURITitle
```
      The target document tile
    - targetDocid
```
String targetDocid
```
      The Document ID of the target document.
    - targetMediaType
```
String targetMediaType
```
      The target document media type
    - targetHref
```
String targetHref
```
      The href pointing to the target document.
    - targetFragment
```
String targetFragment
```
      The target fragment.
    - reverseLink
```
boolean reverseLink
```
      A flag specifying if the xref is a reverse link.
    - reverseTitle
```
String reverseTitle
```
      The reverse title.
    - title
```
String title
```
      The manually entered tile
    - level
```
Integer level
```
      The level of numbering.
    - display
```
PSXRef.DISPLAY display
```
      The display type.
    - type
```
PSXRef.TYPE type
```
      The type of the xref.
    - reverseType
```
PSXRef.TYPE reverseType
```
      The reverse type.
    - labels
```
List<E> labels
```
      The XRef's labels.

Serialized Form

Package org.pageseeder.bridge

Class org.pageseeder.bridge.APIException extends Exception implements Serializable

Class org.pageseeder.bridge.FailedPrecondition extends APIException implements Serializable

Class org.pageseeder.bridge.InvalidEntityException extends APIException implements Serializable

Serialized Fields

_entityType

_validity

Class org.pageseeder.bridge.PSSession extends Object implements Serializable

Serialized Fields

_jsessionid

timestamp

Package org.pageseeder.bridge.model

Class org.pageseeder.bridge.model.PSAddressable extends Object implements Serializable

Serialized Fields

scheme

host

port

path

Class org.pageseeder.bridge.model.PSComment extends Object implements Serializable

Serialized Fields

id

title

content

mediatype

type

labels

properties

author

status

priority

assignedto

due

context

attachments

Class org.pageseeder.bridge.model.PSComment.Attachment extends Object implements Serializable

Serialized Fields

_uri

_fragment

Class org.pageseeder.bridge.model.PSComment.Author extends Object implements Serializable

Serialized Fields

_name

_member

_email

Class org.pageseeder.bridge.model.PSComment.Context extends Object implements Serializable

Serialized Fields

_group

_uri

_fragment

Class org.pageseeder.bridge.model.PSDetails extends Object implements Serializable

Serialized Fields

fields

Class org.pageseeder.bridge.model.PSDocument extends PSURI implements Serializable

Serialized Fields

type

Class org.pageseeder.bridge.model.PSExternalURI extends PSURI implements Serializable

Serialized Fields

folder

Class org.pageseeder.bridge.model.PSFolder extends PSURI implements Serializable

Class org.pageseeder.bridge.model.PSGroup extends Object implements Serializable

Serialized Fields

id

name

owner

description

defaultRole

defaultNotification

detailsType

template

Class org.pageseeder.bridge.model.PSGroupFolder extends PSAddressable implements Serializable

Serialized Fields

id

isExternal

Class org.pageseeder.bridge.model.PSMember extends Object implements Serializable

Serialized Fields

id

username

firstname

surname

email