com.appiancorp.suiteapi.portal.portlets.discussionthreads

Interface DiscussionPortletService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

Deprecated.

The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public interface DiscussionPortletService
extends com.appiancorp.services.ContextSensitiveService

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 Summary

Fields

Modifier and Type	Field and Description
static boolean	addForumForDiscussionPortlet$UPDATES Deprecated.
static boolean	getApplicationName$UPDATES Deprecated.
static boolean	getForumsForDiscussionPortlet$UPDATES Deprecated.
static boolean	getPublicForums$UPDATES Deprecated.
static boolean	getWorkspace$UPDATES Deprecated.
static boolean	removeForumForDiscussionPortlet$UPDATES Deprecated.
static boolean	setForumsForDiscussionPortlet$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
void	addForumForDiscussionPortlet(java.lang.Long portletId_, java.lang.Long forumId_) Deprecated. Add a discussion forum to a portlet
java.lang.String	getApplicationName() Deprecated. Gets the name of the application
Forum[]	getForumsForDiscussionPortlet(java.lang.Long portletId_) Deprecated. Retrieve the forums attached to a portlet
java.lang.Long[]	getPublicForums() Deprecated. Gets forums in public portlets in public pages
java.lang.String[]	getWorkspace() Deprecated. Gets the current memory profile for the workspace.
void	removeForumForDiscussionPortlet(java.lang.Long portletId_, java.lang.Long forumId_) Deprecated. Remove a forum from a portlet
void	setForumsForDiscussionPortlet(java.lang.Long portletId_, java.lang.Long[] forumIds_) Deprecated. Set the forums to be attached to a portlet

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

addForumForDiscussionPortlet$UPDATES

static final boolean addForumForDiscussionPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getForumsForDiscussionPortlet$UPDATES

static final boolean getForumsForDiscussionPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

setForumsForDiscussionPortlet$UPDATES

static final boolean setForumsForDiscussionPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

removeForumForDiscussionPortlet$UPDATES

static final boolean removeForumForDiscussionPortlet$UPDATES

Deprecated.

See Also:

Constant Field Values

getPublicForums$UPDATES

static final boolean getPublicForums$UPDATES

Deprecated.

See Also:

Constant Field Values

getApplicationName$UPDATES

static final boolean getApplicationName$UPDATES

Deprecated.

See Also:

Constant Field Values

getWorkspace$UPDATES

static final boolean getWorkspace$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

addForumForDiscussionPortlet

void addForumForDiscussionPortlet(java.lang.Long portletId_,
                                  java.lang.Long forumId_)
                           throws java.lang.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:

java.lang.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(java.lang.Long portletId_)
                               throws java.lang.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:

java.lang.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(java.lang.Long portletId_,
                                   java.lang.Long[] forumIds_)
                            throws java.lang.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:

java.lang.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(java.lang.Long portletId_,
                                     java.lang.Long forumId_)
                              throws java.lang.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:

java.lang.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

java.lang.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

java.lang.String getApplicationName()

Deprecated.

Gets the name of the application

Returns:

the name of the application

Throws:

ServiceException - if any system-level error occurs

getWorkspace

java.lang.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