Package com.appiancorp.suiteapi.portal.portlets.discussionthreads

Interface DiscussionPortletService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface DiscussionPortletService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Defines the convenience methods available for the discussion portlet.

Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.

It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).

It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

  • Field Details

    • addForumForDiscussionPortlet$UPDATES

      static final boolean addForumForDiscussionPortlet$UPDATES
      Deprecated.
      See Also:

    • getForumsForDiscussionPortlet$UPDATES

      static final boolean getForumsForDiscussionPortlet$UPDATES
      Deprecated.
      See Also:

    • setForumsForDiscussionPortlet$UPDATES

      static final boolean setForumsForDiscussionPortlet$UPDATES
      Deprecated.
      See Also:

    • removeForumForDiscussionPortlet$UPDATES

      static final boolean removeForumForDiscussionPortlet$UPDATES
      Deprecated.
      See Also:

    • getPublicForums$UPDATES

      static final boolean getPublicForums$UPDATES
      Deprecated.
      See Also:

    • getApplicationName$UPDATES

      static final boolean getApplicationName$UPDATES
      Deprecated.
      See Also:

    • getWorkspace$UPDATES

      static final boolean getWorkspace$UPDATES
      Deprecated.
      See Also:

  • Method Details

    • addForumForDiscussionPortlet

      void addForumForDiscussionPortlet(Long portletId_, Long forumId_) throws IllegalArgumentException, InvalidPortletException
      Deprecated.
      Add a discussion forum to a portlet
      Parameters:
      portletId_ - the portlet ID
      forumId_ - the forum ID of the forum to add to the portlet
      Throws:
      IllegalArgumentException - if the portlet ID does not correspond to a discussion forum portlet
      InvalidPortletException - if no portlet with the given ID exists
      ServiceException - if any system-level error occurs

    • getForumsForDiscussionPortlet

      Forum[] getForumsForDiscussionPortlet(Long portletId_) throws IllegalArgumentException, InvalidPortletException
      Deprecated.
      Retrieve the forums attached to a portlet
      Parameters:
      portletId_ - the portlet ID
      Returns:
      an array of Forum objects attached to the portlet
      Throws:
      IllegalArgumentException - if the portlet ID does not correspond to a discussion forum portlet
      InvalidPortletException - if no portlet with the given ID exists
      ServiceException - if any system-level error occurs

    • setForumsForDiscussionPortlet

      void setForumsForDiscussionPortlet(Long portletId_, Long[] forumIds_) throws IllegalArgumentException, InvalidPortletException
      Deprecated.
      Set the forums to be attached to a portlet
      Parameters:
      portletId_ - the portlet ID
      forumIds_ - the IDs of the forums to attach to the portlet
      Throws:
      IllegalArgumentException - if the portlet ID does not correspond to a discussion forum portlet
      InvalidPortletException - if no portlet with the given ID exists
      ServiceException - if any system-level error occurs

    • removeForumForDiscussionPortlet

      void removeForumForDiscussionPortlet(Long portletId_, Long forumId_) throws IllegalArgumentException, InvalidPortletException
      Deprecated.
      Remove a forum from a portlet
      Parameters:
      portletId_ - the portlet ID
      forumId_ - the forum ID of the forum to be removed
      Throws:
      IllegalArgumentException - if the portlet ID does not correspond to a discussion forum portlet
      InvalidPortletException - if no portlet with the given ID exists
      ServiceException - if any system-level error occurs

    • getPublicForums

      Long[] getPublicForums()
      Deprecated.
      Gets forums in public portlets in public pages
      Returns:
      the forum IDs of the forums in public portlets in public pages
      Throws:
      ServiceException - if any system-level error occurs

    • getApplicationName

      String getApplicationName()
      Deprecated.
      Gets the name of the application
      Returns:
      the name of the application
      Throws:
      ServiceException - if any system-level error occurs

    • getWorkspace

      String[] getWorkspace()
      Deprecated.
      Gets the current memory profile for the workspace.
      Returns:
      array of Strings of length 4 describing memory usage:
      • [0]Used - Memory Used by the Server so far for storage
      • [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
      • [2]Mapped - is the space used by memory-mapped files
      • [3]Available - is the total available memory for the Server process
      Note: All usage statistics are in Bytes.
      Throws:
      ServiceException - if any system-level error occurs