com.bluestream.xdb.dsobject.config
Interface CollectionMgr

public interface CollectionMgr

Field Summary

static int

k_makeParentCollections

Method Summary

com.bluestream.xdb.dsobject.config.DSCollection	createCollection(String newCollectionId, int flag) Create a new collection which will have the name contained in the newCollectionId
void	deleteCollectionTree(String collectionId) Perform a deep delete of tree node
com.bluestream.xdb.dsobject.config.DSCollection	getCollection(String collectionId, int flag)
DSObjectCursor	getCollectionTree() return a list of DSCollections, top level first, followed by nested
void	renameTree(String collectionId, String newCollectionId)

Field Detail

k_makeParentCollections

public static final int k_makeParentCollections

See Also:

Constant Field Values

Method Detail

createCollection

public com.bluestream.xdb.dsobject.config.DSCollection createCollection(String newCollectionId,
                                                                        int flag)
                                                                 throws XDBException

Create a new collection which will have the name contained in the newCollectionId

Parameters:

flag - DSObjectMgr.k_makeParentCollections. If parent collections don't exist - create them. The root mounted root collection must exist, otherwise this fails. DSObjectMgr.k_default. default is to not create parent collections. Note: In order for this to become persistent you must call save() on the new collection.

Returns:

Collection. The newly created collection.

Throws:

XDBException - EC_ParentNotFound. The parent collection is not found.

deleteCollectionTree

public void deleteCollectionTree(String collectionId)
                          throws XDBException

Perform a deep delete of tree node

Throws:

XDBException

getCollection

public com.bluestream.xdb.dsobject.config.DSCollection getCollection(String collectionId,
                                                                     int flag)
                                                              throws XDBException

Throws:

XDBException

getCollectionTree

public DSObjectCursor getCollectionTree()
                                 throws XDBException

return a list of DSCollections, top level first, followed by nested

Returns:

Throws:

XDBException

renameTree

public void renameTree(String collectionId,
                       String newCollectionId)