Collaboration API Documentation

com.filenet.bso.api.util
Class BsoPersistentDataContainerFactory

java.lang.Object
  |
  +--com.filenet.bso.api.util.BsoPersistentDataContainerFactory

public class BsoPersistentDataContainerFactory
extends java.lang.Object

The BsoPersistentDataContainerFactory creates instances of the BsoPersistentDataContainerImpl class that implements the BsoPersistentDataContainer interface.

The BsoPersistentDataContainerImpl class is used to persist name:value data into a FileNet Content Engine Document object. The document class of the object is "Persistent Data Container".

See Also:
BsoPersistentDataContainer

Method Summary
static BsoPersistentDataContainer create(com.filenet.wcm.api.ObjectStore objectStore, com.filenet.wcm.api.Folder folder, java.lang.String fileName, com.filenet.wcm.api.WriteableMetadataObject parent, java.lang.String associatePropertyName)
          Creates an instance of a BsoPersistentDataContainer class.
static BsoPersistentDataContainer retrieve(com.filenet.wcm.api.Document document)
          Retrieves an existing instance of a BsoPersistentDataContainer object.
static BsoPersistentDataContainer retrieve(com.filenet.wcm.api.ObjectStore objectStore, com.filenet.wcm.api.Folder folder, java.lang.String fileName)
          Retrieves an existing instance of a BsoPersistentDataContainer object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static BsoPersistentDataContainer create(com.filenet.wcm.api.ObjectStore objectStore,
                                                com.filenet.wcm.api.Folder folder,
                                                java.lang.String fileName,
                                                com.filenet.wcm.api.WriteableMetadataObject parent,
                                                java.lang.String associatePropertyName)
Creates an instance of a BsoPersistentDataContainer class.

This method files the underlying Content Engine document object in the folder specified by the folder parameter.

The fileName parameter provides the name that is associated with the document object.

If the parent parameter is not null, the newly created document object will be set into an object property of the parent Content Engine object. The associatePropertyName parameter must contain the name of the parent property to be used.

Parameters:
objectStore - The Content Engine object store.

folder - The Content Engine folder.

fileName - The filename for the new Content Engine document object.

parent - The parent Content Engine object.

associatePropertyName - The name of the object property on the parent object.

Returns:
A BsoPersistentDataContainer object.

retrieve

public static BsoPersistentDataContainer retrieve(com.filenet.wcm.api.ObjectStore objectStore,
                                                  com.filenet.wcm.api.Folder folder,
                                                  java.lang.String fileName)
Retrieves an existing instance of a BsoPersistentDataContainer object.

The underlying Content Engine document object will be retrieved based on constructing a path-based reference to the object, using the object store, folder and filename.

Parameters:
objectStore - The Content Engine object store.

folder - The Content Engine folder.

fileName - The filename for the new Content Engine document object.

Returns:
A BsoPersistentDataContainer object.

retrieve

public static BsoPersistentDataContainer retrieve(com.filenet.wcm.api.Document document)
Retrieves an existing instance of a BsoPersistentDataContainer object.

This method constructs the BsoPersistentDataContainer object based on the document parameter.

Parameters:
document - The Content Engine document.

Returns:
A BsoPersistentDataContainer object.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.