com.ibm.xsp.model
Interface DataPublishingObject

All Known Subinterfaces:

DataContext, DataSource, DocumentDataSource, ModelDataSource, ViewDataSource

All Known Implementing Classes:

AbstractDataSource, AbstractDocumentDataSource, AbstractViewDataSource, BundleResource, DominoDocumentData, DominoViewData

public interface DataPublishingObject

A complex-type that publishes a var or vars to the request scope.

Method Summary

void

popData(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.util.Map<java.lang.String,java.lang.Object> requestMap) Pop the data associated with this data source from the request map, note, if values were added to the shadowedData list during pushData(FacesContext, UIComponent, Map, List), then it is not necessary to remove them from the request map in this method (as the calling class will remove them).

void

pushData(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.util.Map<java.lang.String,java.lang.Object> requestMap, java.util.List<DataPublisher.ShadowedObject> shadowedData) Push the data associated with this data source into the request map

Method Detail

pushData

void pushData(javax.faces.context.FacesContext context,
              javax.faces.component.UIComponent component,
              java.util.Map<java.lang.String,java.lang.Object> requestMap,
              java.util.List<DataPublisher.ShadowedObject> shadowedData)
              throws FacesExceptionEx

Push the data associated with this data source into the request map

Throws:

FacesExceptionEx

popData

void popData(javax.faces.context.FacesContext context,
             javax.faces.component.UIComponent component,
             java.util.Map<java.lang.String,java.lang.Object> requestMap)
             throws FacesExceptionEx

Pop the data associated with this data source from the request map, note, if values were added to the shadowedData list during pushData(FacesContext, UIComponent, Map, List), then it is not necessary to remove them from the request map in this method (as the calling class will remove them). This method should do any further tidying up required.

Throws:

FacesExceptionEx