Package com.appiancorp.suiteapi.portal.portlets.groupmessage

Interface GroupMessageService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface GroupMessageService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
The Group Message channel and code will be removed in a future release.
Provides methods that relate to the group message channel. The group message channel contains a list of various internal and external links, and each link has a message associated with it. When a message is created it is given a number of days before it will expire. Once the number of days has passed the message is no longer displayed in the channel.

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 Details

    • createGroupMessage$UPDATES

      static final boolean createGroupMessage$UPDATES
      Deprecated.
      See Also:

    • updateGroupMessage$UPDATES

      static final boolean updateGroupMessage$UPDATES
      Deprecated.
      See Also:

    • deleteGroupMessage$UPDATES

      static final boolean deleteGroupMessage$UPDATES
      Deprecated.
      See Also:

    • getCurrentGroupMessagesPage$UPDATES

      static final boolean getCurrentGroupMessagesPage$UPDATES
      Deprecated.
      See Also:

    • getExpiredGroupMessagesPage$UPDATES

      static final boolean getExpiredGroupMessagesPage$UPDATES
      Deprecated.
      See Also:

    • getGroupMessagesPage$UPDATES

      static final boolean getGroupMessagesPage$UPDATES
      Deprecated.
      See Also:

    • moveGroupMessage$UPDATES

      static final boolean moveGroupMessage$UPDATES
      Deprecated.
      See Also:

    • shiftGroupMessage$UPDATES

      static final boolean shiftGroupMessage$UPDATES
      Deprecated.
      See Also:

    • findGroupMessagesPaging$UPDATES

      static final boolean findGroupMessagesPaging$UPDATES
      Deprecated.
      See Also:

    • findGroupMessagesInPortletPaging$UPDATES

      static final boolean findGroupMessagesInPortletPaging$UPDATES
      Deprecated.
      See Also:

    • getApplicationName$UPDATES

      static final boolean getApplicationName$UPDATES
      Deprecated.
      See Also:

    • getWorkspace$UPDATES

      static final boolean getWorkspace$UPDATES
      Deprecated.
      See Also:

  • Method Details

    • createGroupMessage

      Long createGroupMessage(Long portletId_, GroupMessage gm_) throws InvalidPortletException
      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 this Link object that must be populated are given by LinksService.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. The id field will be ignored, and the Link field is required.
      Returns:
      the ID of the created group message
      Throws:
      InvalidPortletException - if the portlet ID does not correspond to a valid portlet
      ServiceException - if any system-level error occurs

    • updateGroupMessage

      void updateGroupMessage(GroupMessage gm_) throws InvalidGroupMessageException
      Deprecated.
      Update a group message. Minimum fields necessary for updating a group message: 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)
      Parameters:
      gm_ - a group message with the updated values. The Link field is required
      Throws:
      InvalidGroupMessageException - if the ID of the group message does not correspond to a valid group message
      ServiceException - if any system-level error occurs

    • deleteGroupMessage

      void deleteGroupMessage(Long groupMessageId_) throws InvalidGroupMessageException
      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 message
      ServiceException - 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 retrieved
      startIndex_ - 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.
      Returns:
      a ResultPage which contains an array of GroupMessage objects, representing the current group messages for the given portlet
      Throws:
      InvalidPortletException - if the ID does not correspond to a valid portlet
      ServiceException - 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 retrieved
      startIndex_ - 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.
      Returns:
      a ResultPage which contains an array of GroupMessage objects, representing the expired group messages for the given portlet
      Throws:
      InvalidPortletException - if the ID does not correspond to a valid portlet
      ServiceException - 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 retrieved
      startIndex_ - 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
      Returns:
      a ResultPage which contains an array of GroupMessage objects, representing all the group messages for the given portlet
      Throws:
      InvalidPortletException - if the ID does not correspond to a valid portlet
      ServiceException - if any system-level error occurs

    • moveGroupMessage

      void moveGroupMessage(Long groupMessageId_, int newPosition_) throws InvalidGroupMessageException
      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 move
      newPosition_ - 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 message
      ServiceException - if any system-level error occurs

    • shiftGroupMessage

      void shiftGroupMessage(Long groupMessageId_, int newPosition_) throws InvalidGroupMessageException
      Deprecated.
      Shift a group message within its category (current or expired) for a portlet.
      Parameters:
      groupMessageId_ - the ID of the group message to move
      newPosition_ - 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 message
      ServiceException - if any system-level error occurs

    • findGroupMessagesPaging

      ResultPage findGroupMessagesPaging(GroupMessage message_, int index_, int count_)
      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. If null, null will be returned.
      index_ - the index of the first group message that will be returned
      count_ - the number of group messages to be returned in the ResultPage
      Returns:
      a ResultPage containing the list of GroupMessage 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. If null, null will be returned.
      portletId_ - the ID of the portlet in which to search
      index_ - the index of the first group message that will be returned
      count_ - the number of group messages to be returned in the ResultPage
      Returns:
      a ResultPage containing the list of GroupMessage 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
      Note: All usage statistics are in Bytes.
      Throws:
      ServiceException - if any system-level error occurs