Interface PortalNotificationService
- All Superinterfaces:
ContextSensitiveSingletonService
,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 String
Deprecated.A constant corresponding to the collaboration access approved notification type This is used to send a notification of access approved for a knowledge center in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration access denied notification type This is used to send a notification of access denied to a a knowledge center in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration access requested notification type This is used to send a notification of requested access to a knowledge center in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration changes approved notification type This is used to send a notification of changes to a document approved in collaboration.static final String
Deprecated.A constant corresponding to the collaboration changes denied notification type This is used to send a notification of denial of changes to a document in collaboration.static final String
Deprecated.A constant corresponding to the collaboration file expiration notification type This is used to send a notification of expiring files in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration export completed notification type This is used to send a notification when an export operation has completedstatic final String
Deprecated.A constant corresponding to the collaboration import completed notification type This is used to send a notification when an import operation has completedstatic final String
Deprecated.A constant corresponding to the collaboration invitation accepted notification type This is used to send a notification of acceptance of an invitation to a knowledge center in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration invitation declined notification type This is used to send a notification of declination of an invitation to a knowledge center in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration invitation notification type This is used to send a notification of an invitation to a knowledge center in collaborationstatic final String
Deprecated.A constant for the Collaboration application This is used to send notifications within collaborationstatic final String
Deprecated.A constant corresponding to the collaboration request changes notification type This is used to send a notification to request approval of changes to a document in collaborationstatic final String
Deprecated.A constant corresponding to the collaboration send link notification type This is used to send a notification for links to documents in collaborationstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final String
Deprecated.A constant for the Feeds applicationstatic final String
Deprecated.A constant for the Forums applicationstatic final String
Deprecated.A constant corresponding to the forum and thread invitation acceptance notification type This is used to send acceptances of forum and thread invitationsstatic final String
Deprecated.A constant corresponding to the forum and thread invitation declination notification type This is used to send declinations of forum and thread invitationstatic final String
Deprecated.A constant corresponding to the forum and thread invitation notification type This is used to send forum and thread inivitation notificationstatic final String
Deprecated.A constants corresponding to the forum and thread send link notification type This is used to send send a link to a forum or threadstatic final String
Deprecated.A constant corresponding to the forum and thread subscribe notification type This is used to send forum subscription notificationstatic 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 String
Deprecated.A constant corresponding to the group invitation acceptance notification type This is used to send a notification of acceptance to a group invitationstatic final String
Deprecated.A constant corresponding to the group invitation declination notification type This is used to send a notification of a declination to a group invitationstatic final String
Deprecated.A constant corresponding to the group invitation notification type This is used to send a group invitation notificationstatic final String
Deprecated.A constant corresponding to the group membership approved notification type This is used to send an invitation of an approved group membershipstatic final String
Deprecated.A constant corresponding to the group membership denied notification type This is used to send a notification of a denial of group membershipstatic final String
Deprecated.A constants corresponding to the group membership removal notification type This is used to send a group removal notificationstatic final String
Deprecated.A constant corresponding to the group membership request notification type This is used to send a notification of a group membership requeststatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final String
Deprecated.A constant for the Personalization application This is used to send personalization notificationstatic final String
Deprecated.A constant for the Portal application This is used to send portal notificationsstatic final String
Deprecated.A constant corresponding to the portal page membership removal notification type This is used to send a notification for page membership removalstatic final String
Deprecated.A constant corresponding to the portal page approval notification type This is used to send a notification for page approvalsstatic final String
Deprecated.A constant corresponding to the portal page approval request notification type This is used to send a notification for page approval requestsstatic final String
Deprecated.A constant corresponding to the portal send feedback notification type This is used to send a feedback notificationstatic final String
Deprecated.A constant corresponding to the portal send link notification type This is used to send a link within portalstatic final String
Deprecated.A constant corresponding to the portal system notification type This is used to send a portal system notificationstatic final String
Deprecated.A constant corresponding to the process exception notification type This is used to send a notification when an exception has occurred in a processstatic final String
Deprecated.A constant corresponding to the process model exception notification type This is used to send a notification when an exception has occurred in a process modelstatic final String
Deprecated.A constant corresponding to the "New Task Assigned to Me" notification type This is used to send a notification when a user has a new task assigned to themstatic final String
Deprecated.A constant corresponding to the "New Task Assigned to Others" notification type This is used to send a notification to a user when a task has been assigned to the user and to othersstatic final String
Deprecated.A constant for the Process application This is used to send process notificationstatic final String
Deprecated.A constant corresponding to the "parent process causes sub process to be published" notification type This is used to send a notification when the publishing of a parent process model causes its sub- or linked process models to be publishedstatic final String
Deprecated.A constant corresponding to the "Cannot delete or Cancel sub or linked process" notification type This is used to send a notification when a user tries to delete or cancel a parent process containing sub- or linked processes that he cannot cancel due to permissionsstatic final String
Deprecated.A constant corresponding to the "sub or link process model disabled" notification type This is used to send a notification when a sub or linked process is disabled or deletedstatic final String
Deprecated.A constant corresponding to the "sub or linked process republished" notification type This is sent when to the parent process model owners when a sub- or linked process model is publishedstatic final String
Deprecated.A constant corresponding to the process task escalated notification type This is sent when to when a task has been escalatedstatic final String
Deprecated.A constant corresponding to the task exception notification type This is used to send a notification when an exception has occurred in a taskstatic final boolean
Deprecated.static final boolean
Deprecated.static final Integer
Deprecated.A constant sort order for notification - sort in ascending orderstatic final Integer
Deprecated.A constant sort order for notification - sort in descending orderstatic final String
Deprecated.A constant corresponding to the "New comment on a social task that was sent by you" notification type.static final String
Deprecated.A constant corresponding to the "New comment on a social task that was sent to you" notification type.static final String
Deprecated.A constant for the Tasks applicationstatic final String
Deprecated.A constant corresponding to the "A social task that was sent by you was closed" notification type.static final String
Deprecated.A constant corresponding to the "A social task that was sent to you was closed" notification type.static final String
Deprecated.A constant corresponding to the "New comment on a kudos that you gave" notification type.static final String
Deprecated.A constant corresponding to the "New comment on a kudos that you have commented on or starred" notification type.static final String
Deprecated.TEMPO_COMMENT_ON_MESSAGE_TO_GROUP
is now used for messages to users, groups and everyonestatic final String
Deprecated.A constant corresponding to the "New comment on a post or message that you have commented on" notification type.static final String
Deprecated.A constant corresponding to the "New comment on your message" notification type.static final String
Deprecated.A constant corresponding to the "New comment on an event attributed to you" notification type.static final String
Deprecated.A constant corresponding to the "New comment on an event that you have commented on" notification type.static final String
Deprecated.A constant corresponding to the "New comment on your post" notification type.static final String
Deprecated.A constant corresponding to the "New comment on a kudos that you received" notification type.static final String
Deprecated.A constant corresponding to the "New comment on a system event that you have commented on" notification type.static final String
Deprecated.A constant corresponding to the "New group message posted" notification type.static final String
Deprecated.Group has been added as a participantstatic final String
Deprecated.A constant corresponding to the "New hazard on an event attributed to you" notification type.static final String
Deprecated.A constant corresponding to the "New hazard on an event that you have commented on" notification type.static final String
Deprecated.A constant corresponding to the "New hazard on a system event that you have commented on" notification type.static final String
Deprecated.A constant corresponding to the "New message sent to you" notification type.static final String
Deprecated.A constant for the Tempo applicationstatic final String
Deprecated.You have been added as a participantstatic final String
Deprecated.Participants added to your feed entrystatic final String
Deprecated.A constant corresponding to the "New event attributed to you" notification type.static final String
Deprecated.A constant corresponding to the "New kudos given to you" notification type.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService
CONFIGURE_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.void
Deprecated.Deletes all expired notifications for the current uservoid
deleteNotification
(Long notificationId_) Deprecated.Delete a notificationvoid
deleteNotifications
(Long[] notificationIds_) Deprecated.Delete a list of notificationsvoid
deleteNotificationsBeforeTimestamp
(Timestamp timestamp) Deprecated.Deletes all notifications for the current user before the given timestamp.getNotification
(Long notifId_) Deprecated.Gets a notificationgetNotifications
(Integer sortOrder_, Integer sortType_, int startIndex_, int count_) Deprecated.use getNotificationsPaging insteadgetNotificationsByApplication
(String appName_) Deprecated.Gets a list of notifications matching Application namegetNotificationsByApplicationAndType
(String appName_, String notificationType_) Deprecated.Gets the list of notifications matching the specified Application and Notification TypegetNotificationsPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets a the notifications that the current user has received in the portal medium.Deprecated.Gets aNotificationsSummary
which lists the number of unread and expired notifications for the current userint
Deprecated.Gets the the number of notifications for the user that have not been marked as read.void
markNotificationAsRead
(Long notificationId_) Deprecated.Marks a notification as read.void
markNotificationsAsRead
(Long[] notificationIds_) Deprecated.Marks a list of notifications as read.void
Deprecated.Sends a notification.void
notifyWithExcludedUsers
(String[] users_, Long[] groups_, String[] excludedUsers_, String appName_, String ntfType_, Map attributes_) Deprecated.Sends a notification, allowing certain users to be excluded from receiving the notification.void
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.void
Deprecated.void
updateUsernames
(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated.validate()
Deprecated.Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation resultsvalidateDatabase
(int thoroughness_) Deprecated.Performs validation on the database(s) associated with this service.Methods inherited from interface com.appiancorp.services.ContextSensitiveSingletonService
configureContextSensitiveSingletonService
-
Field Details
-
SORT_NOTIFICATION_ORDER_ASCENDING
Deprecated.A constant sort order for notification - sort in ascending order -
SORT_NOTIFICATION_ORDER_DESCENDING
Deprecated.A constant sort order for notification - sort in descending order -
PORTAL_NOTIFICATION_APPLICATION
Deprecated.A constant for the Portal application This is used to send portal notifications- See Also:
-
PERSONALIZATION_NOTIFICATION_APPLICATION
Deprecated.A constant for the Personalization application This is used to send personalization notification- See Also:
-
COLLABORATION_NOTIFICATION_APPLICATION
Deprecated.A constant for the Collaboration application This is used to send notifications within collaboration- See Also:
-
FORUM_NOTIFICATION_APPLICATION
Deprecated.A constant for the Forums application- See Also:
-
PROCESS_NOTIFICATION_APPLICATION
Deprecated.A constant for the Process application This is used to send process notification- See Also:
-
TEMPO_NOTIFICATION_APPLICATION
Deprecated.A constant for the Tempo application- See Also:
-
TASKS_NOTIFICATION_APPLICATION
Deprecated.A constant for the Tasks application- See Also:
-
FEED_NOTIFICATION_APPLICATION
Deprecated.A constant for the Feeds application- See Also:
-
FORUM_THREAD_SUBSCRIBE_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the forum and thread subscribe notification type This is used to send forum subscription notification- See Also:
-
FORUM_THREAD_INVITE_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the forum and thread invitation notification type This is used to send forum and thread inivitation notification- See Also:
-
FORUM_THREAD_ACCEPT_INVITE_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the forum and thread invitation acceptance notification type This is used to send acceptances of forum and thread invitations- See Also:
-
FORUM_THREAD_DECLINE_INVITE_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the forum and thread invitation declination notification type This is used to send declinations of forum and thread invitation- See Also:
-
FORUM_THREAD_SENT_LINK_NOTIFICATION_TYPE
Deprecated.A constants corresponding to the forum and thread send link notification type This is used to send send a link to a forum or thread- See Also:
-
GROUP_MEMBERSHIP_REQUESTED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group membership request notification type This is used to send a notification of a group membership request- See Also:
-
GROUP_MEMBERSHIP_REMOVED_NOTIFICATION_TYPE
Deprecated.A constants corresponding to the group membership removal notification type This is used to send a group removal notification- See Also:
-
GROUP_INVITATION_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group invitation notification type This is used to send a group invitation notification- See Also:
-
GROUP_MEMBERSHIP_APPROVED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group membership approved notification type This is used to send an invitation of an approved group membership- See Also:
-
GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group membership denied notification type This is used to send a notification of a denial of group membership- See Also:
-
GROUP_INVITATION_ACCEPTED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group invitation acceptance notification type This is used to send a notification of acceptance to a group invitation- See Also:
-
GROUP_INVITATION_DECLINED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the group invitation declination notification type This is used to send a notification of a declination to a group invitation- See Also:
-
PORTAL_SEND_LINK_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal send link notification type This is used to send a link within portal- See Also:
-
PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal send feedback notification type This is used to send a feedback notification- See Also:
-
PORTAL_SYSTEM_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal system notification type This is used to send a portal system notification- See Also:
-
PORTAL_PAGE_APPROVAL_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal page approval notification type This is used to send a notification for page approvals- See Also:
-
PORTAL_PAGE_APPROVAL_REQUEST_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal page approval request notification type This is used to send a notification for page approval requests- See Also:
-
PORTAL_PAGE_ACCESS_REMOVAL_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the portal page membership removal notification type This is used to send a notification for page membership removal- See Also:
-
COLLABORATION_SEND_LINK_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration send link notification type This is used to send a notification for links to documents in collaboration- See Also:
-
COLLABORATION_ACCESS_APPROVED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration access approved notification type This is used to send a notification of access approved for a knowledge center in collaboration- See Also:
-
COLLABORATION_ACCESS_DENIED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration access denied notification type This is used to send a notification of access denied to a a knowledge center in collaboration- See Also:
-
COLLABORATION_ACCESS_REQUEST_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration access requested notification type This is used to send a notification of requested access to a knowledge center in collaboration- See Also:
-
COLLABORATION_APPROVED_CHANGES_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration changes approved notification type This is used to send a notification of changes to a document approved in collaboration. When possible, useContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...)
instead.- See Also:
-
COLLABORATION_DENIED_CHANGES_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration changes denied notification type This is used to send a notification of denial of changes to a document in collaboration. When possible, useContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...)
instead.- See Also:
-
COLLABORATION_REQUEST_CHANGES_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration request changes notification type This is used to send a notification to request approval of changes to a document in collaboration- See Also:
-
COLLABORATION_EXPIRING_FILES_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration file expiration notification type This is used to send a notification of expiring files in collaboration- See Also:
-
COLLABORATION_INVITATION_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration invitation notification type This is used to send a notification of an invitation to a knowledge center in collaboration- See Also:
-
COLLABORATION_INVITATION_ACCEPTED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration invitation accepted notification type This is used to send a notification of acceptance of an invitation to a knowledge center in collaboration- See Also:
-
COLLABORATION_INVITATION_DECLINED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration invitation declined notification type This is used to send a notification of declination of an invitation to a knowledge center in collaboration- See Also:
-
COLLABORATION_EXPORT_COMPLETED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration export completed notification type This is used to send a notification when an export operation has completed- See Also:
-
COLLABORATION_IMPORT_COMPLETED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the collaboration import completed notification type This is used to send a notification when an import operation has completed- See Also:
-
PROCESS_TASK_ESCALATED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the process task escalated notification type This is sent when to when a task has been escalated- See Also:
-
PROCESS_SUB_LINK_REPUBLISHED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "sub or linked process republished" notification type This is sent when to the parent process model owners when a sub- or linked process model is published- See Also:
-
PROCESS_PARENT_CAUSES_PUBLISH_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "parent process causes sub process to be published" notification type This is used to send a notification when the publishing of a parent process model causes its sub- or linked process models to be published- See Also:
-
PROCESS_SUB_LINK_DISABLED_DELETED_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "sub or link process model disabled" notification type This is used to send a notification when a sub or linked process is disabled or deleted- See Also:
-
PROCESS_NEW_TASK_ME_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "New Task Assigned to Me" notification type This is used to send a notification when a user has a new task assigned to them- See Also:
-
PROCESS_NEW_TASK_OTHERS_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "New Task Assigned to Others" notification type This is used to send a notification to a user when a task has been assigned to the user and to others- See Also:
-
PROCESS_EXCEPTION_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the process exception notification type This is used to send a notification when an exception has occurred in a process- See Also:
-
PROCESS_MODEL_EXCEPTION_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the process model exception notification type This is used to send a notification when an exception has occurred in a process model- See Also:
-
PROCESS_TASK_EXCEPTION_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the task exception notification type This is used to send a notification when an exception has occurred in a task- See Also:
-
PROCESS_SUB_LINK_CANNOT_DELETE_CANCEL_NOTIFICATION_TYPE
Deprecated.A constant corresponding to the "Cannot delete or Cancel sub or linked process" notification type This is used to send a notification when a user tries to delete or cancel a parent process containing sub- or linked processes that he cannot cancel due to permissions- See Also:
-
TEMPO_MESSAGE_POSTED
Deprecated.A constant corresponding to the "New message sent to you" notification type. This is used to send a notification when someone posts a message targeted to a user explicitly (but not necessarily exclusively).- See Also:
-
TEMPO_GROUP_MESSAGE_POSTED
Deprecated.A constant corresponding to the "New group message posted" notification type. This is used to send a notification when someone posts a message targeted to a group that the recipient is a member of.- See Also:
-
TEMPO_COMMENT_ON_MESSAGE
Deprecated.TEMPO_COMMENT_ON_MESSAGE_TO_GROUP
is now used for messages to users, groups and everyoneA constant corresponding to the "New comment on your message to everyone" notification type. This is used to send a notification when someone other than the recipient writes a comment on a message that the recipient posted.- See Also:
-
TEMPO_COMMENT_ON_MESSAGE_TO_GROUP
Deprecated.A constant corresponding to the "New comment on your message" notification type. This is used to send a notification when when someone other than the recipient writes a comment on a message that the recipient posted to a group.- See Also:
-
TEMPO_COMMENT_ON_POST_TO_FOLLOWERS
Deprecated.A constant corresponding to the "New comment on your post" notification type. This is used to send a notification when someone other than the recipient writes a comment on a post that the recipient made.- See Also:
-
TEMPO_COMMENT_ON_MESSAGE_COMMENTED_ON
Deprecated.A constant corresponding to the "New comment on a post or message that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a message that the recipient had previously also commented on or starred.- See Also:
-
TEMPO_POST_ATTRIBUTED_TO_YOU
Deprecated.A constant corresponding to the "New event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event.- See Also:
-
TEMPO_COMMENT_ON_POST
Deprecated.A constant corresponding to the "New comment on an event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event and another user posts a comment to the feed entry.- See Also:
-
TEMPO_HAZARD_ON_POST
Deprecated.A constant corresponding to the "New hazard on an event attributed to you" notification type. This is used to send a notification when the recipient is listed as the actor for a Tempo event and a hazard is posted to the feed entry.- See Also:
-
TEMPO_COMMENT_ON_POST_COMMENTED_ON
Deprecated.A constant corresponding to the "New comment on an event that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a feed entry that the recipient had previously also commented on or starred.- See Also:
-
TEMPO_HAZARD_ON_POST_COMMENTED_ON
Deprecated.A constant corresponding to the "New hazard on an event that you have commented on" notification type. This is used to send a notification when a hazard is posted to a feed entry that the recipient has commented on or starred.- See Also:
-
TEMPO_COMMENT_ON_SYSTEM_POST_COMMENTED_ON
Deprecated.A constant corresponding to the "New comment on a system event that you have commented on" notification type. This is used to send a notification when someone other than the recipient writes a comment on a system event feed entry that the recipient had previously also commented on or starred.- See Also:
-
TEMPO_HAZARD_ON_SYSTEM_POST_COMMENTED_ON
Deprecated.A constant corresponding to the "New hazard on a system event that you have commented on" notification type. This is used to send a notification when a hazard is posted to a system event feed entry that the recipient has commented on or starred.- See Also:
-
TEMPO_RECEIVED_KUDOS
Deprecated.A constant corresponding to the "New kudos given to you" notification type. This is used to send a notification when the recipient gets a kudos- See Also:
-
TEMPO_COMMENT_ON_GIVEN_KUDOS
Deprecated.A constant corresponding to the "New comment on a kudos that you gave" notification type. This is used to send a notification when someone other than the author writes a comment on a kudos.- See Also:
-
TEMPO_COMMENT_ON_RECEIVED_KUDOS
Deprecated.A constant corresponding to the "New comment on a kudos that you received" notification type. This is used to send a notification when someone other than the recipient writes a comment on a kudos.- See Also:
-
TEMPO_COMMENT_ON_KUDOS_COMMENTED_ON
Deprecated.A constant corresponding to the "New comment on a kudos that you have commented on or starred" notification type. This is used to send a notification when someone other than the author or recipient writes a comment on a kudos that the recipient commented on or starred.- See Also:
-
TEMPO_PARTICIPANT_ADDED
Deprecated.You have been added as a participant- See Also:
-
TEMPO_GROUP_PARTICIPANT_ADDED
Deprecated.Group has been added as a participant- See Also:
-
TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY
Deprecated.Participants added to your feed entry- See Also:
-
TASKS_COMMENT_ON_SOCIAL_TASK_SENT_TO_YOU
Deprecated.A constant corresponding to the "New comment on a social task that was sent to you" notification type. This is used to send a notification when there is a new comment on a social task.- See Also:
-
TASKS_COMMENT_ON_SOCIAL_TASK_SENT_BY_YOU
Deprecated.A constant corresponding to the "New comment on a social task that was sent by you" notification type. This is used to send a notification when there is a new comment on a social task.- See Also:
-
TASKS_SOCIAL_TASK_SENT_TO_YOU_CLOSED
Deprecated.A constant corresponding to the "A social task that was sent to you was closed" notification type. This is used to send a notification when a social task is closed.- See Also:
-
TASKS_SOCIAL_TASK_SENT_BY_YOU_CLOSED
Deprecated.A constant corresponding to the "A social task that was sent by you was closed" notification type. This is used to send a notification when a social task is closed.- See Also:
-
getNotifications$UPDATES
static final boolean getNotifications$UPDATESDeprecated.- See Also:
-
getNotificationsByApplicationAndType$UPDATES
static final boolean getNotificationsByApplicationAndType$UPDATESDeprecated.- See Also:
-
getNotificationsByApplication$UPDATES
static final boolean getNotificationsByApplication$UPDATESDeprecated.- See Also:
-
deleteNotification$UPDATES
static final boolean deleteNotification$UPDATESDeprecated.- See Also:
-
deleteNotifications$UPDATES
static final boolean deleteNotifications$UPDATESDeprecated.- See Also:
-
deleteNotificationsBeforeTimestamp$UPDATES
static final boolean deleteNotificationsBeforeTimestamp$UPDATESDeprecated.- See Also:
-
getUnreadNotificationsCount$UPDATES
static final boolean getUnreadNotificationsCount$UPDATESDeprecated.- See Also:
-
getNotificationsSummary$UPDATES
static final boolean getNotificationsSummary$UPDATESDeprecated.- See Also:
-
deleteExpiredNotifications$UPDATES
static final boolean deleteExpiredNotifications$UPDATESDeprecated.- See Also:
-
markNotificationAsRead$UPDATES
static final boolean markNotificationAsRead$UPDATESDeprecated.- See Also:
-
markNotificationsAsRead$UPDATES
static final boolean markNotificationsAsRead$UPDATESDeprecated.- See Also:
-
notify$UPDATES
static final boolean notify$UPDATESDeprecated.- See Also:
-
notifyWithExcludedUsers$UPDATES
static final boolean notifyWithExcludedUsers$UPDATESDeprecated.- See Also:
-
getNotificationsPaging$UPDATES
static final boolean getNotificationsPaging$UPDATESDeprecated.- See Also:
-
getNotification$UPDATES
static final boolean getNotification$UPDATESDeprecated.- See Also:
-
updateUsernames$UPDATES
static final boolean updateUsernames$UPDATESDeprecated.- See Also:
-
commitUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATESDeprecated.- See Also:
-
rollbackUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATESDeprecated.- See Also:
-
reloadProperties$UPDATES
static final boolean reloadProperties$UPDATESDeprecated.- See Also:
-
validate$UPDATES
static final boolean validate$UPDATESDeprecated.- See Also:
-
validateDatabase$UPDATES
static final boolean validateDatabase$UPDATESDeprecated.- See Also:
-
-
Method Details
-
getNotifications
@Deprecated Notification[] getNotifications(Integer sortOrder_, Integer sortType_, int startIndex_, int count_) Deprecated.use getNotificationsPaging insteadGets a list of notifications that the current user has received in the portal medium. To get the complete list use getNotifications(...,...,0,-1);- Parameters:
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending ordersortType_
- notification type used for sorting (see SORT_NOTIFICATION_PROPERTY constants in this class)startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.count_
- the number of results to return. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.- Returns:
- An array of
Notification
objects - Throws:
ServiceException
- if any system-level error occurs
-
getNotificationsByApplicationAndType
Deprecated.Gets the list of notifications matching the specified Application and Notification Type- Parameters:
appName_
- application name used for matching. seeXXX_NOTIFICATION_APPLICATION
constants in this class for options.notificationType_
- notification type used for matching. seeXXX_NOTIFICATION_TYPE
in this class for options.- Returns:
- an array of
Notification
objects matching the specified types and application - Throws:
ServiceException
- if any system-level error occurs
-
getNotificationsByApplication
Deprecated.Gets a list of notifications matching Application name- Parameters:
appName_
- application name used for matching seeXXX_NOTIFICATION_APPLICATION
constants in this class for options.- Returns:
- an array of
Notification
objects matching the specified application - Throws:
ServiceException
- if any system-level error occurs
-
deleteNotification
Deprecated.Delete a notification- Parameters:
notificationId_
- the id of the notification to delete- Throws:
InvalidNotificationException
- if the notification id does not existServiceException
- if any system-level error occurs
-
deleteNotifications
Deprecated.Delete a list of notifications- Parameters:
notificationIds_
- the ids of the notifications to delete- Throws:
InvalidNotificationException
- if one or more of the notification IDs do not existServiceException
- if any system-level error occurs
-
deleteNotificationsBeforeTimestamp
Deprecated.Deletes all notifications for the current user before the given timestamp.- Parameters:
timestamp
- The time up to when all the notifications will be deleted.- Throws:
ServiceException
- if any system-level error occurs
-
getUnreadNotificationsCount
int getUnreadNotificationsCount()Deprecated.Gets the the number of notifications for the user that have not been marked as read.- Throws:
ServiceException
- if any system-level error occurs- See Also:
-
getNotificationsSummary
NotificationsSummary getNotificationsSummary()Deprecated.Gets aNotificationsSummary
which lists the number of unread and expired notifications for the current user- Returns:
- the
NotificationsSummary
listing the number of unread and expired notifications for the current user - Throws:
ServiceException
- if any system-level error occurs- See Also:
-
deleteExpiredNotifications
void deleteExpiredNotifications()Deprecated.Deletes all expired notifications for the current user- Throws:
ServiceException
- if any system-level error occurs
-
markNotificationAsRead
Deprecated.Marks a notification as read. This affects the value returned bygetUnreadNotificationsCount()
- Parameters:
notificationId_
- the ids of the notifications to mark as read- Throws:
InvalidNotificationException
- if the notification id does not existServiceException
- if any system-level error occurs- See Also:
-
markNotificationsAsRead
Deprecated.Marks a list of notifications as read. This affects the value returned bygetUnreadNotificationsCount()
- Parameters:
notificationIds_
- the ids of the notifications to mark as read- Throws:
InvalidNotificationException
- if one or more of the notification IDs do not existServiceException
- if any system-level error occurs- See Also:
-
notify
void notify(String[] users_, Long[] groups_, String appName_, String ntfType_, Map attributes_) throws InvalidNotificationTypeException, IllegalArgumentException Deprecated.Sends a notification. Below all the custom attributes for each notification type are listed by application.Discussion Topics Application - 1.
FORUM_THREAD_SUBSCRIBE_NOTIFICATION_TYPE
has attributes: "url", "message subject", "thread message count", "last Modified time of thread" and "thread creator" 2.FORUM_THREAD_INVITE_NOTIFICATION_TYPE
has attributes: "sender", "threadId", "threadName" and "message" 3.FORUM_THREAD_ACCEPT_INVITE_NOTIFICATION_TYPE
has attributes: "sender", "threadId", "threadName" and "message" 4.FORUM_THREAD_DECLINE_INVITE_NOTIFICATION_TYPE
has attributes: "sender", "threadId", "threadName" and "message" 5.FORUM_THREAD_SENT_LINK_NOTIFICATION_TYPE
has attributes: "sender", "threadId", "threadName", and "message" Personalization Application- 1.GROUP_MEMBERSHIP_REQUESTED_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status" and "message". 2.GROUP_MEMBERSHIP_REMOVED_NOTIFICATION_TYPE
has attributes: "senderName", "senderId", "groupName", "groupId", "status", and "message". 3.GROUP_INVITATION_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status", and "message". 4.GROUP_MEMBERSHIP_APPROVED_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status", and "message". 5.GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status", and "message". 6.GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status", and "message". 7.GROUP_INVITATION_DECLINED_NOTIFICATION_TYPE
has attributes: "senderName", "groupName", "groupId", "status", and "message". Portal Application - 1.PORTAL_SEND_LINK_NOTIFICATION_TYPE
has attributes: "sender", "url", "message" and "page name" 2.PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE
has attributes: "sender", "url", "message" and "page name" 3.PORTAL_PAGE_APPROVAL_NOTIFICATION_TYPE
has attributes: "sender", "url", "message", "page name" and "subType" 4.PORTAL_SYSTEM_NOTIFICATION_TYPE
has attributes: "sender" and "message" 5.PORTAL_PAGE_APPROVAL_REQUEST_NOTIFICATION_TYPE
has attributes: "sender" and "page name" and "page id" 6.PortalNotifcationService#PORTAL_PAGE_ACCESS_REMOVAL_NOTIFICATION_TYPE
has attributes: "sender" and "page name" Collaboration Application - 1.COLLABORATION_SEND_LINK_NOTIFICATION_TYPE
has attributes: "sender", "document id", "document extension", "knowledgecenter name" and "message" 2.COLLABORATION_ACCESS_APPROVED_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "knowledgecenter id" and "time sent" 3.COLLABORATION_ACCESS_DENIED_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "knowledgecenter id" and "time sent" 4.COLLABORATION_ACCESS_REQUEST_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "type", "knowledgecenter id", and "number" 5.COLLABORATION_APPROVED_CHANGES_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "document name" and "knowledgecenter id" 6.COLLABORATION_DENIED_CHANGES_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "document name" and "knowledgecenter id" 7.COLLABORATION_REQUEST_CHANGES_NOTIFICATION_TYPE
has attributes: "sender", "community name", "knowledgecenter name", "type", "id", "name" and "number" 8.COLLABORATION_EXPIRING_FILES_NOTIFICATION_TYPE
has attributes: "community name", "knowledgecenter name", "type", "id" and "number" 9.COLLABORATION_INVITATION_NOTIFICATION_TYPE
has attributes: "sender", "knowledgecenter name", "knowledgecenter id", and "message" 10.COLLABORATION_INVITATION_ACCEPTED_NOTIFICATION_TYPE
has attributes: "sender", "knowledgecenter name", "knowledgecenter id", and "message" 11.COLLABORATION_INVITATION_DECLINED_NOTIFICATION_TYPE
has attributes: "sender", "knowledgecenter name", "knowledgecenter id", and "message" 12.COLLABORATION_EXPORT_COMPLETED_NOTIFICATION_TYPE
has attributes: "docId", "docName", "folderId", "folderName", "exportedCount", "expectedCount" and "failedCount 13.COLLABORATION_IMPORT_COMPLETED_NOTIFICATION_TYPE
has attributes: "docName", "importedCount", "expectedCount" and "failedCount" Process Application - 1.PROCESS_TASK_ESCALATED_NOTIFICATION_TYPE
has attributes: "task name", "task id", "process name", "process id", "server id", and "message" 2.PROCESS_SUB_LINK_REPUBLISHED_NOTIFICATION_TYPE
has attributes: "processModelName", "processModelId", "user", "affectedProcessModelName", and "affectedProcessModelId" 3.PROCESS_PARENT_CAUSES_PUBLISH_NOTIFICATION_TYPE
has attributes: "processModelName", "processModelId", "user", "affectedProcessModelName", "affectedProcessModelId" 4.PROCESS_SUB_LINK_DISABLED_DELETED_NOTIFICATION_TYPE
has attributes: "action", "processModelName", "processModelId", "user", "affectedProcessModelName", "affectedProcessModelId" 5.PROCESS_NEW_TASK_ME_NOTIFICATION_TYPE
has attributes: "taskName", "taskId", "processName", "processId", "priority", "dateAssigned", "status" 6.PROCESS_NEW_TASK_OTHERS_NOTIFICATION_TYPE
has attributes: "taskName", "taskId", "processName", "processId", "priority", "dateAssigned", "status" 7.PROCESS_EXCEPTION_NOTIFICATION_TYPE
has attributes: "serverId", "processName", "processId", "priority", "dateOccurred", "problemDescription", "recommendedAction", "message", "subject" 8.PROCESS_TASK_EXCEPTION_NOTIFICATION_TYPE
has attributes: "serverId", "taskName", "taskId", "processName", "processId", "priority", "dateOccurred", "problemDescription", "recommendedAction", "message" 9.PROCESS_SUB_LINK_CANNOT_DELETE_CANCEL_NOTIFICATION_TYPE
has attributes: "action", "processName", "processId", "user", "subProcessNames", "subProcessIds"- Parameters:
users_
- the users to send the notification togroups_
- the groups to send the notification toappName_
- application sending the notification. seeXXX_NOTIFICATION_APPLICATION
constants in this class for options.ntfType_
- notification type to send. seeXXX_NOTIFICATION_TYPE
in this class for options.attributes_
- The map keys correspond to attributes (such as sender) which will be used to render the notification. The values of the keys are the values to be displayed in the notification (eg. the sender's username). See above for necessary items.- Throws:
InvalidNotificationTypeException
- if ntfType_ is invalidIllegalArgumentException
- if appName_ is invalidServiceException
- if any system-level error occurs
-
notifyWithExcludedUsers
void notifyWithExcludedUsers(String[] users_, Long[] groups_, String[] excludedUsers_, String appName_, String ntfType_, Map attributes_) throws InvalidNotificationTypeException, IllegalArgumentException Deprecated.Sends a notification, allowing certain users to be excluded from receiving the notification. This makes it possible to send a notification to all users in a group except for certain users.- Parameters:
users_
- the users to send the notification togroups_
- the groups to send the notification toexcludedUsers_
- the users to which the notification should not be sentappName_
- application sending the notification. seeXXX_NOTIFICATION_APPLICATION
constants in this class for options.ntfType_
- notification type to send. seeXXX_NOTIFICATION_TYPE
in this class for options.attributes_
- The map keys correspond to attributes (such as sender) which will be used to render the notification. The values of the keys are the values to be displayed in the notification (eg. the sender's username). Seenotify(String[] users_, Long[] groups_, String appName_, String ntfType_, Map attributes_)
for necessary items.- Throws:
InvalidNotificationTypeException
- if ntfType_ is invalidIllegalArgumentException
- if appName_ is invalidServiceException
- if any system-level error occurs
-
getNotificationsPaging
ResultPage getNotificationsPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets a the notifications that the current user has received in the portal medium.- Parameters:
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 ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inNotification
. Those useable are: SORT_BY_READ, SORT_BY_APPLICATION, SORT_BY_TIMESTAMPsortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing the list ofNotification
objectss that the current user has received in the portal medium. - Throws:
ServiceException
- if any system-level error occurs
-
getNotification
Deprecated.Gets a notification- Parameters:
notifId_
- the id of the notification to retrieve- Returns:
- the
Notification
with the id specificed returns null if the notification does not exist - Throws:
ServiceException
- if any system-level error occurs
-
updateUsernames
@Deprecated void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, DuplicateNameException Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Updates a list of old usernames to new usernames.If successful, this method must be followed by
commitUpdateUsernames()
. AftercommitUpdateUsernames
has been called, the old usernames will still be active, but will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifupdateUsernames
is successful butcommitUpdateUsernames
is not called, the new usernames will not become active.If unsuccessful, this method should be followed by
rollbackUpdateUsernames()
. This will simply free memory dedicated to mapping old usernames to new usernames.- Parameters:
oldUsernames_
- the usernames to be updatednewUsernames_
- the usernames to which the old usernames will be updatedmaxExpirationTimeInSeconds_
- the interval, in seconds, aftercommitUpdateUsernames
has been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.- Throws:
IllegalArgumentException
- if the length ofoldUsernames_
is not the same as the length ofnewUsernames_
.DuplicateNameException
- if anyoldUsernames_
ornewUsernames_
contain any duplicates.ServiceException
- if any system-level error occurs
-
commitUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Commits an update of usernames.This method should be preceded by a call to
updateUsernames(String[], String[], long)
. After the commit, the old usernames will be temporarily active, and will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifcommitUpdateUsernames
is not called, the new usernames will not become active.- Throws:
ServiceException
- if any system-level error occurs
-
rollbackUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Rolls back an update of usernames.This method should be called if
updateUsernames(String[], String[], long)
is unsuccessful. The rollback will simply free memory dedicated to mapping old usernames to new usernames.- Throws:
ServiceException
- if any system-level error occurs
-
reloadProperties
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.Reloads all database-level properties files (*.xml, *.properties) without interrupting API services- Throws:
ServiceException
- if any system-level error occurs
-
validate
String validate()Deprecated.Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results- Returns:
- the validation results
- Throws:
ServiceException
- if any system-level error occurs
-
validateDatabase
Deprecated.Performs validation on the database(s) associated with this service.- Parameters:
thoroughness_
- indicates the level of thoroughness of the query. Values areDatabaseStatus.QUICK
andDatabaseStatus.SLOW
- Returns:
- a
DatabaseStatus
object encapsulating the results of the validation query.
-