Oracle Collaboration Suite Discussions Java API Reference
10g (10.1.1)

Part No. B16232-01


Package oracle.discussions.sdk

Provides core classes for creating oracle discussions elements.

See:
          Description

Interface Summary
TdBoardSettings BoardSettings represent the board attributes defined when the board is created.
TdContainerSettings ContainerSettings represent the attributes defined when the container is created.
TdFavorite Represents any discussions element which is added as a favorite element.
TdFavoriteManager Represents a class which can manage the favorite elements in discussions.
TdGlobalAdminManager Represents a class which performs root level operations.
TdGlobalSettings Represents the settings at the entire oracle discussions application level.
TdIterator Parent interface for all oracle discussion related iterators Extends java.util.Iterator.
TdLastPost Represents the most recently posted message in the oracle discussions application.
TdMyFavorites Represents a users full listing of favorites in complete discussions at all container levels.
TdMyFollowups Represents the threads/messages/replies to which others oracle discussions users have contributed, after this used did.
TdMyPosts Represents a user's posted threads/messages/replies in oracle discussions.
TdRelatedContent Represents the content which is related to the current user.
TdStore TdStore represents an abstraction over a message store for facilities and boards.
TdStoreFactory TdStoreFactory creates TdStore instances for discussions users.
TdSubscriptionManager Represents a class which manages user subscriptions.
TdUserProfile Provides accessors for accessing the profile information of a Threaded Discussions user.
TdUserProfileManager Provides accessors for loading user's profile for this TdStore.

 

Class Summary
TdAnnotation Represents any operations that are performed on the threads/messages in oracle discussions.
TdAnnouncementsBoard Announcements Board extends the conventional TdBoard class.
TdAttachment TdAttachment is a light-weight object representing an attachment in a message.
TdBoard This class represents a Board for holding messages.
TdBoardPermissions TdBoardPermissions represents the permissions that different roles can have on a specified board.
TdContainer Super class for TdFacility and TdBoard as both act as container and share some common properties
TdContainerPermissions Represents the permissions that a oracle discussions user holds on a container.
TdFacility This class represents a Facility container.
TdFacilityPermissions Represents the permissions of the connected user on a facility.
TdFlag Enumeration class for the user message flags set by Oracle Discussions in TdMessages.
TdGranteeRole Associates a oracle discussions user with a specific oracle discussions role.
TdInitialContext This class is used by callers to supply initialization parameters to the oracle discussions APIs.
TdMessage TdMessage is a light-weight object representing a Message in a Board.
TdMessagePermissions Represents the operations that a user can perform on a particular message.
TdPermissions Represents the permissions that a user has on a oracle discussions element.
User's permissions are manifested by the role he plays on the discussions element.
TdRole Enumeration class for the access control role defined in Oracle oracle discussions.
TdSearchResultMessage Represents an individual search result object, returned by oracle discussions search.
TdSearchTerm Defines the query criteria for a search in Oracle Discussions.
TdStoreManager Entry point for all oracle discussions APIs.
TdSubscription Oracle discussions allows users to subscribe to the discussions elements of their choice, to which they have access to.
TdThread TdThread is a TdMessage with additional accessors for thread specific information.
TdThreadPermissions Represents the permissions a user owns on a particular thread object.
TdThreadSubscription Represents user subscriptions on a thread.
TdUser Represents a oracle discussions user.
TdUserFactory A factory class, used to create oracle discussions user objects.

 

Exception Summary
TdConfigurationException Will be raised when the supplied configuration parameters are leading to an exception.
TdException Indicates a oracle discussions specific generic exception.
TdMessagingException Wrapper a TdException into a MessagingException to allow to overwrite javax.mail.* APIs.
TdUnsupportedOperationException Runtime exception raised for JavaMail operations not supported by oracle discussions implementation.

 

Package oracle.discussions.sdk Description

Provides core classes for creating oracle discussions elements.

sdk package provides the essential classes and documentation needed for creating the various elements of oracle discussions and understanding their underlying functionality.
Oracle discussions is exposed to the end user in the form of a webui.
Each of the user actions on the ui will result in a call to a method in the sdk package.Various user actions are logged into a log file (ORACLE_HOME/discussions/log/discussions.log) for auditing purposes.

Please find the sample code below illustrating the initilization and usage of the oracle discussions and its elements.

      //Create a TdInitialContext Object, initializing with oracle discussions context.
      TdInitialContext tdic = new TdInitialContext(mEnv);
      //Create an instance of TdStoreManager which initializes 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

      //Now create various discussions elements.
      TdFacility tdf = tdStore.createFacility(.....);

      //In the similar fashion, other discussions elements can also be created.
    

Copyright © 2005, Oracle. All rights reserved.