|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Classes that implement the Container
interface support
virtual containers within the collaboration work environment. Unlike the FolderContainer
interface, which is based on the containment capabilities of a Content Engine Folder
object,
this interface supports the model of a virtual (as opposed to a physical) container.
ContainerManager
from a teamspace and call
the registerContainers() or registerFolderContainer() methods.
Containers that implement the Container
interface
may or may not support the following capabilities:
FolderContainer
interface
may or may not support the following capabilities:
FolderContainer
,
PostingInfo
,
FolderContainerInfo
,
ForumInfo
,
WorkflowInfo
,
ContainerDefinition
,
ContainersStore
,
ContainerManager
Field Summary | |
static int |
ADD_CONTAINEES_CAPABILITY
Value of 1; test whether a container supports adding containees. |
static int |
ADD_SUBCONTAINERS_CAPABILITY
Value of 5; test whether a container supports adding sub-containers. |
static int |
ASCENDING_SORT
Value of 0; if sort properties present, sort in ascending order |
static int |
DEACTIVATE_CAPABILITY
Value of 9; test whether a container supports deactivation. |
static int |
DESCENDING_SORT
Value of 1; if sort properties present, sort in descending order |
static int |
FIND_BY_ID_CAPABILITY
Value of 2; test whether a container supports retrieving containees by id. |
static int |
FIND_BY_NAME_CAPABILITY
Value of 3; test whether a container supports retrieving containees by name. |
static int |
HAS_CONTAINEES_CAPABILITY
Value of 7; test whether a container supports containee objects. |
static int |
HAS_SUBCONTAINERS_CAPABILITY
Value of 8; test whether a container supports sub-container objects. |
static int |
REMOVE_CONTAINEES_CAPABILITY
Value of 0; test whether a container supports removing containees. |
static int |
REMOVE_SUBCONTAINERS_CAPABILITY
Value of 6; test whether a container supports removing sub-containers. |
Method Summary | |
java.lang.Object |
addContainee(java.lang.Object infoObject)
Add a containee object to a container. |
java.lang.Object |
findContaineeByID(java.lang.String id,
int objectType)
Return a containee object, if any, that matches the id in the id parameter. |
java.lang.Object |
findContaineeByName(java.lang.String name)
Return a containee object, if any, that matches the name in the name parameter. |
java.util.Iterator |
getContainees()
Returns an iterator over the collection of containee objects within the container. |
java.lang.String |
getContaineesXML(java.lang.String[] propertyNames,
OrderBy[] sortOrder)
Returns an XML representation of the containee objects. |
java.lang.String |
getDefinitionID()
Return the container definition id. |
java.lang.String |
getName()
Return the name of the container. |
void |
removeContainee(java.lang.String containeeID,
int objectType)
Remove and deleted a containee object from a container. |
boolean |
supports(int containerCapability)
Return true if the container supports the capability specified by the parameter containerCapability
|
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject |
getSymbolicName, getType |
Field Detail |
public static final int ASCENDING_SORT
public static final int DESCENDING_SORT
public static final int REMOVE_CONTAINEES_CAPABILITY
public static final int ADD_CONTAINEES_CAPABILITY
public static final int FIND_BY_ID_CAPABILITY
public static final int FIND_BY_NAME_CAPABILITY
public static final int ADD_SUBCONTAINERS_CAPABILITY
public static final int REMOVE_SUBCONTAINERS_CAPABILITY
public static final int HAS_CONTAINEES_CAPABILITY
public static final int HAS_SUBCONTAINERS_CAPABILITY
public static final int DEACTIVATE_CAPABILITY
Method Detail |
public java.lang.Object addContainee(java.lang.Object infoObject) throws java.lang.Exception
infoObject
parameter is info object that holds data
that the container will use to create the actual containee object.
infoObject
- A "info object" that holds data used by the container to create the containee object.
Object
that is the actual containee object created by the container from the info object.
UnsupportedContainerCapabilityException
- if the container does not support this capability.public void removeContainee(java.lang.String containeeID, int objectType) throws java.lang.Exception
containeeID
- The id of the containee object that will be removed and deleted from the container.
objectType
- The object type of the containee object.
UnsupportedContainerCapabilityException
- if the container does not support this capability.public java.util.Iterator getContainees() throws java.lang.Exception
Iterator
object that provides access to all containee objects within the container.public java.lang.String getContaineesXML(java.lang.String[] propertyNames, OrderBy[] sortOrder) throws java.lang.Exception
propertyNames
- A String
array containing the property
names to include in the XML, may be null.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.
public java.lang.Object findContaineeByID(java.lang.String id, int objectType) throws java.lang.Exception
id
parameter.
id
- An id string value used to retrieve a containee object.
objectType
- The object type of the containee object.
Object
that is the containee object, if any.
UnsupportedContainerCapabilityException
- if the container does not support this capability.public java.lang.Object findContaineeByName(java.lang.String name) throws java.lang.Exception
name
parameter.
name
- A name string value used to retrieve a containee object.
Object
that is the containee object, if any.
UnsupportedContainerCapabilityException
- if the container does not support this capability.public java.lang.String getName()
public java.lang.String getDefinitionID()
public boolean supports(int containerCapability)
containerCapability
containerCapability
- An int value that defines a specific container capability.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |