Collaboration API Documentation

com.filenet.bso.api.collaboration.data
Class FolderContainerInfo

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.data.FolderContainerInfo
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ForumInfo, MeetingInfo

public abstract class FolderContainerInfo
extends java.lang.Object
implements java.io.Serializable

The FolderContainerInfo class is a collection of data used to create a generic folder subcontainer within an existing teamspace container. A teamspace subcontainer is created by generating a FolderContainerInfo object from the CollaborationFactory and adding it to a teamspace container via its addSubContainer() method.

See Also:
CollaborationFactory, Serialized Form

Field Summary
protected  java.lang.String folderName
           
protected  com.filenet.wcm.api.BaseObject linkObject
           
protected  java.lang.String memberID
           
 
Constructor Summary
protected FolderContainerInfo()
           
  FolderContainerInfo(java.lang.String ownerID, java.lang.String folderName, com.filenet.wcm.api.BaseObject linkObject)
           
 
Method Summary
 java.lang.String getFolderName()
          Returns the name assigned to the folder subcontainer.
 com.filenet.wcm.api.BaseObject getLinkObject()
          Returns the Content Engine object, if any, to which the subcontainer is linked.
 java.lang.String getOwnerID()
          Returns The LDAP SID of the member who created the folder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

memberID

protected java.lang.String memberID

folderName

protected java.lang.String folderName

linkObject

protected com.filenet.wcm.api.BaseObject linkObject
Constructor Detail

FolderContainerInfo

protected FolderContainerInfo()

FolderContainerInfo

public FolderContainerInfo(java.lang.String ownerID,
                           java.lang.String folderName,
                           com.filenet.wcm.api.BaseObject linkObject)
Parameters:
ownerID - The LDAP SID of the user who will be granted creator-owner rights for this object.
Method Detail

getOwnerID

public java.lang.String getOwnerID()
Returns The LDAP SID of the member who created the folder.

Returns:
A String containing the member ID.

getFolderName

public java.lang.String getFolderName()
Returns the name assigned to the folder subcontainer.

Returns:
A String containing the folder subcontainer name.

getLinkObject

public com.filenet.wcm.api.BaseObject getLinkObject()
Returns the Content Engine object, if any, to which the subcontainer is linked.

Returns:
A BaseObject containing the Content Engine link object. May be null.

Collaboration API Documentation

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