Collaboration API Documentation

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


public interface ContainersStore

A class that implements the ContainersStore interface provides access to ContainerDefinition objects in the Collaboration Store. These objects define containers that can be registered for use within a teamspace.

See Also:
ContainerDefinition, Container, FolderContainer, Teamspace, ContainerManager

Method Summary
 ContainerDefinition getContainerDefinitionByID(java.lang.String definitionID)
          Return a ContainerDefinition object from the Collaboration Store based on the unique container definition id.
 ContainerDefinition getContainerDefinitionBySymName(java.lang.String definitionSymName)
          Return a ContainerDefinition container object from the Collaboration Store based on the unique container definition id.
 java.util.Iterator getContainerDefinitions()
          Return an iterator over the collection of ContainerDefinition objects in the Collaboration Store.
 java.lang.String getContainerDefinitionsXML()
          Return all the ContainerDefinition objects in the Collaboration Store, returned as XML.
 ContainerDefinition getParentContainerByObjectType(int childObjectType)
          Return the parent ContainerDefinition object based on the given child object type.
 ContainerDefinition getSubContainerDefinitionByID(java.lang.String definitionID)
          Return a ContainerDefinition sub-container object from the Collaboration Store based on the unique container definition id.
 ContainerDefinition getSubContainerDefinitionBySymName(java.lang.String definitionSymName)
          Return a ContainerDefinition container object from the Collaboration Store based on the unique container definition id.
 java.util.Iterator getSubContainerDefinitions()
          Return an iterator over the collection of ContainerDefinition objects for sub-containers in the Collaboration Store.
 java.lang.String getSubContainerDefinitionsXML()
          Return all the ContainerDefinition sub-container objects in the Collaboration Store, returned as XML.
 

Method Detail

getContainerDefinitionByID

public ContainerDefinition getContainerDefinitionByID(java.lang.String definitionID)
Return a ContainerDefinition object from the Collaboration Store based on the unique container definition id.

Parameters:
definitionID - The definition id of the container.

Returns:
A ContainerDefinition object.

getContainerDefinitionBySymName

public ContainerDefinition getContainerDefinitionBySymName(java.lang.String definitionSymName)
Return a ContainerDefinition container object from the Collaboration Store based on the unique container definition id.

Parameters:
definitionSymName - The symbolic name of the container.

Returns:
A ContainerDefinition object.

getContainerDefinitions

public java.util.Iterator getContainerDefinitions()
Return an iterator over the collection of ContainerDefinition objects in the Collaboration Store.

Returns:
An iterator over a collection of ContainerDefinition objects.

getContainerDefinitionsXML

public java.lang.String getContainerDefinitionsXML()
Return all the ContainerDefinition objects in the Collaboration Store, returned as XML.

Returns:
A XML String.

getSubContainerDefinitionByID

public ContainerDefinition getSubContainerDefinitionByID(java.lang.String definitionID)
Return a ContainerDefinition sub-container object from the Collaboration Store based on the unique container definition id.

Parameters:
definitionID - The definition id of the container.

Returns:
A ContainerDefinition object.

getSubContainerDefinitionBySymName

public ContainerDefinition getSubContainerDefinitionBySymName(java.lang.String definitionSymName)
Return a ContainerDefinition container object from the Collaboration Store based on the unique container definition id.

Parameters:
definitionSymName - The symbolic name of the container.

Returns:
A ContainerDefinition object.

getSubContainerDefinitions

public java.util.Iterator getSubContainerDefinitions()
Return an iterator over the collection of ContainerDefinition objects for sub-containers in the Collaboration Store.

Returns:
An iterator over a collection of ContainerDefinition objects.

getSubContainerDefinitionsXML

public java.lang.String getSubContainerDefinitionsXML()
Return all the ContainerDefinition sub-container objects in the Collaboration Store, returned as XML.

Returns:
A XML String.

getParentContainerByObjectType

public ContainerDefinition getParentContainerByObjectType(int childObjectType)
Return the parent ContainerDefinition object based on the given child object type.

Parameters:
childObjectType - The object type of a child object of a parent container.

Returns:
A ContainerDefinition object.

Collaboration API Documentation

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