|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
TdStore represents an abstraction over a message store for facilities and boards.
Provides methods for
Each user logging into oracle discussions will have a tdstore instance associated with him.
The tdstore object is kept in the tdsession object till the user sessions is active.
Once the user logs out, tdstore object is cleaned up and the session is refreshed.
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.
Sample code for illustrating usage of TdStore
//Create a TdInitialContext Object which represents an extension of a map //holding various key-value pairs. TdInitialContext tdic = new TdInitialContext(mEnv); //Create an instance of TdStoreManager which initialized various sessions like //Oracle java mail session, javax.mail session, initialized logger etc. TdStoreManager s_tdStoreMgr = TdStoreManager.createInstance(tdic); //Create an instance of TdStoreFactory, which is a factory class providing methods to //create a TdStore instance. TdStoreFactory s_tdsf = s_tdStoreMgr.getTdStoreFactory(); //Create an TdUserFactory, which is a factory class providing methods to create TdUser objects. TdUserFactory ouf = TdUserFactory.getInstance(); //Extract a tduser from the userfactory based on the guid. TdUser tduser = null; tduser = ouf.getTdUserByGuid(userGuid); Create a tdstore for this user. tdStore = s_tdsf.getTdStore(tduser,true); //Set the tdStore into session after wrapping it up. HttpSessionTdStore hsts = new HttpSessionTdStore(tdStore); ses.setAttribute(TD_STORE, hsts);//ses is a session HttpSession instance
TdStoreFactory
, TdStoreManager
Method Summary | |
void |
close() Closes this TdStore and releases all the resources associated with it without updating user logout time |
void |
close(boolean bUpdateUserLogout) Closes this TdStore and releases all the resources associated with it. |
TdBoard |
createBoard(TdFacility tdfParent, java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic) Creates a Board under the root facility |
TdBoard |
createBoard(TdFacility tdfParent, java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic, boolean bWithAnnouncementsBoard) Creates a Board under the root facility |
TdFacility |
createFacility(TdFacility tdfParent, java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription) Creates a new TdFacility in this message store. |
TdFacility |
createFacility(TdFacility tdfParent, java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription, boolean bWithAnnouncementsBoard) Creates a new TdFacility in this message store. |
TdBoard |
getAnnouncementsBoard() Returns the Announcements Board for this store. |
TdBoard |
getBoard(long lBrdId) Returns a board under this Store give its id. |
TdBoard |
getBoard(java.lang.String path) Returns a board under this Store give its path. |
TdBoard |
getBoardByEmailAddress(java.lang.String boardEmail) Returns a board given its email address. |
java.util.List |
getBoardsByDistributionListAddress(java.lang.String dlEmail) Returns a list of boards given its outgoing distribution list address. |
TdContainer |
getContainer(long lCntId) Returns a container under this Store give its id. |
TdContainer |
getContainer(java.lang.String path) Returns a container under this Store give its path. |
java.lang.String |
getDomain() Returns the domain for this mail store. |
TdFacility |
getFacility(long lFacId) Returns a facility under this Store give its path. |
TdFacility |
getFacility(java.lang.String path) Returns a facility under this Store give its path. |
TdFavoriteManager |
getFavoriteManager() Returns the TdFavoriteManager for this store. |
TdGlobalAdminManager |
getGlobalAdminManager() Returns the TdGlobalAdminManager for this store. |
TdGlobalSettings |
getGlobalSettings() Returns the global settings of current installation |
TdUser |
getGuestUser() Returns guest user within the domain |
TdIterator |
getLastMessagePosts() Returns the list of most recent posts in the whole message store. |
TdLastPost |
getLastPost() Returns information on the most recently posted message under this tdstore. |
TdMyFollowups |
getMyFollowups() Gets all followups to my posts |
TdMyPosts |
getMyPosts() Gets all my posts |
TdIterator |
getPopularThreads() Returns the list of most popular threads under this container. |
TdRole |
getRole() Returns global role for the current user. |
TdSubscriptionManager |
getSubscriptionManager() Returns the TdSubscriptionManager for this store. |
TdUser |
getTdUser() Returns the TdUser for this store |
TdUserProfile |
getTdUserProfile() Returns the TdUser for this store |
TdUserProfileManager |
getUserProfileManager() Returns the TdUserInfoManager for this store. |
boolean |
hasAnnouncementsBoard() Returns true if the announcements board has been created |
boolean |
isGlobalAdmin() Returns true if the current user is a global admin for the system. |
boolean |
isGuest() Returns true if the current user is a guest for the domain |
javax.mail.Folder[] |
list() Returns a List of TdFacility objects, one ofr each first level facility under this message store without refreshing the cache. |
javax.mail.Folder[] |
list(boolean bRefresh) Returns a List of TdFacility objects, one ofr each first level facility under this message store. |
javax.mail.Folder[] |
list(java.lang.String path) Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility without refreshing the cache. |
javax.mail.Folder[] |
list(java.lang.String path, boolean bRefresh) Returns an array of TdContainers (Tdfacility or TdBoard) which are children of this facility. |
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. |
TdIterator |
search(TdSearchTerm tdst, java.util.List tdContainers) Searches the messages in the containers passed in recursively according to the supplied search term. |
TdIterator |
search(TdSearchTerm tdst, java.util.List tdContainers, boolean searchAnnouncements) Searches the messages in the containers passed in recursively according to the supplied search term. |
void |
updateGlobalSettings(TdGlobalSettings tdgs) Updates global settings of the current oracle discussions |
Method Detail |
public void close() throws TdException
public void close(boolean bUpdateUserLogout) throws TdException
bUpdateUserLogout
- boolean value indicating if the user logout time is to be updated.public TdGlobalSettings getGlobalSettings() throws TdException
public void updateGlobalSettings(TdGlobalSettings tdgs) throws TdException
tdgs
- a map representing global settings valuespublic javax.mail.Folder[] list(java.lang.String path) throws javax.mail.MessagingException
path
- String representing a path frmo where the folder list is to be extracted.public javax.mail.Folder[] list(java.lang.String path, boolean bRefresh) throws javax.mail.MessagingException
path
- string representing a path from which the folder list is to be extracted.bRefresh
- boolean value representing if the cache is to be updated.public javax.mail.Folder[] list() throws javax.mail.MessagingException
public javax.mail.Folder[] list(boolean bRefresh) throws javax.mail.MessagingException
bRefresh
- boolean flag indicating if the cache is to be refreshedpublic TdContainer getContainer(java.lang.String path) throws TdException
path
- the path at which the container is to be retrieved frompublic TdBoard getBoard(java.lang.String path) throws TdException
public TdFacility getFacility(java.lang.String path) throws TdException
path
- the path at which facility is to be retrieved frompublic TdContainer getContainer(long lCntId) throws TdException
lCntId
- container identifier which is being retrieved.public TdBoard getBoard(long lBrdId) throws TdException
lBrdId
- the identifier of the board which is being retrievedpublic TdFacility getFacility(long lFacId) throws TdException
lFacId
- the facility identifierpublic TdFacility createFacility(TdFacility tdfParent, java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription) throws TdException
tdfParent
- the parent facility under which the current facility is being createdfacilityName
- name of the facility being created.facilityDisplayName
- display name of the facilityfacilityDescription
- the description for this facilitypublic TdFacility createFacility(TdFacility tdfParent, java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription, boolean bWithAnnouncementsBoard) throws TdException
tdfParent
- the parent facility under which the current facility is being createdfacilityName
- name of the facility being created.facilityDisplayName
- display name of the facilityfacilityDescription
- the description for this facilitybWithAnnouncementsBoard
- boolean value indicating if the announcements board will be created automatically.public TdBoard createBoard(TdFacility tdfParent, java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic) throws TdException
tdfParent
- the facility under which the board is being created.boardName
- the name of the board which is being created.boardDisplayName
- the display name for this board.boardDescription
- description for this board.boardEmail
- email id associated with the board.isPublic
- boolean value indicating if the board is publicly accessible.public TdBoard createBoard(TdFacility tdfParent, java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic, boolean bWithAnnouncementsBoard) throws TdException
tdfParent
- the facility under which the board is being created.boardName
- the name of the board which is being created.boardDisplayName
- the display name for this board.boardDescription
- description for this board.boardEmail
- email id associated with the board.isPublic
- boolean value indicating if the board is publicly accessible.bWithAnnouncementsBoard
- boolean value indicating if the announcements board will be created automatically.public TdUser getTdUser()
public TdUserProfile getTdUserProfile() throws TdException
public TdUserProfileManager getUserProfileManager()
public TdFavoriteManager getFavoriteManager()
public TdGlobalAdminManager getGlobalAdminManager() throws TdException
public TdIterator search(TdSearchTerm tdst) throws TdException, javax.mail.MessagingException
tdst
- the search term which is to be searchedpublic TdIterator search(TdSearchTerm tdst, boolean searchAnnouncements) throws TdException, javax.mail.MessagingException
tdst
- the search term which is to be searchedsearchAnnouncements
- whether to search announcements as wellpublic TdIterator search(TdSearchTerm tdst, java.util.List tdContainers) throws TdException, javax.mail.MessagingException
tdst
- the searchterm which is to be searchedtdContainers
- the container listing limiting the searchpublic TdIterator search(TdSearchTerm tdst, java.util.List tdContainers, boolean searchAnnouncements) throws TdException, javax.mail.MessagingException
tdst
- the searchterm which is to be searchedtdContainers
- the container listing limiting the searchsearchAnnouncements
- whether to search announcements as wellpublic TdMyPosts getMyPosts() throws TdException, javax.mail.MessagingException
public TdMyFollowups getMyFollowups() throws TdException, javax.mail.MessagingException
public TdLastPost getLastPost() throws javax.mail.MessagingException
public TdIterator getPopularThreads() throws TdException, javax.mail.MessagingException
public TdIterator getLastMessagePosts() throws TdException, javax.mail.MessagingException
public boolean hasAnnouncementsBoard() throws TdException
public TdBoard getAnnouncementsBoard() throws TdException
public TdBoard getBoardByEmailAddress(java.lang.String boardEmail) throws TdException, javax.mail.MessagingException
boardEmail
- board email addresspublic java.util.List getBoardsByDistributionListAddress(java.lang.String dlEmail) throws TdException, javax.mail.MessagingException
boardEmail
- board outgoing distribution list addresspublic TdRole getRole() throws TdException
public boolean isGlobalAdmin() throws TdException
public boolean isGuest()
public TdUser getGuestUser()
public java.lang.String getDomain()
public TdSubscriptionManager getSubscriptionManager()
|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |