Interface DiscussionBodyService
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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
createMessage
(Message m_) Deprecated.Stores the body for a new messagevoid
createMessages
(Message[] ms_) Deprecated.Stores the body for multiple messagesString[]
readBodies
(Message[] ms_) Deprecated.Read multiple message bodies.String[]
readBodies
(ThreadedMessage[] tms_) Deprecated.Read multiple message bodies.String[]
readBodies
(String[] locations_) Deprecated.Read multiple message bodies from given locations.Deprecated.Read the message body at the given location.void
updateMessage
(Message m_) Deprecated.Updates a message bodyvoid
updateMessages
(Message[] ms_) Deprecated.Updates multiple message bodies
-
Field Details
-
readBody$UPDATES
static final boolean readBody$UPDATESDeprecated.- See Also:
-
readBodies$UPDATES
static final boolean readBodies$UPDATESDeprecated.- See Also:
-
createMessage$UPDATES
static final boolean createMessage$UPDATESDeprecated.- See Also:
-
createMessages$UPDATES
static final boolean createMessages$UPDATESDeprecated.- See Also:
-
updateMessage$UPDATES
static final boolean updateMessage$UPDATESDeprecated.- See Also:
-
updateMessages$UPDATES
static final boolean updateMessages$UPDATESDeprecated.- See Also:
-
-
Method Details
-
readBody
Deprecated.Read the message body at the given location.- Parameters:
location_
- The location of the body, i.e. filename- Returns:
- The body, if found;
null
, if not found. - Throws:
ServiceException
- if any system-level error occurs.NullPointerException
- if the the given String is null.
-
readBodies
Deprecated.Read multiple message bodies from given locations.- Parameters:
locations_
- The locations of the bodies.- Returns:
- An array containing: the body, if found; a
null
, if not found (this applies for null locations). If the array is empty then it also returns an empty array. - Throws:
ServiceException
- if any system-level error occursNullPointerException
- if the the given array is null.
-
readBodies
Deprecated.Read multiple message bodies.- Parameters:
ms_
- TheMessage
objects for which to obtain bodies; thebodyLocation
field should be populated.- Returns:
- An array containing: the body, if found; a
null
, if not found (this applies for null locations). If the array is empty then it also returns an empty array. - Throws:
ServiceException
- if any system-level error occursNullPointerException
- if the the given array is null.
-
readBodies
Deprecated.Read multiple message bodies.- Parameters:
tms_
- The threadedMessage
objects for which to obtain bodies; thebodyLocation
field should be populated.- Returns:
- An array containing: the body, if found; a
null
, if not found (this applies for null locations). If the array is empty then it also returns an empty array. - Throws:
ServiceException
- if any system-level error occursNullPointerException
- if the the given array is null.
-
createMessage
Deprecated.Stores the body for a new message- Parameters:
m_
- TheMessage
to be stored; thebodyLocation
field should be populated.- Throws:
ServiceException
- if any system-level error occurs
-
createMessages
Deprecated.Stores the body for multiple messages- Parameters:
ms_
- TheMessage
to be stored; thebodyLocation
field should be populated.- Throws:
ServiceException
- if any system-level error occursNullPointerException
- if the the given message array is null.
-
updateMessage
Deprecated.Updates a message body- Parameters:
m_
- TheMessage
to be updated; thebodyLocation
field should be populated.- Throws:
ServiceException
- if any system-level error occurs
-
updateMessages
Deprecated.Updates multiple message bodies- Parameters:
ms_
- The messages to be updated; thebodyLocation
field should be populated.- Throws:
ServiceException
- if any system-level error occursNullPointerException
- if the the given message array is null.
-