com.filenet.bso.api.collaboration
Interface FolderContainer
- All Superinterfaces:
- CollaborationObject, Container, PersistentBaseObject
- All Known Subinterfaces:
- Forum, Meeting
- public interface FolderContainer
- extends Container, PersistentBaseObject
Classes that implement the FolderContainer
interface support
containers within the collaboration environment that are based on the containment capabilities
of a Content Engine Folder
object.
- See Also:
FolderContainerInfo
,
ForumInfo
Field Summary |
static java.lang.String[] |
PROPERTIES
|
Fields inherited from interface com.filenet.bso.api.collaboration.Container |
ADD_CONTAINEES_CAPABILITY, ADD_SUBCONTAINERS_CAPABILITY, ASCENDING_SORT, DEACTIVATE_CAPABILITY, DESCENDING_SORT, FIND_BY_ID_CAPABILITY, FIND_BY_NAME_CAPABILITY, HAS_CONTAINEES_CAPABILITY, HAS_SUBCONTAINERS_CAPABILITY, REMOVE_CONTAINEES_CAPABILITY, REMOVE_SUBCONTAINERS_CAPABILITY |
Method Summary |
FolderContainer |
addSubContainer(java.lang.Object infoObject)
Add a subcontainer object to a container. |
FolderContainer |
findSubContainerByID(java.lang.String id)
Return a subcontainer object, if any, that matches the ID in the id parameter. |
java.util.Iterator |
getEligibleMembers()
Returns an Iterator over a collection of Member objects
which defines the set of teamspace members who are eligible to perform work in this container. |
java.util.Iterator |
getSubContainers()
Returns an iterator over the collection of subcontainer objects within the container. |
java.lang.String |
getSubContainersXML(java.lang.String[] propertyNames,
OrderBy[] sortOrder)
Returns an XML representation of the subcontainer objects. |
void |
removeSubContainer(java.lang.String subContainerGUID)
Remove a subcontainer.. |
PROPERTIES
public static final java.lang.String[] PROPERTIES
findSubContainerByID
public FolderContainer findSubContainerByID(java.lang.String id)
throws java.lang.Exception
- Return a subcontainer object, if any, that matches the ID in the
id
parameter.
- Parameters:
id
- An ID string value used to retrieve a subcontainer object.
- Returns:
- A
FolderContainer
object that is the subcontainer object, if any.
- Throws:
UnsupportedContainerCapabilityException
- if the container does not support this capability.
addSubContainer
public FolderContainer addSubContainer(java.lang.Object infoObject)
throws java.lang.Exception
- Add a subcontainer object to a container. The
infoObject
parameter is info object that holds data
that the container will use to create the actual subcontainer object.
- Parameters:
infoObject
- A "info object" that holds data used by the container to create the subcontainer object.
- Returns:
- A Java
Object
that is the actual subcontainer object created by the container from the info object.
- Throws:
UnsupportedContainerCapabilityException
- if the container does not support this capability.
getSubContainers
public java.util.Iterator getSubContainers()
throws java.lang.Exception
- Returns an iterator over the collection of subcontainer objects within the container.
- Returns:
- A Java
Iterator
object that provides access to all subcontainer objects within the container.
removeSubContainer
public void removeSubContainer(java.lang.String subContainerGUID)
throws java.lang.Exception
- Remove a subcontainer..
- Parameters:
subContainerGUID
- The GUID of the subcontainer to remove.
getSubContainersXML
public java.lang.String getSubContainersXML(java.lang.String[] propertyNames,
OrderBy[] sortOrder)
throws java.lang.Exception
- Returns an XML representation of the subcontainer objects.
- Parameters:
propertyNames
- A String
array containing the property
names to include in the XML.
sortOrder
- An OrderBy
array that contains the property name and
sort order (ASCENDING_SORT or DESCENDING_SORT) for each property value
selected to sort on. Optional, may be null.
- Returns:
- The XML representation of subcontainer objects in the container.
- Throws:
UnsupportedContainerCapabilityException
- if the container does not support this capability.
getEligibleMembers
public java.util.Iterator getEligibleMembers()
throws java.lang.Exception
- Returns an
Iterator
over a collection of Member
objects
which defines the set of teamspace members who are eligible to perform work in this container.
- Returns:
- An
Iterator
over a collection of teamspace member objects.
Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.