Collaboration API Documentation

com.filenet.bso.api.collaboration.store
Interface ContainerDefinition


public interface ContainerDefinition

Classes that implement the ContainerDefinition define containers that can optionally be added to a teamspace.

See Also:
Teamspace, Container, FolderContainer

Method Summary
 java.util.Iterator getContaineeObjectTypes()
          Return an iterator over a collection of Integers that specify the object types of the objects that may reside in the container.
 java.lang.String getDefinitionID()
          Return the ID of the collaboration container definition in the Collaboration Store.
 java.lang.String getDescription()
          Return the description of the container definition.
 java.lang.String getFolderClassSymname()
          Return the symbolic name of the Content Engine Folder class which is the basis for the container.
 java.lang.String getFolderName()
          Return the name to assign to the Content Engine Folder object which is the basis for the container.
 java.lang.String getJavaClass()
          Return the Java class name of a class that implements either the Container or FolderContainer interface.
 java.lang.String getLabel()
          Return a name label for the container definition.
 java.lang.String getParentDefinitionID()
          Return the definition ID of the collaboration container of which this container is a subcontainer.
 java.util.Iterator getSubContainerObjectTypes()
          Return an iterator over a collection of Integers that specify the object types of the subcontainers that may reside in the container.
 java.lang.String getSymbolicName()
          Return the symbolic name of the container definition.
 boolean isFolderBased()
          Return true if the Java container class implements the FolderContainer interface.
 

Method Detail

getDefinitionID

public java.lang.String getDefinitionID()
Return the ID of the collaboration container definition in the Collaboration Store.

Returns:
A String containing the container definition ID.

getParentDefinitionID

public java.lang.String getParentDefinitionID()
Return the definition ID of the collaboration container of which this container is a subcontainer.

Returns:
A String containing the container definition ID of parent container.

getLabel

public java.lang.String getLabel()
Return a name label for the container definition.

Returns:
A String containing the name label.

getDescription

public java.lang.String getDescription()
Return the description of the container definition.

Returns:
A String containing the description.

getSymbolicName

public java.lang.String getSymbolicName()
Return the symbolic name of the container definition.

Returns:
A String containing the symbolic name of the container definition.

getJavaClass

public java.lang.String getJavaClass()
Return the Java class name of a class that implements either the Container or FolderContainer interface. This is the class that a teamspace instantiates when the container is registered.

Returns:
A String containing a Java class name.

isFolderBased

public boolean isFolderBased()
Return true if the Java container class implements the FolderContainer interface.

Returns:
A boolean value.

getFolderClassSymname

public java.lang.String getFolderClassSymname()
Return the symbolic name of the Content Engine Folder class which is the basis for the container. Returns null if the container is not folder-based.

Returns:
A String containing a symbolic name for a folder class.

getFolderName

public java.lang.String getFolderName()
Return the name to assign to the Content Engine Folder object which is the basis for the container. Returns null if the container is not folder-based, or if the container definition is for a subcontainer.

Returns:
A String containing the name to assign to the folder object.

getContaineeObjectTypes

public java.util.Iterator getContaineeObjectTypes()
Return an iterator over a collection of Integers that specify the object types of the objects that may reside in the container.

Returns:
An Iterator containing the object types of the container's containees.

getSubContainerObjectTypes

public java.util.Iterator getSubContainerObjectTypes()
Return an iterator over a collection of Integers that specify the object types of the subcontainers that may reside in the container.

Returns:
An Iterator containing the object types of the container's subcontainers.

Collaboration API Documentation

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