DocumentDataSource

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.xsp.model
Interface DocumentDataSource

All Superinterfaces:: DataPublishingObject, DataSource

All Known Implementing Classes:: AbstractDocumentDataSource, DominoDocumentData

public interface DocumentDataSource
extends DataSource
extends DataSource

This is published because it is in the inheritence heirarchy of some public data sources, but it not intended to be subclassed, and the implementation may change. Not intended to be subclassed.

Method Summary
`void`	`computeDocument(javax.faces.context.FacesContext context)` Compute the current document
`javax.faces.el.MethodBinding`	`getComputeDocument()` It is triggered at first right after loading the document (after postOpenDocument), and at the end before saving the document it (after querySaveDocument but before saving the document).
`javax.faces.el.MethodBinding`	`getPostNewDocument()` Triggered after creating the new document.
`javax.faces.el.MethodBinding`	`getPostOpenDocument()` Triggered after opening the document.
`javax.faces.el.MethodBinding`	`getPostSaveDocument()` Triggered after saving the document.
`javax.faces.el.MethodBinding`	`getQueryNewDocument()` Triggered before creating the new document.
`javax.faces.el.MethodBinding`	`getQueryOpenDocument()` Triggered before opening the document.
`javax.faces.el.MethodBinding`	`getQuerySaveDocument()` Triggered before saving the document.
`boolean`	`isDocument(java.lang.Object document)` Return true if this is the document associated with this data source
`boolean`	`isNewDocument(javax.faces.context.FacesContext context)` Return true if a new document should be created when the data source is loaded.
`DataContainer`	`newDocument(javax.faces.context.FacesContext context)` Create a new document
`DataContainer`	`openDocument(javax.faces.context.FacesContext context)` Open the specified document
`boolean`	`saveDocument(javax.faces.context.FacesContext context)` Save the current document
`void`	`setComputeDocument(javax.faces.el.MethodBinding binding)` It is triggered at first right after loading the document (after postOpenDocument), and at the end before saving the document it (after querySaveDocument but before saving the document).
`void`	`setPostNewDocument(javax.faces.el.MethodBinding binding)` Triggered after creating the new document.
`void`	`setPostOpenDocument(javax.faces.el.MethodBinding binding)` Triggered after opening the document.
`void`	`setPostSaveDocument(javax.faces.el.MethodBinding binding)` Triggered after saving the document.
`void`	`setQueryNewDocument(javax.faces.el.MethodBinding binding)` Triggered before creating the new document.
`void`	`setQueryOpenDocument(javax.faces.el.MethodBinding binding)` Triggered before opening the document.
`void`	`setQuerySaveDocument(javax.faces.el.MethodBinding binding)` Triggered before saving the document.

Methods inherited from interface com.ibm.xsp.model.DataSource
`getBeanId, getDataContainer, getRequestParamPrefix, getScope, getUniqueId, getVar, getVars, isIgnoreRequestParams, isReadonly, refresh, save, setIgnoreRequestParams, setRequestParamPrefix, setScope, setVar`

Methods inherited from interface com.ibm.xsp.model.DataPublishingObject
`popData, pushData`

Method Detail

isDocument

boolean isDocument(java.lang.Object document)

Return true if this is the document associated with this data source

newDocument

DataContainer newDocument(javax.faces.context.FacesContext context)
                          throws java.io.IOException

Create a new document

Throws:: java.io.IOException

openDocument

DataContainer openDocument(javax.faces.context.FacesContext context)
                           throws java.io.IOException

Open the specified document

Throws:: java.io.IOException

saveDocument

boolean saveDocument(javax.faces.context.FacesContext context)
                     throws java.io.IOException

Save the current document

Throws:: java.io.IOException

computeDocument

void computeDocument(javax.faces.context.FacesContext context)
                     throws java.io.IOException

Compute the current document

Throws:: java.io.IOException

isNewDocument

boolean isNewDocument(javax.faces.context.FacesContext context)

Return true if a new document should be created when the data source is loaded.

setQueryNewDocument

void setQueryNewDocument(javax.faces.el.MethodBinding binding)

Triggered before creating the new document.

Parameters:: binding -

setQueryOpenDocument

void setQueryOpenDocument(javax.faces.el.MethodBinding binding)

Triggered before opening the document.

Parameters:: binding -

setQuerySaveDocument

void setQuerySaveDocument(javax.faces.el.MethodBinding binding)

Triggered before saving the document.

Parameters:: binding -

setPostNewDocument

void setPostNewDocument(javax.faces.el.MethodBinding binding)

Triggered after creating the new document.

Parameters:: binding -

setPostOpenDocument

void setPostOpenDocument(javax.faces.el.MethodBinding binding)

Triggered after opening the document.

Parameters:: binding -

setPostSaveDocument

void setPostSaveDocument(javax.faces.el.MethodBinding binding)

Triggered after saving the document.

Parameters:: binding -

setComputeDocument

void setComputeDocument(javax.faces.el.MethodBinding binding)

It is triggered at first right after loading the document (after postOpenDocument), and at the end before saving the document it (after querySaveDocument but before saving the document). This event is useful to compute field values, either for use in GUI presentation (after loading the document), or to save values in the document itself (before saving the document).

Parameters:: binding -

getQueryNewDocument

javax.faces.el.MethodBinding getQueryNewDocument()