@Deprecated
public interface GroupMessageService
extends com.appiancorp.services.ContextSensitiveService
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.
Modifier and Type | Field and Description |
---|---|
static boolean |
createGroupMessage$UPDATES
Deprecated.
|
static boolean |
deleteGroupMessage$UPDATES
Deprecated.
|
static boolean |
findGroupMessagesInPortletPaging$UPDATES
Deprecated.
|
static boolean |
findGroupMessagesPaging$UPDATES
Deprecated.
|
static boolean |
getApplicationName$UPDATES
Deprecated.
|
static boolean |
getCurrentGroupMessagesPage$UPDATES
Deprecated.
|
static boolean |
getExpiredGroupMessagesPage$UPDATES
Deprecated.
|
static boolean |
getGroupMessagesPage$UPDATES
Deprecated.
|
static boolean |
getWorkspace$UPDATES
Deprecated.
|
static boolean |
moveGroupMessage$UPDATES
Deprecated.
|
static boolean |
shiftGroupMessage$UPDATES
Deprecated.
|
static boolean |
updateGroupMessage$UPDATES
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Long |
createGroupMessage(java.lang.Long portletId_,
GroupMessage gm_)
Deprecated.
Create a group message in the given portlet.
|
void |
deleteGroupMessage(java.lang.Long groupMessageId_)
Deprecated.
Delete a group message
|
ResultPage |
findGroupMessagesInPortletPaging(GroupMessage message_,
java.lang.Long portletId_,
int index_,
int count_)
Deprecated.
Searches through names of the group messages the user can see, for a
given portlet.
|
ResultPage |
findGroupMessagesPaging(GroupMessage message_,
int index_,
int count_)
Deprecated.
Searches through names of the group messages the user can see.
|
java.lang.String |
getApplicationName()
Deprecated.
Gets the name of the application on which this service is running.
|
ResultPage |
getCurrentGroupMessagesPage(java.lang.Long portletId_,
int startIndex_,
int batchSize_)
Deprecated.
Retrieves the current (that is, not expired) group messages in the given
portlet
|
ResultPage |
getExpiredGroupMessagesPage(java.lang.Long portletId_,
int startIndex_,
int batchSize_)
Deprecated.
Retrieves the expired group messages in the given portlet
|
ResultPage |
getGroupMessagesPage(java.lang.Long portletId_,
int startIndex_,
int batchSize_)
Deprecated.
Retrieves all group messages (both current and expired) in the given
portlet
|
java.lang.String[] |
getWorkspace()
Deprecated.
Gets the current memory profile for the workspace.
|
void |
moveGroupMessage(java.lang.Long groupMessageId_,
int newPosition_)
Deprecated.
Move a group within the total list of messages (current and expired) for
a portlet.
|
void |
shiftGroupMessage(java.lang.Long groupMessageId_,
int newPosition_)
Deprecated.
Shift a group message within its category (current or expired) for a
portlet.
|
void |
updateGroupMessage(GroupMessage gm_)
Deprecated.
Update a group message.
|
static final boolean createGroupMessage$UPDATES
static final boolean updateGroupMessage$UPDATES
static final boolean deleteGroupMessage$UPDATES
static final boolean getCurrentGroupMessagesPage$UPDATES
static final boolean getExpiredGroupMessagesPage$UPDATES
static final boolean getGroupMessagesPage$UPDATES
static final boolean moveGroupMessage$UPDATES
static final boolean shiftGroupMessage$UPDATES
static final boolean findGroupMessagesPaging$UPDATES
static final boolean findGroupMessagesInPortletPaging$UPDATES
static final boolean getApplicationName$UPDATES
static final boolean getWorkspace$UPDATES
java.lang.Long createGroupMessage(java.lang.Long portletId_, GroupMessage gm_) throws InvalidPortletException
link
(the fields on this
Link
object that must be populated are given by
LinksService.updateLink(com.appiancorp.suiteapi.portal.portlets.links.Link)
)portletId_
- the ID of the portlet in which this group messages is
being created.gm_
- the group message to create. The id
field will be ignored, and the Link
field is required.InvalidPortletException
- if the portlet ID does not correspond to a
valid portletServiceException
- if any system-level error occursvoid updateGroupMessage(GroupMessage gm_) throws InvalidGroupMessageException
id
. If the link
field is not
null
, the link ID of the link is NOT updated, and the minimum
fields that must be populated on this
Link
object are given by
LinksService.updateLink(com.appiancorp.suiteapi.portal.portlets.links.Link)
gm_
- a group message with the updated values. The Link
field is requiredInvalidGroupMessageException
- if the ID of the group message does
not correspond to a valid group messageServiceException
- if any system-level error occursvoid deleteGroupMessage(java.lang.Long groupMessageId_) throws InvalidGroupMessageException
groupMessageId_
- the ID of the group message to deleteInvalidGroupMessageException
- if the ID does not correspond to a
valid group messageServiceException
- if any system-level error occursResultPage getCurrentGroupMessagesPage(java.lang.Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException
portletId_
- the ID of the portlet whose group messages are to be
retrievedstartIndex_
- the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.ResultPage
which contains an array of
GroupMessage
objects, representing the current group
messages for the given portletInvalidPortletException
- if the ID does not correspond to a valid
portletServiceException
- if any system-level error occursResultPage getExpiredGroupMessagesPage(java.lang.Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException
portletId_
- the ID of the portlet whose group messages are to be
retrievedstartIndex_
- the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.ResultPage
which contains an array of
GroupMessage
objects, representing the expired group
messages for the given portletInvalidPortletException
- if the ID does not correspond to a valid
portletServiceException
- if any system-level error occursResultPage getGroupMessagesPage(java.lang.Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException
portletId_
- the ID of the portlet whose group messages are to be
retrievedstartIndex_
- the index into the collection of total results at which
to start. Negative numbers are treated as zerosbatchSize_
- the number of results to return
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouragedResultPage
which contains an array of
GroupMessage
objects, representing all the group
messages for the given portletInvalidPortletException
- if the ID does not correspond to a valid
portletServiceException
- if any system-level error occursvoid moveGroupMessage(java.lang.Long groupMessageId_, int newPosition_) throws InvalidGroupMessageException
groupMessageId_
- the ID of the group message to movenewPosition_
- the group message's new position.
Position is 0-based. If the position index is equal to or greater than the
number of group messages in the portlet then the message is moved to
the end of the list. If the position index is negative then the message
is moved to the beginning of the list.InvalidGroupMessageException
- if the ID does not correspond to a
valid group messageServiceException
- if any system-level error occursvoid shiftGroupMessage(java.lang.Long groupMessageId_, int newPosition_) throws InvalidGroupMessageException
groupMessageId_
- the ID of the group message to movenewPosition_
- the group message's new position
within its category. Position is 0-based. If the position index is equal to
or greater than the number of group messages in the category, the message
is moved to the end of the category's list. If the position index is
negative then the message is moved to the beginning of the category list.InvalidGroupMessageException
- if the ID does not correspond to a
valid group messageServiceException
- if any system-level error occursResultPage findGroupMessagesPaging(GroupMessage message_, int index_, int count_)
java.lang.String
items are matched using regular expressions
(e.g., "ab*" matches those items beginning with "ab")message_
- the group message used in the search. If
null
, null
will be returned.index_
- the index of the first group message that will be
returnedcount_
- the number of group messages to be returned in the
ResultPage
ResultPage
containing the list of
GroupMessage
objects matching the search termsServiceException
- if any system-level error occursResultPage findGroupMessagesInPortletPaging(GroupMessage message_, java.lang.Long portletId_, int index_, int count_)
java.lang.String
items are matched using regular expressions
(e.g., "ab*" matches those items beginning with "ab")message_
- the group message used in the search. If
null
, null
will be returned.portletId_
- the ID of the portlet in which to searchindex_
- the index of the first group message that will be
returnedcount_
- the number of group messages to be returned in the
ResultPage
ResultPage
containing the list of
GroupMessage
objects matching the search termsServiceException
- if any system-level error occursjava.lang.String getApplicationName()
ServiceException
- if any system-level error occursjava.lang.String[] getWorkspace()
ServiceException
- if any system-level error occursCopyright © 2003-2024 Appian Corporation. All Rights Reserved.