Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface ContainerManager


public interface ContainerManager

A class that implements the ContainerManager interface provides functionality to add and remove containers from a teamspace. A teamspace container provides an abstract method of storing and retrieving objects within a teamspace.

See Also:
ContainerDefinition, ContainersStore, Container, FolderContainer

Method Summary
 Container getContainerByDefinitionID(java.lang.String containerDefinitionID)
          Return a Container object based on the container's definition ID, may return null if that class of container has not been registered to the teamspace.
 Container getContainerOfContainee(int containeeObjectType, java.lang.String containeeID)
          Return a Container object based on the container's definition ID, may return null if that class of container has not been registered to the teamspace.
 java.util.Iterator getContainers()
          Return an iterator over the collection of the Container objects registered for this teamspace.
 boolean hasContainer(java.lang.String containerDefinitionID)
          Return true if a container defined by the container definition ID is registered with the teamspace.
 void registerContainers(ContainerInfo[] containerInfo)
          Register Container objects with a teamspace.
 

Method Detail

getContainerByDefinitionID

public Container getContainerByDefinitionID(java.lang.String containerDefinitionID)
Return a Container object based on the container's definition ID, may return null if that class of container has not been registered to the teamspace.

Parameters:
containerDefinitionID - The definition ID of the container, required.

Returns:
A Container object that must implement either the Container or FolderContainer interfaces.

getContainerOfContainee

public Container getContainerOfContainee(int containeeObjectType,
                                         java.lang.String containeeID)
Return a Container object based on the container's definition ID, may return null if that class of container has not been registered to the teamspace.

Parameters:
containeeObjectType - The type of the Containee object, required.

containeeID - The ID of a Containee object, required.

Returns:
A Container object that must implement either the Container or FolderContainer interfaces.

getContainers

public java.util.Iterator getContainers()
Return an iterator over the collection of the Container objects registered for this teamspace.

Returns:
An iterator over a collection of Container objects that must implement either the Container or FolderContainer interfaces.

registerContainers

public void registerContainers(ContainerInfo[] containerInfo)
                        throws NonTeamspaceMemberException
Register Container objects with a teamspace.

Parameters:
containerInfo - An array of BsoTeamspacContainerInfo objects, required.

hasContainer

public boolean hasContainer(java.lang.String containerDefinitionID)
Return true if a container defined by the container definition ID is registered with the teamspace.

Parameters:
containerDefinitionID - The container definition ID. Required.

Returns:
A boolean value, true if the container is registered.

Collaboration API Documentation

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