Interface DiscussionPortletService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addForumForDiscussionPortlet
(Long portletId_, Long forumId_) Deprecated.Add a discussion forum to a portletDeprecated.Gets the name of the applicationForum[]
getForumsForDiscussionPortlet
(Long portletId_) Deprecated.Retrieve the forums attached to a portletLong[]
Deprecated.Gets forums in public portlets in public pagesString[]
Deprecated.Gets the current memory profile for the workspace.void
removeForumForDiscussionPortlet
(Long portletId_, Long forumId_) Deprecated.Remove a forum from a portletvoid
setForumsForDiscussionPortlet
(Long portletId_, Long[] forumIds_) Deprecated.Set the forums to be attached to a portletMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
addForumForDiscussionPortlet$UPDATES
static final boolean addForumForDiscussionPortlet$UPDATESDeprecated.- See Also:
-
getForumsForDiscussionPortlet$UPDATES
static final boolean getForumsForDiscussionPortlet$UPDATESDeprecated.- See Also:
-
setForumsForDiscussionPortlet$UPDATES
static final boolean setForumsForDiscussionPortlet$UPDATESDeprecated.- See Also:
-
removeForumForDiscussionPortlet$UPDATES
static final boolean removeForumForDiscussionPortlet$UPDATESDeprecated.- See Also:
-
getPublicForums$UPDATES
static final boolean getPublicForums$UPDATESDeprecated.- See Also:
-
getApplicationName$UPDATES
static final boolean getApplicationName$UPDATESDeprecated.- See Also:
-
getWorkspace$UPDATES
static final boolean getWorkspace$UPDATESDeprecated.- 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 IDforumId_
- the forum ID of the forum to add to the portlet- Throws:
IllegalArgumentException
- if the portlet ID does not correspond to a discussion forum portletInvalidPortletException
- if no portlet with the given ID existsServiceException
- 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 portletInvalidPortletException
- if no portlet with the given ID existsServiceException
- 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 IDforumIds_
- the IDs of the forums to attach to the portlet- Throws:
IllegalArgumentException
- if the portlet ID does not correspond to a discussion forum portletInvalidPortletException
- if no portlet with the given ID existsServiceException
- 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 IDforumId_
- the forum ID of the forum to be removed- Throws:
IllegalArgumentException
- if the portlet ID does not correspond to a discussion forum portletInvalidPortletException
- if no portlet with the given ID existsServiceException
- 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
- Throws:
ServiceException
- if any system-level error occurs
-