Interface GroupMessageService
- 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.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 TypeMethodDescriptioncreateGroupMessage
(Long portletId_, GroupMessage gm_) Deprecated.Create a group message in the given portlet.void
deleteGroupMessage
(Long groupMessageId_) Deprecated.Delete a group messagefindGroupMessagesInPortletPaging
(GroupMessage message_, Long portletId_, int index_, int count_) Deprecated.Searches through names of the group messages the user can see, for a given portlet.findGroupMessagesPaging
(GroupMessage message_, int index_, int count_) Deprecated.Searches through names of the group messages the user can see.Deprecated.Gets the name of the application on which this service is running.getCurrentGroupMessagesPage
(Long portletId_, int startIndex_, int batchSize_) Deprecated.Retrieves the current (that is, not expired) group messages in the given portletgetExpiredGroupMessagesPage
(Long portletId_, int startIndex_, int batchSize_) Deprecated.Retrieves the expired group messages in the given portletgetGroupMessagesPage
(Long portletId_, int startIndex_, int batchSize_) Deprecated.Retrieves all group messages (both current and expired) in the given portletString[]
Deprecated.Gets the current memory profile for the workspace.void
moveGroupMessage
(Long groupMessageId_, int newPosition_) Deprecated.Move a group within the total list of messages (current and expired) for a portlet.void
shiftGroupMessage
(Long groupMessageId_, int newPosition_) Deprecated.Shift a group message within its category (current or expired) for a portlet.void
Deprecated.Update a group message.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
createGroupMessage$UPDATES
static final boolean createGroupMessage$UPDATESDeprecated.- See Also:
-
updateGroupMessage$UPDATES
static final boolean updateGroupMessage$UPDATESDeprecated.- See Also:
-
deleteGroupMessage$UPDATES
static final boolean deleteGroupMessage$UPDATESDeprecated.- See Also:
-
getCurrentGroupMessagesPage$UPDATES
static final boolean getCurrentGroupMessagesPage$UPDATESDeprecated.- See Also:
-
getExpiredGroupMessagesPage$UPDATES
static final boolean getExpiredGroupMessagesPage$UPDATESDeprecated.- See Also:
-
getGroupMessagesPage$UPDATES
static final boolean getGroupMessagesPage$UPDATESDeprecated.- See Also:
-
moveGroupMessage$UPDATES
static final boolean moveGroupMessage$UPDATESDeprecated.- See Also:
-
shiftGroupMessage$UPDATES
static final boolean shiftGroupMessage$UPDATESDeprecated.- See Also:
-
findGroupMessagesPaging$UPDATES
static final boolean findGroupMessagesPaging$UPDATESDeprecated.- See Also:
-
findGroupMessagesInPortletPaging$UPDATES
static final boolean findGroupMessagesInPortletPaging$UPDATESDeprecated.- See Also:
-
getApplicationName$UPDATES
static final boolean getApplicationName$UPDATESDeprecated.- See Also:
-
getWorkspace$UPDATES
static final boolean getWorkspace$UPDATESDeprecated.- See Also:
-
-
Method Details
-
createGroupMessage
Deprecated.Create a group message in the given portlet. The latest group message added to a portlet will be the first one in the retrieved list of group messages for that portlet. Minimum fields that must be populated on a group message for successful creation:link
(the fields on thisLink
object that must be populated are given byLinksService.updateLink(com.appiancorp.suiteapi.portal.portlets.links.Link)
)- Parameters:
portletId_
- the ID of the portlet in which this group messages is being created.gm_
- the group message to create. Theid
field will be ignored, and theLink
field is required.- Returns:
- the ID of the created group message
- Throws:
InvalidPortletException
- if the portlet ID does not correspond to a valid portletServiceException
- if any system-level error occurs
-
updateGroupMessage
Deprecated.Update a group message. Minimum fields necessary for updating a group message:id
. If thelink
field is notnull
, the link ID of the link is NOT updated, and the minimum fields that must be populated on thisLink
object are given byLinksService.updateLink(com.appiancorp.suiteapi.portal.portlets.links.Link)
- Parameters:
gm_
- a group message with the updated values. TheLink
field is required- Throws:
InvalidGroupMessageException
- if the ID of the group message does not correspond to a valid group messageServiceException
- if any system-level error occurs
-
deleteGroupMessage
Deprecated.Delete a group message- Parameters:
groupMessageId_
- the ID of the group message to delete- Throws:
InvalidGroupMessageException
- if the ID does not correspond to a valid group messageServiceException
- if any system-level error occurs
-
getCurrentGroupMessagesPage
ResultPage getCurrentGroupMessagesPage(Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException Deprecated.Retrieves the current (that is, not expired) group messages in the given portlet- Parameters:
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Returns:
- a
ResultPage
which contains an array ofGroupMessage
objects, representing the current group messages for the given portlet - Throws:
InvalidPortletException
- if the ID does not correspond to a valid portletServiceException
- if any system-level error occurs
-
getExpiredGroupMessagesPage
ResultPage getExpiredGroupMessagesPage(Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException Deprecated.Retrieves the expired group messages in the given portlet- Parameters:
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Returns:
- a
ResultPage
which contains an array ofGroupMessage
objects, representing the expired group messages for the given portlet - Throws:
InvalidPortletException
- if the ID does not correspond to a valid portletServiceException
- if any system-level error occurs
-
getGroupMessagesPage
ResultPage getGroupMessagesPage(Long portletId_, int startIndex_, int batchSize_) throws InvalidPortletException Deprecated.Retrieves all group messages (both current and expired) in the given portlet- Parameters:
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 UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged- Returns:
- a
ResultPage
which contains an array ofGroupMessage
objects, representing all the group messages for the given portlet - Throws:
InvalidPortletException
- if the ID does not correspond to a valid portletServiceException
- if any system-level error occurs
-
moveGroupMessage
Deprecated.Move a group within the total list of messages (current and expired) for a portlet.- Parameters:
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.- Throws:
InvalidGroupMessageException
- if the ID does not correspond to a valid group messageServiceException
- if any system-level error occurs
-
shiftGroupMessage
Deprecated.Shift a group message within its category (current or expired) for a portlet.- Parameters:
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.- Throws:
InvalidGroupMessageException
- if the ID does not correspond to a valid group messageServiceException
- if any system-level error occurs
-
findGroupMessagesPaging
Deprecated.Searches through names of the group messages the user can see. The search bean contains nulls for match-all wildcards.java.lang.String
items are matched using regular expressions (e.g., "ab*" matches those items beginning with "ab")- Parameters:
message_
- the group message used in the search. Ifnull
,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 theResultPage
- Returns:
- a
ResultPage
containing the list ofGroupMessage
objects matching the search terms - Throws:
ServiceException
- if any system-level error occurs
-
findGroupMessagesInPortletPaging
ResultPage findGroupMessagesInPortletPaging(GroupMessage message_, Long portletId_, int index_, int count_) Deprecated.Searches through names of the group messages the user can see, for a given portlet. The search bean contains nulls for match-all wildcards.java.lang.String
items are matched using regular expressions (e.g., "ab*" matches those items beginning with "ab")- Parameters:
message_
- the group message used in the search. Ifnull
,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 theResultPage
- Returns:
- a
ResultPage
containing the list ofGroupMessage
objects matching the search terms - Throws:
ServiceException
- if any system-level error occurs
-
getApplicationName
String getApplicationName()Deprecated.Gets the name of the application on which this service is running.- 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
-