Oracle Discussions Java API Reference
10g Release 1 (10.1.2)

B25496-01

oracle.discussions.sdk
Class TdContainer

oracle.discussions.sdk.TdContainer
Direct Known Subclasses:
TdBoard, TdFacility

public abstract class TdContainer
implements TdFavorite

Super class for TdFacility and TdBoard as both act as container and share some common properties.

Oracle discussions elements names have been changed in the webui compared to that of sdk portion. The existing names to the new names mapping is as shown.

Since:
OCS 10.1.1

Field Summary
protected  oracle.mail.sdk.esmail.OracleStore _admstore
           
protected  TdUser _creator
           
protected  oracle.discussions.sdk.impl.data.event.TdEventFactory _evtfac
           
protected  oracle.discussions.sdk.impl.event.publisher.EventPublisher _evtpub
           
protected  java.util.Date _lastModDate
           
protected  javax.mail.Address _lastModifier
           
protected  oracle.discussions.util.log.LoggerIf _logger
           
protected  TdContainerSettings _tdCntSettings
           
protected  TdContainerPermissions _tdPerms
           
protected  oracle.discussions.sdk.impl.TdSession _tdsession
           
protected  oracle.mail.sdk.esmail.OracleStore _usrstore
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsAddToFavorites
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetAnnouncementsBoard
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetContainer
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetContainerSettings
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetCreationDate
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetCreator
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetDescription
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetDisplayName
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetFavoriteThreads
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetFolder
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetLastMessagePosts
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetLastPost
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetParent
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetPopularThreads
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsHasAnnouncementsBoard
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListGranteeRoles
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListWOPath
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListWPath
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRefreshPermissions
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRemoveFromFavorites
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsSearch
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsSetDescription
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsUpdateContainerSettings
           
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsUpdateGranteeRoles
           
protected static oracle.dms.instrument.Noun s_nContainer
           
static int TD_BOARD
           
static int TD_FACILITY
           

 

Constructor Summary
protected TdContainer(oracle.mail.sdk.esmail.OracleStore admstore, oracle.mail.sdk.esmail.OracleStore usrstore, oracle.discussions.sdk.impl.TdSession tdsession, java.lang.String folderName, long lFolderId, int iType, java.lang.String nameSpace)
          Constructor to create an instance of the TdContainer.

 

Method Summary
 void addACI(java.lang.String s, java.lang.String s1)
          Adds ACI information of this container.
 void addACI(java.lang.String s, java.lang.String s1, boolean b)
          Adds ACI information of this container.
 void addACI(java.lang.String s, java.lang.String s1, java.lang.String s2)
          Adds ACI information of this container.
 void addACI(java.lang.String s, java.lang.String s1, java.lang.String s2, boolean b)
          Adds ACI information of this container.
 void addToFavorites()
          Add this thread to the list of favorite threads for this user.
 void appendMessages(javax.mail.Message[] mm)
          Appends specified messages
 void appendMessages(javax.mail.Message[] mm, java.lang.String s)
          Appends specified messages to a specified string.
 void close(boolean expunge)
          Closes the container.
 void copyMessages(javax.mail.Message[] mm, javax.mail.Folder f)
          Copies the messages to the specified container.
 boolean create(int i)
          Creates the container
abstract  void delete()
          delete the current container
 boolean delete(boolean b)
          Deletes the container
 boolean equals(java.lang.Object obj)
          Returns true if the Id of the supplied folder match.
 boolean exists()
          Returns always true as Facility/Boards always exists if a TdFacility/TdBoard instance is aquired.
 javax.mail.Message[] expunge()
          Closes the container.
 void fetch(javax.mail.Message[] mm, javax.mail.FetchProfile fp)
          Fetches the messages into the profile
 TdBoard getAnnouncementsBoard()
          Returns the Announcements Board for this store
 TdContainer getContainer(long lCntId)
          Returns the tdConatiner instace for child of this folder given its FolderId.
 TdContainerSettings getContainerSettings()
          Returns the current container settings.
 TdContainerSettings getContainerSettings(boolean bRefresh)
          Returns the current container settings.
abstract  int getContainerType()
          Returns the type (TdFacility or TdBoard) of this container
 java.util.Date getCreationDate()
          Returns the display name for this container
 TdUser getCreator()
          Returns the display name for this container
 java.lang.String getDescription()
          Returns the description field for this container
 java.lang.String getDisplayFullPathUsingDisplayName()
          Returns the full path for this container not including the Oracle Mail shared namespace prefix.
 java.lang.String getDisplayName()
          Returns the display name for this container
 TdIterator getFavoriteThreads()
          Returns the list of favorite threads under this container.
 oracle.mail.sdk.esmail.OracleFilteredMsgHdrs[] getFilteredHeaders(long[] ll)
          Returns an array filtered message headers, given an array of headers.
 javax.mail.Flags getFlags()
          Tries to fetch flags of this container.
 javax.mail.Folder getFolder(java.lang.String folderPath)
          Returns the TdContainer (Tdfacility or TdBoard) associated with this path.
 java.util.Vector getGranteeACI()
          Returns grantee ACI inforamtion of this container.
 TdIterator getLastMessagePosts()
          Returns the list of most recent posts under this container.
 TdLastPost getLastPost()
          Returns information on the last post for this container.
 javax.mail.Message getMessage(int msgnum)
          Returns the message given number
 javax.mail.Message[] getMessageByType(int i)
          Returns an array of messages given the type of messages.
 javax.mail.Message getMessageByUID(long l)
          Fetches messages , given the UID
 javax.mail.Message[] getMessages()
          Fetches messages given the numbers
 javax.mail.Message[] getMessages(int[] msgnums)
          Fetches messages given the numbers
 javax.mail.Message[] getMessages(int start, int end)
          Fetches messages given the numbers
 javax.mail.Message[] getMessagesByUID(long[] ll)
          Fetches messages , given the UID
 javax.mail.Message[] getMessagesByUID(long l, long l1)
          Fetches messages , given the UID
 javax.mail.Folder getParent()
          Returns the TdContainer (Tdfacility or TdBoard) associated with this path.
 TdFacility getParentFacility()
          Return sthe parent TdFacility for this container.
 javax.mail.Flags getPermanentFlags()
          Tries to fetch permanent flags of this container.
 TdContainerPermissions getPermissions()
          Returns the permissions for the current user on this container.
 TdIterator getPopularThreads()
          Returns the list of most popular threads under this container.
 TdUser getTdUser()
          Returns tduser associated with the container.
 long getUID(javax.mail.Message m)
          Fetches the UID , given the message
 long getUIDValidity()
          Fetches the validity of the given UID
protected static java.lang.String groupACI(java.lang.String aStr)
          Returns a group ACI on the container.
protected static java.lang.String groupACIWithList(java.lang.String aStr)
          Returns a group ACI information
 boolean hasAnnouncementsBoard()
          Returns true if the announcements board has been created
 boolean hasRead()
          Returns if the user has a write permission on the container.
 boolean hasWrite()
          Returns if the user has a write permission on the container.
protected  boolean have_permission(int perm)
          Returns if the user has a write permission on the container.
 boolean isFavorite()
          Returns true if this container is currently marked as a favorite container for this user.
 boolean isGuest()
          Returns true if the current user is a guest for the domain
 boolean isNew()
          This is the result of "OR" on isNewSinceSessions and isNewSinceLastVisit The guest user will always get back 'false' from this function.
 boolean isNewSinceLastVisit()
          Indicates if teh container is new since the user's last logout
 boolean isNewSinceSession()
          Indicates if teh container is new since the user's session start
 boolean isOpen()
          Returns always true as Threaded Discussions folder do not require to be opened.
 boolean isShared()
          Returnes always true.
 boolean isSubscribed()
          Specifies if a container is subscribed
 javax.mail.Folder[] list()
          Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility.
 javax.mail.Folder[] list(boolean bRefresh)
          Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility.
 javax.mail.Folder[] list(java.lang.String path)
          Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility.
 javax.mail.Folder[] list(java.lang.String path, boolean bRefresh)
          Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility.
 java.util.List listGranteeRoles()
          Returns a list of TdGranteeRoles summarizing the current access control stettings for this Facility.
 javax.mail.Folder[] listSubscribed(java.lang.String s)
          Lists the folders for which subscriptions are made.
 void modifyACI(java.lang.String s, java.lang.String s1)
          Modifies ACI information of this container.
 void modifyACI(java.lang.String s, java.lang.String s1, java.lang.String s2)
          Modifies ACI information of this container.
 void moveMessages(javax.mail.Message[] mm, javax.mail.Folder f)
          Moves specified messages into specified forum
 void open(int i)
          Opens the container
 void openInternal(int mode)
          Opens a container in the specified mode.
protected static java.lang.String refineACI(java.lang.String aStr)
          Refines the ACI information of the container.
protected  void refreshContainerSettings()
           
 void removeACI(java.lang.String s)
          Removes ACI information of this container.
 void removeACI(java.lang.String s, java.lang.String s1)
          Removes ACI information of this container.
 void removeFromFavorites()
          Remove this thread from the list of favorite threads for this user.
 boolean renameTo(javax.mail.Folder f)
          Renames the folder to the given name
 javax.mail.Message[] search(javax.mail.search.SearchTerm st)
          Performs search on a container.
 javax.mail.Message[] search(javax.mail.search.SearchTerm st, javax.mail.Message[] mm)
          Performs search on a container.
 TdIterator search(TdSearchTerm tdst)
          Searches the message in this container recursively according to the supplied search term.
 TdIterator search(TdSearchTerm tdst, boolean searchAnnouncements)
          Searches the message in this container recursively according to the supplied search term.
 void setFlags(int[] ii, javax.mail.Flags f, boolean b)
          Sets the flags for the given messages
 void setFlags(int i, int i1, javax.mail.Flags f, boolean b)
          Sets the flags for the given messages
 void setFlags(javax.mail.Message[] mm, javax.mail.Flags f, boolean b)
          Sets the flags for the given messages
 void setSubscribed(boolean b)
          Sets the subscription status on the container
 long[] sortMessages(java.util.Vector vct)
          Returns an array of sorted message IDs, given a vector of message ids.
 void updateContainerSettings(TdContainerSettings tdCntSettings)
          Updates the current container settings.
 void updateGranteeRoles(java.util.List lstOfRoles)
          Updates the current settings for this container with the supplied list of TdGranteeRoles.

 

Field Detail

TD_FACILITY

public static int TD_FACILITY

TD_BOARD

public static int TD_BOARD

_admstore

protected oracle.mail.sdk.esmail.OracleStore _admstore

_usrstore

protected oracle.mail.sdk.esmail.OracleStore _usrstore

_tdsession

protected oracle.discussions.sdk.impl.TdSession _tdsession

_evtpub

protected oracle.discussions.sdk.impl.event.publisher.EventPublisher _evtpub

_evtfac

protected oracle.discussions.sdk.impl.data.event.TdEventFactory _evtfac

_logger

protected oracle.discussions.util.log.LoggerIf _logger

_lastModDate

protected java.util.Date _lastModDate

_lastModifier

protected javax.mail.Address _lastModifier

_tdPerms

protected TdContainerPermissions _tdPerms

_tdCntSettings

protected TdContainerSettings _tdCntSettings

_creator

protected TdUser _creator

s_nContainer

protected static oracle.dms.instrument.Noun s_nContainer

s_dmsAddToFavorites

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsAddToFavorites

s_dmsGetContainer

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetContainer

s_dmsGetContainerSettings

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetContainerSettings

s_dmsGetDescription

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetDescription

s_dmsGetFavoriteThreads

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetFavoriteThreads

s_dmsGetFolder

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetFolder

s_dmsGetAnnouncementsBoard

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetAnnouncementsBoard

s_dmsHasAnnouncementsBoard

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsHasAnnouncementsBoard

s_dmsGetLastMessagePosts

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetLastMessagePosts

s_dmsGetLastPost

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetLastPost

s_dmsGetParent

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetParent

s_dmsGetPopularThreads

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetPopularThreads

s_dmsListWOPath

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListWOPath

s_dmsListWPath

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListWPath

s_dmsListGranteeRoles

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsListGranteeRoles

s_dmsRefreshPermissions

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRefreshPermissions

s_dmsRemoveFromFavorites

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRemoveFromFavorites

s_dmsSearch

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsSearch

s_dmsSetDescription

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsSetDescription

s_dmsUpdateContainerSettings

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsUpdateContainerSettings

s_dmsUpdateGranteeRoles

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsUpdateGranteeRoles

s_dmsGetDisplayName

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetDisplayName

s_dmsGetCreationDate

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetCreationDate

s_dmsGetCreator

protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGetCreator

Constructor Detail

TdContainer

protected TdContainer(oracle.mail.sdk.esmail.OracleStore admstore,
                      oracle.mail.sdk.esmail.OracleStore usrstore,
                      oracle.discussions.sdk.impl.TdSession tdsession,
                      java.lang.String folderName,
                      long lFolderId,
                      int iType,
                      java.lang.String nameSpace)
Constructor to create an instance of the TdContainer.
Parameters:
admstore - Oracle email administrator store
usrstore - Oracle email user store
folderName - Contianer name
lFolderId - container id
iType - type of the container being created
nameSpace - email namespace in which the container is created.

Method Detail

getContainerType

public abstract int getContainerType()
Returns the type (TdFacility or TdBoard) of this container
Returns:
int

getTdUser

public TdUser getTdUser()
Returns tduser associated with the container.
Returns:
TdUser

getLastPost

public TdLastPost getLastPost()
                       throws TdException
Returns information on the last post for this container. For a facility the last post is last post among all the boards under this facility.
Returns:
TdLastPost
Throws:
TdException -  

getContainerSettings

public TdContainerSettings getContainerSettings()
                                         throws TdException
Returns the current container settings.
Returns:
TdContainerSettings
Throws:
TdException -  

getContainerSettings

public TdContainerSettings getContainerSettings(boolean bRefresh)
                                         throws TdException
Returns the current container settings.
Parameters:
bRefresh, - refresh the settings if set to true
Returns:
TdContainerSettings
Throws:
TdException -  

refreshContainerSettings

protected void refreshContainerSettings()
                                 throws TdException

updateContainerSettings

public void updateContainerSettings(TdContainerSettings tdCntSettings)
                             throws TdException
Updates the current container settings.
Parameters:
tdCntSettings - container settings to be applied
Throws:
TdException -  

getDescription

public java.lang.String getDescription()
                                throws TdException
Returns the description field for this container
Returns:
String
Throws:
TdException -  

getParentFacility

public TdFacility getParentFacility()
                             throws TdException
Return sthe parent TdFacility for this container.
Returns:
null if not parent is found
Throws:
TdException - if the parent container is not a facility

search

public TdIterator search(TdSearchTerm tdst)
                  throws TdException,
                         javax.mail.MessagingException
Searches the message in this container recursively according to the supplied search term.
Parameters:
tdst - the search term
Throws:
TdException -  
MessagingException -  

search

public TdIterator search(TdSearchTerm tdst,
                         boolean searchAnnouncements)
                  throws TdException,
                         javax.mail.MessagingException
Searches the message in this container recursively according to the supplied search term.
Parameters:
tdst - the search term
searchAnnouncements - whether search should include the announcements
Throws:
TdException -  
MessagingException -  

getFavoriteThreads

public TdIterator getFavoriteThreads()
                              throws TdException,
                                     javax.mail.MessagingException
Returns the list of favorite threads under this container. TdThread objects are light-weight references to the actual message that started the thread. In addition to the message id of the thread in this call thread information such # of messages in the Thread and last post information (date, author) will be retrieved too. To fill up additional thread details call fetch.
Returns:
TdIterator
Throws:
TdException -  
MessagingException -  

getPopularThreads

public TdIterator getPopularThreads()
                             throws TdException,
                                    javax.mail.MessagingException
Returns the list of most popular threads under this container. TdThread objects are light-weight references to the actual message that started the thread. In addition to the message id of the thread in this call thread information such # of messages in the Thread and last post information (date, author) will be retrieved too. To fill up additional thread details call fetch.
Returns:
TdIterator
Throws:
TdException -  
MessagingException -  

getLastMessagePosts

public TdIterator getLastMessagePosts()
                               throws TdException,
                                      javax.mail.MessagingException
Returns the list of most recent posts under this container.
Returns:
TdIterator
Throws:
TdException -  
MessagingException -  

getDisplayFullPathUsingDisplayName

public java.lang.String getDisplayFullPathUsingDisplayName()
Returns the full path for this container not including the Oracle Mail shared namespace prefix. The full path will use the display names of each container in the path.
Returns:
String

getPermanentFlags

public javax.mail.Flags getPermanentFlags()
Tries to fetch permanent flags of this container.
Returns:
Flags

getFlags

public javax.mail.Flags getFlags()
                          throws TdException,
                                 javax.mail.MessagingException
Tries to fetch flags of this container.
Returns:
Flags
Throws:
TdException -  
MessagingException -  

isNewSinceSession

public boolean isNewSinceSession()
                          throws TdException,
                                 javax.mail.MessagingException
Indicates if teh container is new since the user's session start
Returns:
boolean
Throws:
TdException -  
MessagingException -  

isNewSinceLastVisit

public boolean isNewSinceLastVisit()
                            throws TdException,
                                   javax.mail.MessagingException
Indicates if teh container is new since the user's last logout
Returns:
boolean
Throws:
TdException -  
MessagingException -  

isGuest

public boolean isGuest()
Returns true if the current user is a guest for the domain

isNew

public boolean isNew()
              throws TdException,
                     javax.mail.MessagingException
This is the result of "OR" on isNewSinceSessions and isNewSinceLastVisit The guest user will always get back 'false' from this function.
Returns:
boolean
Throws:
TdException -  
MessagingException -  

getDisplayName

public java.lang.String getDisplayName()
Returns the display name for this container
Returns:
String

getCreationDate

public java.util.Date getCreationDate()
                               throws TdException,
                                      javax.mail.MessagingException
Returns the display name for this container
Returns:
Date
Throws:
TdException -  
MessagingException -  

getCreator

public TdUser getCreator()
                  throws TdException,
                         javax.mail.MessagingException
Returns the display name for this container
Returns:
TdUser
Throws:
TdException -  
MessagingException -  

hasAnnouncementsBoard

public boolean hasAnnouncementsBoard()
                              throws TdException
Returns true if the announcements board has been created
Returns:
boolean
Throws:
TdException -  

getAnnouncementsBoard

public TdBoard getAnnouncementsBoard()
                              throws TdException
Returns the Announcements Board for this store
Returns:
TdBoard
Throws:
TdException -  

equals

public boolean equals(java.lang.Object obj)
Returns true if the Id of the supplied folder match.
Parameters:
obj - container which is being compaerd for equality
Returns:
boolean

exists

public boolean exists()
               throws javax.mail.MessagingException
Returns always true as Facility/Boards always exists if a TdFacility/TdBoard instance is aquired.
Returns:
boolean

isOpen

public boolean isOpen()
Returns always true as Threaded Discussions folder do not require to be opened.
Returns:
boolean

getContainer

public TdContainer getContainer(long lCntId)
                         throws TdException
Returns the tdConatiner instace for child of this folder given its FolderId.
Parameters:
lCntId - the container id of the container to be fetched
Returns:
TdContainer
Throws:
TdException -  

getFolder

public javax.mail.Folder getFolder(java.lang.String folderPath)
                            throws javax.mail.MessagingException
Returns the TdContainer (Tdfacility or TdBoard) associated with this path. If supplied path starts with "/" then it is considered absolute otherwise relative this container.
Parameters:
folderPath - path of the folder to be retrieved
Returns:
null is nothing is found
Throws:
MessagingException -  

getParent

public javax.mail.Folder getParent()
                            throws javax.mail.MessagingException
Returns the TdContainer (Tdfacility or TdBoard) associated with this path.
Returns:
null is nothing is found
Throws:
MessagingException -  

list

public javax.mail.Folder[] list()
                         throws javax.mail.MessagingException
Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility. The results will be sorted by container display names This function will not refresh the cache
Returns:
null is nothing is found
Throws:
MessagingException -  

list

public javax.mail.Folder[] list(boolean bRefresh)
                         throws javax.mail.MessagingException
Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility. The results will be sorted by container display names If bRefresh is true, this function will refresh the cache
Returns:
null is nothing is found
Throws:
MessagingException -  

list

public javax.mail.Folder[] list(java.lang.String path)
                         throws javax.mail.MessagingException
Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility. The results will be sorted by container display names only when path is % This function will not refresh the cache
Returns:
null is nothing is found
Throws:
MessagingException -  

list

public javax.mail.Folder[] list(java.lang.String path,
                                boolean bRefresh)
                         throws javax.mail.MessagingException
Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility. The results will be sorted by container display names only when path is % if bRefresh is true, this function will refresh the cache
Returns:
null is nothing is found
Throws:
MessagingException -  

listGranteeRoles

public java.util.List listGranteeRoles()
                                throws TdException
Returns a list of TdGranteeRoles summarizing the current access control stettings for this Facility.
Returns:
a list of TdGranteeRoles associated with the container
Throws:
TdException - if the priviledge of the container could not be retrieved

isFavorite

public boolean isFavorite()
                   throws TdException,
                          javax.mail.MessagingException
Returns true if this container is currently marked as a favorite container for this user.
Specified by:
isFavorite in interface TdFavorite
Returns:
boolean
Throws:
TdException -  
MessagingException -  

addToFavorites

public void addToFavorites()
                    throws TdException,
                           javax.mail.MessagingException
Add this thread to the list of favorite threads for this user.
Specified by:
addToFavorites in interface TdFavorite
Throws:
TdException -  
MessagingException -  

removeFromFavorites

public void removeFromFavorites()
                         throws TdException,
                                javax.mail.MessagingException
Remove this thread from the list of favorite threads for this user.
Specified by:
removeFromFavorites in interface TdFavorite
Throws:
TdException -  
MessagingException -  

delete

public abstract void delete()
                     throws TdException
delete the current container
Throws:
TdException -  

getPermissions

public TdContainerPermissions getPermissions()
                                      throws TdException
Returns the permissions for the current user on this container. Subclasses will return the corresponding TdPermissoin sub-class.
Returns:
the role of the current user
Throws:
TdException -  

updateGranteeRoles

public void updateGranteeRoles(java.util.List lstOfRoles)
                        throws TdException
Updates the current settings for this container with the supplied list of TdGranteeRoles.
Parameters:
lstOfRoles - list of new TdGranteeRoles to be updated
Throws:
TdException - if the priviledge of the container could not be retrieved and updated

isShared

public boolean isShared()
                 throws javax.mail.MessagingException
Returnes always true. All Threaded Discussions container are relying on Oracle Email Shared Folders.
Returns:
boolean
Throws:
MessagingException -  

close

public void close(boolean expunge)
           throws javax.mail.MessagingException
Closes the container.
Parameters:
expunge -  
Throws:
MessagingException -  

expunge

public javax.mail.Message[] expunge()
                             throws javax.mail.MessagingException
Closes the container.
Returns:
Message[]
Throws:
MessagingException -  

copyMessages

public void copyMessages(javax.mail.Message[] mm,
                         javax.mail.Folder f)
                  throws javax.mail.MessagingException
Copies the messages to the specified container.
Parameters:
mm - message list to be copied
f - the folder into which the messages are to be copied
Throws:
MessagingException -  

create

public boolean create(int i)
               throws javax.mail.MessagingException
Creates the container
Parameters:
i - integer
Returns:
boolean
Throws:
MessagingException -  

delete

public boolean delete(boolean b)
               throws javax.mail.MessagingException
Deletes the container
Parameters:
b - boolean
Returns:
boolean
Throws:
MessagingException -  

fetch

public void fetch(javax.mail.Message[] mm,
                  javax.mail.FetchProfile fp)
           throws javax.mail.MessagingException
Fetches the messages into the profile
Parameters:
mm - the messages to be fetched
fp - fetch profile
Throws:
MessagingException -  

getMessage

public javax.mail.Message getMessage(int msgnum)
                              throws javax.mail.MessagingException
Returns the message given number
Parameters:
msgnum -  
Returns:
Message
Throws:
MessagingException -  

getMessages

public javax.mail.Message[] getMessages()
                                 throws javax.mail.MessagingException
Fetches messages given the numbers
Returns:
Message[]
Throws:
MessagingException -  

getMessages

public javax.mail.Message[] getMessages(int start,
                                        int end)
                                 throws javax.mail.MessagingException
Fetches messages given the numbers
Parameters:
start -  
end -  
Returns:
Message[]
Throws:
MessagingException -  

getMessages

public javax.mail.Message[] getMessages(int[] msgnums)
                                 throws javax.mail.MessagingException
Fetches messages given the numbers
Parameters:
msgnums - array of message numbers
Returns:
Message[]
Throws:
MessagingException -  

isSubscribed

public boolean isSubscribed()
Specifies if a container is subscribed
Returns:
boolean
Throws:
TdUnsupportedOperationException -  

listSubscribed

public javax.mail.Folder[] listSubscribed(java.lang.String s)
                                   throws javax.mail.MessagingException
Lists the folders for which subscriptions are made.
Parameters:
s -  
Returns:
Folder[]
Throws:
MessagingException -  

open

public void open(int i)
          throws javax.mail.MessagingException
Opens the container
Parameters:
i -  
Throws:
MessagingException -  

renameTo

public boolean renameTo(javax.mail.Folder f)
                 throws javax.mail.MessagingException
Renames the folder to the given name
Parameters:
f - the folder given
Throws:
MessagingException -  

setSubscribed

public void setSubscribed(boolean b)
                   throws javax.mail.MessagingException
Sets the subscription status on the container
Parameters:
b - boolean
Throws:
MessagingException -  

setFlags

public void setFlags(int[] ii,
                     javax.mail.Flags f,
                     boolean b)
              throws javax.mail.MessagingException
Sets the flags for the given messages
Parameters:
ii - array of messages
f - flags
b - boolean
Throws:
MessagingException -  

setFlags

public void setFlags(int i,
                     int i1,
                     javax.mail.Flags f,
                     boolean b)
              throws javax.mail.MessagingException
Sets the flags for the given messages
Parameters:
i - integer
i1 - integer
f - flags
b - boolean
Throws:
MessagingException -  

setFlags

public void setFlags(javax.mail.Message[] mm,
                     javax.mail.Flags f,
                     boolean b)
              throws javax.mail.MessagingException
Sets the flags for the given messages
Parameters:
mm - array of messages
f - flags
b - boolean
Throws:
MessagingException -  

search

public javax.mail.Message[] search(javax.mail.search.SearchTerm st)
                            throws javax.mail.MessagingException
Performs search on a container.
Parameters:
st - search term
Throws:
TdUnsupportedOperationException. -  

search

public javax.mail.Message[] search(javax.mail.search.SearchTerm st,
                                   javax.mail.Message[] mm)
                            throws javax.mail.MessagingException
Performs search on a container.
Parameters:
st - search term
mm - messages list
Throws:
TdUnsupportedOperationException. -  

getMessageByUID

public javax.mail.Message getMessageByUID(long l)
                                   throws javax.mail.MessagingException
Fetches messages , given the UID
Parameters:
l -  
Returns:
Message[]
Throws:
MessagingException -  

getMessagesByUID

public javax.mail.Message[] getMessagesByUID(long[] ll)
                                      throws javax.mail.MessagingException
Fetches messages , given the UID
Parameters:
ll -  
Returns:
Message[]
Throws:
MessagingException -  

getMessagesByUID

public javax.mail.Message[] getMessagesByUID(long l,
                                             long l1)
                                      throws javax.mail.MessagingException
Fetches messages , given the UID
Parameters:
l -  
l1 -  
Returns:
Message[]
Throws:
MessagingException -  

getUID

public long getUID(javax.mail.Message m)
            throws javax.mail.MessagingException
Fetches the UID , given the message
Parameters:
m - message
Returns:
long
Throws:
MessagingException -  

getUIDValidity

public long getUIDValidity()
                    throws javax.mail.MessagingException
Fetches the validity of the given UID
Returns:
long
Throws:
MessagingException -  

appendMessages

public void appendMessages(javax.mail.Message[] mm)
                    throws javax.mail.MessagingException
Appends specified messages
Parameters:
mm - list of messages
Throws:
MessagingException -  

appendMessages

public void appendMessages(javax.mail.Message[] mm,
                           java.lang.String s)
                    throws javax.mail.MessagingException
Appends specified messages to a specified string.
Parameters:
mm - list of messages
s - destination string
Throws:
MessagingException -  

moveMessages

public void moveMessages(javax.mail.Message[] mm,
                         javax.mail.Folder f)
                  throws javax.mail.MessagingException
Moves specified messages into specified forum
Parameters:
mm - list of messages
f - destination folder
Throws:
MessagingException -  

openInternal

public void openInternal(int mode)
                  throws javax.mail.MessagingException
Opens a container in the specified mode.
Parameters:
mode -  
Throws:
MessagingException -  

addACI

public void addACI(java.lang.String s,
                   java.lang.String s1)
            throws javax.mail.MessagingException
Adds ACI information of this container.
Parameters:
s -  
s1 -  
Throws:
MessagingException -  

addACI

public void addACI(java.lang.String s,
                   java.lang.String s1,
                   boolean b)
            throws javax.mail.MessagingException
Adds ACI information of this container.
Parameters:
s -  
s1 -  
Throws:
MessagingException -  

addACI

public void addACI(java.lang.String s,
                   java.lang.String s1,
                   java.lang.String s2,
                   boolean b)
            throws javax.mail.MessagingException
Adds ACI information of this container.
Parameters:
s -  
s1 -  
s2 -  
Throws:
MessagingException -  

addACI

public void addACI(java.lang.String s,
                   java.lang.String s1,
                   java.lang.String s2)
            throws javax.mail.MessagingException
Adds ACI information of this container.
Parameters:
s -  
s1 -  
s2 -  
Throws:
MessagingException -  

removeACI

public void removeACI(java.lang.String s)
               throws javax.mail.MessagingException
Removes ACI information of this container.
Parameters:
s -  
Throws:
MessagingException -  

removeACI

public void removeACI(java.lang.String s,
                      java.lang.String s1)
               throws javax.mail.MessagingException
Removes ACI information of this container.
Parameters:
s -  
s1 -  
Throws:
MessagingException -  

modifyACI

public void modifyACI(java.lang.String s,
                      java.lang.String s1)
               throws javax.mail.MessagingException
Modifies ACI information of this container.
Parameters:
s -  
s1 -  
Throws:
MessagingException -  

modifyACI

public void modifyACI(java.lang.String s,
                      java.lang.String s1,
                      java.lang.String s2)
               throws javax.mail.MessagingException
Modifies ACI information of this container.
Parameters:
s -  
s1 -  
s2 -  
Throws:
MessagingException -  

getGranteeACI

public java.util.Vector getGranteeACI()
                               throws javax.mail.MessagingException
Returns grantee ACI inforamtion of this container.
Returns:
vector
Throws:
MessagingException -  

getFilteredHeaders

public oracle.mail.sdk.esmail.OracleFilteredMsgHdrs[] getFilteredHeaders(long[] ll)
                                                                  throws javax.mail.MessagingException
Returns an array filtered message headers, given an array of headers.
Parameters:
ll -  
Returns:
OracleFilteredMsgHdrs[] exception TdUnsupportedOperationException
Throws:
MessagingException -  

sortMessages

public long[] sortMessages(java.util.Vector vct)
                    throws javax.mail.MessagingException
Returns an array of sorted message IDs, given a vector of message ids.
Parameters:
vct -  
Returns:
Message[] exception TdUnsupportedOperationException
Throws:
MessagingException -  

getMessageByType

public javax.mail.Message[] getMessageByType(int i)
                                      throws javax.mail.MessagingException
Returns an array of messages given the type of messages.
Parameters:
i -  
Returns:
Message[] exception TdUnsupportedOperationException
Throws:
MessagingException -  

groupACI

protected static java.lang.String groupACI(java.lang.String aStr)
Returns a group ACI on the container.
Parameters:
aStr -  
Returns:
String exception TdUnsupportedOperationException

groupACIWithList

protected static java.lang.String groupACIWithList(java.lang.String aStr)
Returns a group ACI information
Parameters:
aStr -  
Returns:
String exception TdUnsupportedOperationException

refineACI

protected static java.lang.String refineACI(java.lang.String aStr)
Refines the ACI information of the container.
Parameters:
aStr -  
Returns:
String exception TdUnsupportedOperationException

have_permission

protected boolean have_permission(int perm)
Returns if the user has a write permission on the container.
Returns:
boolean exception TdUnsupportedOperationException

hasRead

public boolean hasRead()
Returns if the user has a write permission on the container.
Returns:
boolean exception TdUnsupportedOperationException

hasWrite

public boolean hasWrite()
Returns if the user has a write permission on the container.
Returns:
boolean exception TdUnsupportedOperationException

Oracle Discussions Java API Reference
10g Release 1 (10.1.2)

B25496-01

Copyright © 2002, 2005, Oracle. All rights reserved.