|
Oracle Collaboration Suite Discussions Java API Reference 10g (10.1.1) Part No. B16232-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.mail.Folder
oracle.mail.sdk.esmail.OracleFolder
oracle.mail.sdk.esmail.OracleSharedFolder
oracle.discussions.sdk.TdContainer
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.
Nested Class Summary |
Nested classes inherited from class oracle.mail.sdk.esmail.OracleFolder |
oracle.mail.sdk.esmail.OracleFolder.OracleFlag |
Nested classes inherited from class javax.mail.UIDFolder |
javax.mail.UIDFolder.FetchProfileItem |
Field Summary | |
static int |
TD_BOARD |
static int |
TD_FACILITY |
Fields inherited from class javax.mail.Folder |
HOLDS_FOLDERS, HOLDS_MESSAGES, READ_ONLY, READ_WRITE |
Fields inherited from interface javax.mail.UIDFolder |
LASTUID |
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. |
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 |
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. |
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. |
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. |
Methods inherited from class oracle.mail.sdk.esmail.OracleSharedFolder |
_setFlags, getNamespace, hasDigitPermission |
Methods inherited from class oracle.mail.sdk.esmail.OracleFolder |
_doSearch, addACI, addACI, appendMessages, convertFlag, convertFlag, convertUsrFlag, getCounts, getFolderExpiry, getFolderId, getFolderSize, getFolderSize, getFullName, getFullPath, getMessageCount, getName, getNewMessageCount, getSeparator, getType, getUnreadMessageCount, getURLName, hasNewMessages, isInheritedACI, removeACI, removeACI, setFolderExpiry |
Methods inherited from class javax.mail.Folder |
addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, getDeletedMessageCount, getMode, getStore, listSubscribed, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, toString |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static int TD_FACILITY
public static int TD_BOARD
Method Detail |
public abstract int getContainerType()
public TdUser getTdUser()
public TdLastPost getLastPost() throws TdException
TdException
public TdContainerSettings getContainerSettings() throws TdException
TdException
public void updateContainerSettings(TdContainerSettings tdCntSettings) throws TdException
tdCntSettings
- container settings to be appliedTdException
public java.lang.String getDescription() throws TdException
TdException
public TdFacility getParentFacility() throws TdException
TdException
- if the parent container is not a facilitypublic TdIterator search(TdSearchTerm tdst) throws TdException, javax.mail.MessagingException
tdst
- the search termTdException
javax.mail.MessagingException
public TdIterator search(TdSearchTerm tdst, boolean searchAnnouncements) throws TdException, javax.mail.MessagingException
tdst
- the search termTdException
javax.mail.MessagingException
public TdIterator getFavoriteThreads() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public TdIterator getPopularThreads() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public TdIterator getLastMessagePosts() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public java.lang.String getDisplayFullPathUsingDisplayName()
public javax.mail.Flags getPermanentFlags()
public javax.mail.Flags getFlags() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public boolean isNewSinceSession() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public boolean isNewSinceLastVisit() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public boolean isGuest()
public boolean isNew() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public java.lang.String getDisplayName()
public java.util.Date getCreationDate() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public TdUser getCreator() throws TdException, javax.mail.MessagingException
TdException
javax.mail.MessagingException
public boolean hasAnnouncementsBoard() throws TdException
TdException
public TdBoard getAnnouncementsBoard() throws TdException
TdException
public boolean equals(java.lang.Object obj)
obj
- container which is being compaerd for equalitypublic boolean exists() throws javax.mail.MessagingException
javax.mail.MessagingException
public boolean isOpen()
public TdContainer getContainer(long lCntId) throws TdException
lCntId
- the container id of the container to be fetchedTdException
public javax.mail.Folder getFolder(java.lang.String folderPath) throws javax.mail.MessagingException
folderPath
- path of the folder to be retrievedjavax.mail.MessagingException
public javax.mail.Folder getParent() throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Folder[] list() throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Folder[] list(boolean bRefresh) throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Folder[] list(java.lang.String path) throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Folder[] list(java.lang.String path, boolean bRefresh) throws javax.mail.MessagingException
javax.mail.MessagingException
public java.util.List listGranteeRoles() throws TdException
TdException
- if the priviledge of the container could not be retrievedpublic boolean isFavorite() throws TdException, javax.mail.MessagingException
isFavorite
in interface TdFavorite
TdException
javax.mail.MessagingException
public void addToFavorites() throws TdException, javax.mail.MessagingException
addToFavorites
in interface TdFavorite
TdException
javax.mail.MessagingException
public void removeFromFavorites() throws TdException, javax.mail.MessagingException
removeFromFavorites
in interface TdFavorite
TdException
javax.mail.MessagingException
public abstract void delete() throws TdException
TdException
public TdContainerPermissions getPermissions() throws TdException
TdException
public void updateGranteeRoles(java.util.List lstOfRoles) throws TdException
lstOfRoles
- list of new TdGranteeRoles to be updatedTdException
- if the priviledge of the container could not be retrieved and updatedpublic boolean isShared() throws javax.mail.MessagingException
javax.mail.MessagingException
public void close(boolean expunge) throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Message[] expunge() throws javax.mail.MessagingException
javax.mail.MessagingException
public void copyMessages(javax.mail.Message[] mm, javax.mail.Folder f) throws javax.mail.MessagingException
mm
- message list to be copiedf
- the folder into which the messages are to be copiedjavax.mail.MessagingException
public boolean create(int i) throws javax.mail.MessagingException
i
- integerjavax.mail.MessagingException
public boolean delete(boolean b) throws javax.mail.MessagingException
b
- booleanjavax.mail.MessagingException
public void fetch(javax.mail.Message[] mm, javax.mail.FetchProfile fp) throws javax.mail.MessagingException
fp
- fetch profilejavax.mail.MessagingException
public javax.mail.Message getMessage(int msgnum) throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Message[] getMessages() throws javax.mail.MessagingException
javax.mail.MessagingException
public javax.mail.Message[] getMessages(int start, int end) throws javax.mail.MessagingException
start
-end
-javax.mail.MessagingException
public javax.mail.Message[] getMessages(int[] msgnums) throws javax.mail.MessagingException
javax.mail.MessagingException
public boolean isSubscribed()
TdUnsupportedOperationException
public javax.mail.Folder[] listSubscribed(java.lang.String s) throws javax.mail.MessagingException
s
-javax.mail.MessagingException
public void open(int i) throws javax.mail.MessagingException
i
-javax.mail.MessagingException
public boolean renameTo(javax.mail.Folder f) throws javax.mail.MessagingException
f
- the folder givenjavax.mail.MessagingException
public void setSubscribed(boolean b) throws javax.mail.MessagingException
javax.mail.MessagingException
public void setFlags(int[] ii, javax.mail.Flags f, boolean b) throws javax.mail.MessagingException
f
- flagsb
- booleanjavax.mail.MessagingException
public void setFlags(int i, int i1, javax.mail.Flags f, boolean b) throws javax.mail.MessagingException
i
- integeri1
- integerf
- flagsb
- booleanjavax.mail.MessagingException
public void setFlags(javax.mail.Message[] mm, javax.mail.Flags f, boolean b) throws javax.mail.MessagingException
f
- flagsb
- booleanjavax.mail.MessagingException
public javax.mail.Message[] search(javax.mail.search.SearchTerm st) throws javax.mail.MessagingException
javax.mail.MessagingException
search(TdSerachTerm tdst)
public javax.mail.Message[] search(javax.mail.search.SearchTerm st, javax.mail.Message[] mm) throws javax.mail.MessagingException
st
- search termmm
- messages listjavax.mail.MessagingException
search(TdSerachTerm tdst)
public javax.mail.Message getMessageByUID(long l) throws javax.mail.MessagingException
getMessageByUID
in interface javax.mail.UIDFolder
l
-javax.mail.MessagingException
public javax.mail.Message[] getMessagesByUID(long[] ll) throws javax.mail.MessagingException
getMessagesByUID
in interface javax.mail.UIDFolder
javax.mail.MessagingException
public javax.mail.Message[] getMessagesByUID(long l, long l1) throws javax.mail.MessagingException
getMessagesByUID
in interface javax.mail.UIDFolder
l
-l1
-javax.mail.MessagingException
public long getUID(javax.mail.Message m) throws javax.mail.MessagingException
getUID
in interface javax.mail.UIDFolder
m
- messagejavax.mail.MessagingException
public long getUIDValidity() throws javax.mail.MessagingException
getUIDValidity
in interface javax.mail.UIDFolder
javax.mail.MessagingException
public void appendMessages(javax.mail.Message[] mm) throws javax.mail.MessagingException
mm
- list of messagesjavax.mail.MessagingException
public void appendMessages(javax.mail.Message[] mm, java.lang.String s) throws javax.mail.MessagingException
mm
- list of messagess
- destination stringjavax.mail.MessagingException
public void moveMessages(javax.mail.Message[] mm, javax.mail.Folder f) throws javax.mail.MessagingException
mm
- list of messagesf
- destination folderjavax.mail.MessagingException
public void openInternal(int mode) throws javax.mail.MessagingException
mode
-javax.mail.MessagingException
public void addACI(java.lang.String s, java.lang.String s1) throws javax.mail.MessagingException
s
-s1
-javax.mail.MessagingException
public void addACI(java.lang.String s, java.lang.String s1, boolean b) throws javax.mail.MessagingException
s
-s1
-javax.mail.MessagingException
public void addACI(java.lang.String s, java.lang.String s1, java.lang.String s2, boolean b) throws javax.mail.MessagingException
s
-s1
-s2
-javax.mail.MessagingException
public void addACI(java.lang.String s, java.lang.String s1, java.lang.String s2) throws javax.mail.MessagingException
s
-s1
-s2
-javax.mail.MessagingException
public void removeACI(java.lang.String s) throws javax.mail.MessagingException
s
-javax.mail.MessagingException
public void removeACI(java.lang.String s, java.lang.String s1) throws javax.mail.MessagingException
s
-s1
-javax.mail.MessagingException
public void modifyACI(java.lang.String s, java.lang.String s1) throws javax.mail.MessagingException
s
-s1
-javax.mail.MessagingException
public void modifyACI(java.lang.String s, java.lang.String s1, java.lang.String s2) throws javax.mail.MessagingException
s
-s1
-s2
-javax.mail.MessagingException
public java.util.Vector getGranteeACI() throws javax.mail.MessagingException
javax.mail.MessagingException
public oracle.mail.sdk.esmail.OracleFilteredMsgHdrs[] getFilteredHeaders(long[] ll) throws javax.mail.MessagingException
ll
-javax.mail.MessagingException
public long[] sortMessages(java.util.Vector vct) throws javax.mail.MessagingException
vct
-javax.mail.MessagingException
public javax.mail.Message[] getMessageByType(int i) throws javax.mail.MessagingException
i
-javax.mail.MessagingException
public boolean hasRead()
public boolean hasWrite()
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |