Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


oracle.webcenter.doclib.model
Interface DocumentDescriptorFilter


public interface DocumentDescriptorFilter

A DocumentDescriptorFilter provides an injection point for adding attribute values to a Document or Folder in the Documents Service model layer. This mechanism may be useful in combination with any additional metadata fields defined in the content repository, which need manipulation prior to display by the Documents Service view layer. The DocumentDescriptorFilter does not affect the persisted attribute values.

The java.util.ServiceLoader mechanism is used to load all available filters. An implementer should implement DocumentDescriptorFilter, providing an implementation of filterOnRead. The implementation must then be declared in file, META-INF/services/oracle.webcenter.doclib.model.DocumentDescriptorFilter , that is in a jar that is deployed as part of the WebCenter portal application. The WebCenter Spaces application extensibility mechanism can be used to introduce this dependency to the WebCenter Spaces application.

Since:
11.1.1.6.0

Method Summary
 void filterOnRead(DocumentDescriptor document, DataObject idcObject)
          Method used to extend an item constructed from a Content Server object.
 void filterOnRead(DocumentDescriptor document, javax.jcr.Node node)
          Method used to extend an item constructed from a Content Repository object.

 

Method Detail

filterOnRead

void filterOnRead(DocumentDescriptor document,
                  DataObject idcObject)
Method used to extend an item constructed from a Content Server object. The DataObject can be used to read fields coming from the content server. Any extension to the item should be stored in the map available from document.getAttr().
Parameters:
document - the item that needs to be extended
idcObject - the source data from the content server

filterOnRead

void filterOnRead(DocumentDescriptor document,
                  javax.jcr.Node node)
Method used to extend an item constructed from a Content Repository object. The javax.jcr.Node can be used to read fields coming from the content repository. Any extension to the item should be stored in the map available from document.getAttr().
Parameters:
document - the item that needs to be extended
node - the source data from the content repository

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.