com.appiancorp.suiteapi.portal

Interface PortalNotificationService

All Superinterfaces:

ContextSensitiveSingletonService, Service

Deprecated.

The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public interface PortalNotificationService
extends ContextSensitiveSingletonService

Defines service methods used to access notifications received through the Portal. Portal registers itself with the Notification framework as one of the possible output media. Notifications sent to the Portal medium because of default settings or explicit rules can be retrieved through this 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.

See Also:

AdministrationService, NotificationService, PageNavigationService, PageService, PortalSearchService, PortletService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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.
static java.lang.String	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.
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	COLLABORATION_NOTIFICATION_APPLICATION Deprecated. A constant for the Collaboration application This is used to send notifications within collaboration
static java.lang.String	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
static java.lang.String	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
static boolean	commitUpdateUsernames$UPDATES Deprecated.
static boolean	deleteExpiredNotifications$UPDATES Deprecated.
static boolean	deleteNotification$UPDATES Deprecated.
static boolean	deleteNotifications$UPDATES Deprecated.
static boolean	deleteNotificationsBeforeTimestamp$UPDATES Deprecated.
static java.lang.String	FEED_NOTIFICATION_APPLICATION Deprecated. A constant for the Feeds application
static java.lang.String	FORUM_NOTIFICATION_APPLICATION Deprecated. A constant for the Forums application
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static boolean	getNotification$UPDATES Deprecated.
static boolean	getNotifications$UPDATES Deprecated.
static boolean	getNotificationsByApplication$UPDATES Deprecated.
static boolean	getNotificationsByApplicationAndType$UPDATES Deprecated.
static boolean	getNotificationsPaging$UPDATES Deprecated.
static boolean	getNotificationsSummary$UPDATES Deprecated.
static boolean	getUnreadNotificationsCount$UPDATES Deprecated.
static java.lang.String	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
static java.lang.String	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
static java.lang.String	GROUP_INVITATION_NOTIFICATION_TYPE Deprecated. A constant corresponding to the group invitation notification type This is used to send a group invitation notification
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static boolean	markNotificationAsRead$UPDATES Deprecated.
static boolean	markNotificationsAsRead$UPDATES Deprecated.
static boolean	notify$UPDATES Deprecated.
static boolean	notifyWithExcludedUsers$UPDATES Deprecated.
static java.lang.String	PERSONALIZATION_NOTIFICATION_APPLICATION Deprecated. A constant for the Personalization application This is used to send personalization notification
static java.lang.String	PORTAL_NOTIFICATION_APPLICATION Deprecated. A constant for the Portal application This is used to send portal notifications
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE Deprecated. A constant corresponding to the portal send feedback notification type This is used to send a feedback notification
static java.lang.String	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
static java.lang.String	PORTAL_SYSTEM_NOTIFICATION_TYPE Deprecated. A constant corresponding to the portal system notification type This is used to send a portal system notification
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	PROCESS_NOTIFICATION_APPLICATION Deprecated. A constant for the Process application This is used to send process notification
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static java.lang.String	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
static boolean	reloadProperties$UPDATES Deprecated.
static boolean	rollbackUpdateUsernames$UPDATES Deprecated.
static java.lang.Integer	SORT_NOTIFICATION_ORDER_ASCENDING Deprecated. A constant sort order for notification - sort in ascending order
static java.lang.Integer	SORT_NOTIFICATION_ORDER_DESCENDING Deprecated. A constant sort order for notification - sort in descending order
static java.lang.String	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.
static java.lang.String	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.
static java.lang.String	TASKS_NOTIFICATION_APPLICATION Deprecated. A constant for the Tasks application
static java.lang.String	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.
static java.lang.String	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.
static java.lang.String	TEMPO_COMMENT_ON_GIVEN_KUDOS Deprecated. A constant corresponding to the "New comment on a kudos that you gave" notification type.
static java.lang.String	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.
static java.lang.String	TEMPO_COMMENT_ON_MESSAGE Deprecated. TEMPO_COMMENT_ON_MESSAGE_TO_GROUP is now used for messages to users, groups and everyone
static java.lang.String	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.
static java.lang.String	TEMPO_COMMENT_ON_MESSAGE_TO_GROUP Deprecated. A constant corresponding to the "New comment on your message" notification type.
static java.lang.String	TEMPO_COMMENT_ON_POST Deprecated. A constant corresponding to the "New comment on an event attributed to you" notification type.
static java.lang.String	TEMPO_COMMENT_ON_POST_COMMENTED_ON Deprecated. A constant corresponding to the "New comment on an event that you have commented on" notification type.
static java.lang.String	TEMPO_COMMENT_ON_POST_TO_FOLLOWERS Deprecated. A constant corresponding to the "New comment on your post" notification type.
static java.lang.String	TEMPO_COMMENT_ON_RECEIVED_KUDOS Deprecated. A constant corresponding to the "New comment on a kudos that you received" notification type.
static java.lang.String	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.
static java.lang.String	TEMPO_GROUP_MESSAGE_POSTED Deprecated. A constant corresponding to the "New group message posted" notification type.
static java.lang.String	TEMPO_GROUP_PARTICIPANT_ADDED Deprecated. Group has been added as a participant
static java.lang.String	TEMPO_HAZARD_ON_POST Deprecated. A constant corresponding to the "New hazard on an event attributed to you" notification type.
static java.lang.String	TEMPO_HAZARD_ON_POST_COMMENTED_ON Deprecated. A constant corresponding to the "New hazard on an event that you have commented on" notification type.
static java.lang.String	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.
static java.lang.String	TEMPO_MESSAGE_POSTED Deprecated. A constant corresponding to the "New message sent to you" notification type.
static java.lang.String	TEMPO_NOTIFICATION_APPLICATION Deprecated. A constant for the Tempo application
static java.lang.String	TEMPO_PARTICIPANT_ADDED Deprecated. You have been added as a participant
static java.lang.String	TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY Deprecated. Participants added to your feed entry
static java.lang.String	TEMPO_POST_ATTRIBUTED_TO_YOU Deprecated. A constant corresponding to the "New event attributed to you" notification type.
static java.lang.String	TEMPO_RECEIVED_KUDOS Deprecated. A constant corresponding to the "New kudos given to you" notification type.
static boolean	updateUsernames$UPDATES Deprecated.
static boolean	validate$UPDATES Deprecated.
static boolean	validateDatabase$UPDATES Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

CONFIGURE_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
void	commitUpdateUsernames() Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
void	deleteExpiredNotifications() Deprecated. Deletes all expired notifications for the current user
void	deleteNotification(java.lang.Long notificationId_) Deprecated. Delete a notification
void	deleteNotifications(java.lang.Long[] notificationIds_) Deprecated. Delete a list of notifications
void	deleteNotificationsBeforeTimestamp(java.sql.Timestamp timestamp) Deprecated. Deletes all notifications for the current user before the given timestamp.
Notification	getNotification(java.lang.Long notifId_) Deprecated. Gets a notification
Notification[]	getNotifications(java.lang.Integer sortOrder_, java.lang.Integer sortType_, int startIndex_, int count_) Deprecated. use getNotificationsPaging instead
Notification[]	getNotificationsByApplication(java.lang.String appName_) Deprecated. Gets a list of notifications matching Application name
Notification[]	getNotificationsByApplicationAndType(java.lang.String appName_, java.lang.String notificationType_) Deprecated. Gets the list of notifications matching the specified Application and Notification Type
ResultPage	getNotificationsPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) Deprecated. Gets a the notifications that the current user has received in the portal medium.
NotificationsSummary	getNotificationsSummary() Deprecated. Gets a NotificationsSummary which lists the number of unread and expired notifications for the current user
int	getUnreadNotificationsCount() Deprecated. Gets the the number of notifications for the user that have not been marked as read.
void	markNotificationAsRead(java.lang.Long notificationId_) Deprecated. Marks a notification as read.
void	markNotificationsAsRead(java.lang.Long[] notificationIds_) Deprecated. Marks a list of notifications as read.
void	notify(java.lang.String[] users_, java.lang.Long[] groups_, java.lang.String appName_, java.lang.String ntfType_, java.util.Map attributes_) Deprecated. Sends a notification.
void	notifyWithExcludedUsers(java.lang.String[] users_, java.lang.Long[] groups_, java.lang.String[] excludedUsers_, java.lang.String appName_, java.lang.String ntfType_, java.util.Map attributes_) Deprecated. Sends a notification, allowing certain users to be excluded from receiving the notification.
void	reloadProperties() Deprecated. reloading properties is now automatic, so this call is now unnecessary and does nothing.
void	rollbackUpdateUsernames() Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
void	updateUsernames(java.lang.String[] oldUsernames_, java.lang.String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
java.lang.String	validate() Deprecated. Runs validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results
DatabaseStatus	validateDatabase(int thoroughness_) Deprecated. Performs validation on the database(s) associated with this service.

Methods inherited from interface com.appiancorp.services.ContextSensitiveSingletonService

configureContextSensitiveSingletonService

Field Detail

SORT_NOTIFICATION_ORDER_ASCENDING

static final java.lang.Integer SORT_NOTIFICATION_ORDER_ASCENDING

Deprecated.

A constant sort order for notification - sort in ascending order

SORT_NOTIFICATION_ORDER_DESCENDING

static final java.lang.Integer SORT_NOTIFICATION_ORDER_DESCENDING

Deprecated.

A constant sort order for notification - sort in descending order

PORTAL_NOTIFICATION_APPLICATION

static final java.lang.String PORTAL_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Portal application This is used to send portal notifications

See Also:

Constant Field Values

PERSONALIZATION_NOTIFICATION_APPLICATION

static final java.lang.String PERSONALIZATION_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Personalization application This is used to send personalization notification

See Also:

Constant Field Values

COLLABORATION_NOTIFICATION_APPLICATION

static final java.lang.String COLLABORATION_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Collaboration application This is used to send notifications within collaboration

See Also:

Constant Field Values

FORUM_NOTIFICATION_APPLICATION

static final java.lang.String FORUM_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Forums application

See Also:

Constant Field Values

PROCESS_NOTIFICATION_APPLICATION

static final java.lang.String PROCESS_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Process application This is used to send process notification

See Also:

Constant Field Values

TEMPO_NOTIFICATION_APPLICATION

static final java.lang.String TEMPO_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Tempo application

See Also:

Constant Field Values

TASKS_NOTIFICATION_APPLICATION

static final java.lang.String TASKS_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Tasks application

See Also:

Constant Field Values

FEED_NOTIFICATION_APPLICATION

static final java.lang.String FEED_NOTIFICATION_APPLICATION

Deprecated.

A constant for the Feeds application

See Also:

Constant Field Values

FORUM_THREAD_SUBSCRIBE_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

FORUM_THREAD_INVITE_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

FORUM_THREAD_ACCEPT_INVITE_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

FORUM_THREAD_DECLINE_INVITE_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

FORUM_THREAD_SENT_LINK_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_MEMBERSHIP_REQUESTED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_MEMBERSHIP_REMOVED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_INVITATION_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_MEMBERSHIP_APPROVED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_MEMBERSHIP_DENIED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_INVITATION_ACCEPTED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

GROUP_INVITATION_DECLINED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_SEND_LINK_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_SEND_FEEDBACK_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_SYSTEM_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_PAGE_APPROVAL_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_PAGE_APPROVAL_REQUEST_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PORTAL_PAGE_ACCESS_REMOVAL_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_SEND_LINK_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_ACCESS_APPROVED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_ACCESS_DENIED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_ACCESS_REQUEST_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_APPROVED_CHANGES_NOTIFICATION_TYPE

static final java.lang.String 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, use ContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...) instead.

See Also:

Constant Field Values

COLLABORATION_DENIED_CHANGES_NOTIFICATION_TYPE

static final java.lang.String 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, use ContentService.notifyApproved(com.appiancorp.suiteapi.content.Approved...) instead.

See Also:

Constant Field Values

COLLABORATION_REQUEST_CHANGES_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_EXPIRING_FILES_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_INVITATION_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_INVITATION_ACCEPTED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_INVITATION_DECLINED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_EXPORT_COMPLETED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

COLLABORATION_IMPORT_COMPLETED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_TASK_ESCALATED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_SUB_LINK_REPUBLISHED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_PARENT_CAUSES_PUBLISH_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_SUB_LINK_DISABLED_DELETED_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_NEW_TASK_ME_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_NEW_TASK_OTHERS_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_EXCEPTION_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_MODEL_EXCEPTION_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_TASK_EXCEPTION_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

PROCESS_SUB_LINK_CANNOT_DELETE_CANCEL_NOTIFICATION_TYPE

static final java.lang.String 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:

Constant Field Values

TEMPO_MESSAGE_POSTED

static final java.lang.String 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:

Constant Field Values

TEMPO_GROUP_MESSAGE_POSTED

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_MESSAGE

@Deprecated
static final java.lang.String TEMPO_COMMENT_ON_MESSAGE

Deprecated. TEMPO_COMMENT_ON_MESSAGE_TO_GROUP is now used for messages to users, groups and everyone

A 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:

Constant Field Values

TEMPO_COMMENT_ON_MESSAGE_TO_GROUP

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_POST_TO_FOLLOWERS

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_MESSAGE_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_POST_ATTRIBUTED_TO_YOU

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_POST

static final java.lang.String 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:

Constant Field Values

TEMPO_HAZARD_ON_POST

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_POST_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_HAZARD_ON_POST_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_SYSTEM_POST_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_HAZARD_ON_SYSTEM_POST_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_RECEIVED_KUDOS

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_GIVEN_KUDOS

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_RECEIVED_KUDOS

static final java.lang.String 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:

Constant Field Values

TEMPO_COMMENT_ON_KUDOS_COMMENTED_ON

static final java.lang.String 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:

Constant Field Values

TEMPO_PARTICIPANT_ADDED

static final java.lang.String TEMPO_PARTICIPANT_ADDED

Deprecated.

You have been added as a participant

See Also:

Constant Field Values

TEMPO_GROUP_PARTICIPANT_ADDED

static final java.lang.String TEMPO_GROUP_PARTICIPANT_ADDED

Deprecated.

Group has been added as a participant

See Also:

Constant Field Values

TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY

static final java.lang.String TEMPO_PARTICIPANT_ADDED_TO_YOUR_ENTRY

Deprecated.

Participants added to your feed entry

See Also:

Constant Field Values

TASKS_COMMENT_ON_SOCIAL_TASK_SENT_TO_YOU

static final java.lang.String 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:

Constant Field Values

TASKS_COMMENT_ON_SOCIAL_TASK_SENT_BY_YOU

static final java.lang.String 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:

Constant Field Values

TASKS_SOCIAL_TASK_SENT_TO_YOU_CLOSED

static final java.lang.String 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:

Constant Field Values

TASKS_SOCIAL_TASK_SENT_BY_YOU_CLOSED

static final java.lang.String 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:

Constant Field Values

getNotifications$UPDATES

static final boolean getNotifications$UPDATES

Deprecated.

See Also:

Constant Field Values

getNotificationsByApplicationAndType$UPDATES

static final boolean getNotificationsByApplicationAndType$UPDATES

Deprecated.

See Also:

Constant Field Values

getNotificationsByApplication$UPDATES

static final boolean getNotificationsByApplication$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteNotification$UPDATES

static final boolean deleteNotification$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteNotifications$UPDATES

static final boolean deleteNotifications$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteNotificationsBeforeTimestamp$UPDATES

static final boolean deleteNotificationsBeforeTimestamp$UPDATES

Deprecated.

See Also:

Constant Field Values

getUnreadNotificationsCount$UPDATES

static final boolean getUnreadNotificationsCount$UPDATES

Deprecated.

See Also:

Constant Field Values

getNotificationsSummary$UPDATES

static final boolean getNotificationsSummary$UPDATES

Deprecated.

See Also:

Constant Field Values

deleteExpiredNotifications$UPDATES

static final boolean deleteExpiredNotifications$UPDATES

Deprecated.

See Also:

Constant Field Values

markNotificationAsRead$UPDATES

static final boolean markNotificationAsRead$UPDATES

Deprecated.

See Also:

Constant Field Values

markNotificationsAsRead$UPDATES

static final boolean markNotificationsAsRead$UPDATES

Deprecated.

See Also:

Constant Field Values

notify$UPDATES

static final boolean notify$UPDATES

Deprecated.

See Also:

Constant Field Values

notifyWithExcludedUsers$UPDATES

static final boolean notifyWithExcludedUsers$UPDATES

Deprecated.

See Also:

Constant Field Values

getNotificationsPaging$UPDATES

static final boolean getNotificationsPaging$UPDATES

Deprecated.

See Also:

Constant Field Values

getNotification$UPDATES

static final boolean getNotification$UPDATES

Deprecated.

See Also:

Constant Field Values

updateUsernames$UPDATES

static final boolean updateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

commitUpdateUsernames$UPDATES

static final boolean commitUpdateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

rollbackUpdateUsernames$UPDATES

static final boolean rollbackUpdateUsernames$UPDATES

Deprecated.

See Also:

Constant Field Values

reloadProperties$UPDATES

static final boolean reloadProperties$UPDATES

Deprecated.

See Also:

Constant Field Values

validate$UPDATES

static final boolean validate$UPDATES

Deprecated.

See Also:

Constant Field Values

validateDatabase$UPDATES

static final boolean validateDatabase$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

getNotifications

@Deprecated
Notification[] getNotifications(java.lang.Integer sortOrder_,
                                            java.lang.Integer sortType_,
                                            int startIndex_,
                                            int count_)

Deprecated. use getNotificationsPaging instead

Gets 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 order

sortType_ - 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 of Constants.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

Notification[] getNotificationsByApplicationAndType(java.lang.String appName_,
                                                    java.lang.String notificationType_)

Deprecated.

Gets the list of notifications matching the specified Application and Notification Type

Parameters:

appName_ - application name used for matching. see XXX_NOTIFICATION_APPLICATION constants in this class for options.

notificationType_ - notification type used for matching. see XXX_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

Notification[] getNotificationsByApplication(java.lang.String appName_)

Deprecated.

Gets a list of notifications matching Application name

Parameters:

appName_ - application name used for matching see XXX_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

void deleteNotification(java.lang.Long notificationId_)
                 throws InvalidNotificationException

Deprecated.

Delete a notification

Parameters:

notificationId_ - the id of the notification to delete

Throws:

InvalidNotificationException - if the notification id does not exist

ServiceException - if any system-level error occurs

deleteNotifications

void deleteNotifications(java.lang.Long[] notificationIds_)
                  throws InvalidNotificationException

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 exist

ServiceException - if any system-level error occurs

deleteNotificationsBeforeTimestamp

void deleteNotificationsBeforeTimestamp(java.sql.Timestamp timestamp)

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:

markNotificationAsRead(java.lang.Long)

getNotificationsSummary

NotificationsSummary getNotificationsSummary()

Deprecated.

Gets a NotificationsSummary 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:

markNotificationAsRead(java.lang.Long)

deleteExpiredNotifications

void deleteExpiredNotifications()

Deprecated.

Deletes all expired notifications for the current user

Throws:

ServiceException - if any system-level error occurs

markNotificationAsRead

void markNotificationAsRead(java.lang.Long notificationId_)
                     throws InvalidNotificationException

Deprecated.

Marks a notification as read. This affects the value returned by getUnreadNotificationsCount()

Parameters:

notificationId_ - the ids of the notifications to mark as read

Throws:

InvalidNotificationException - if the notification id does not exist

ServiceException - if any system-level error occurs

See Also:

getUnreadNotificationsCount()

markNotificationsAsRead

void markNotificationsAsRead(java.lang.Long[] notificationIds_)
                      throws InvalidNotificationException

Deprecated.

Marks a list of notifications as read. This affects the value returned by getUnreadNotificationsCount()

Parameters:

notificationIds_ - the ids of the notifications to mark as read

Throws:

InvalidNotificationException - if one or more of the notification IDs do not exist

ServiceException - if any system-level error occurs

See Also:

getUnreadNotificationsCount()

notify

void notify(java.lang.String[] users_,
            java.lang.Long[] groups_,
            java.lang.String appName_,
            java.lang.String ntfType_,
            java.util.Map attributes_)
     throws InvalidNotificationTypeException,
            java.lang.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 to

groups_ - the groups to send the notification to

appName_ - application sending the notification. see XXX_NOTIFICATION_APPLICATION constants in this class for options.

ntfType_ - notification type to send. see XXX_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 invalid

java.lang.IllegalArgumentException - if appName_ is invalid

ServiceException - if any system-level error occurs

notifyWithExcludedUsers

void notifyWithExcludedUsers(java.lang.String[] users_,
                             java.lang.Long[] groups_,
                             java.lang.String[] excludedUsers_,
                             java.lang.String appName_,
                             java.lang.String ntfType_,
                             java.util.Map attributes_)
                      throws InvalidNotificationTypeException,
                             java.lang.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 to

groups_ - the groups to send the notification to

excludedUsers_ - the users to which the notification should not be sent

appName_ - application sending the notification. see XXX_NOTIFICATION_APPLICATION constants in this class for options.

ntfType_ - notification type to send. see XXX_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 notify(String[] users_, Long[] groups_, String appName_, String ntfType_, Map attributes_) for necessary items.

Throws:

InvalidNotificationTypeException - if ntfType_ is invalid

java.lang.IllegalArgumentException - if appName_ is invalid

ServiceException - if any system-level error occurs

getNotificationsPaging

ResultPage getNotificationsPaging(int startIndex_,
                                  int batchSize_,
                                  java.lang.Integer sortProperty_,
                                  java.lang.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 of Constants.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 the SORT_BY_XXX constants in Notification. Those useable are: SORT_BY_READ, SORT_BY_APPLICATION, SORT_BY_TIMESTAMP

sortOrder_ - 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 of Notification objectss that the current user has received in the portal medium.

Throws:

ServiceException - if any system-level error occurs

getNotification

Notification getNotification(java.lang.Long notifId_)

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(java.lang.String[] oldUsernames_,
                                 java.lang.String[] newUsernames_,
                                 long maxExpirationTimeInSeconds_)
                          throws java.lang.IllegalArgumentException,
                                 DuplicateNameException

Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.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(). After commitUpdateUsernames has been called, the old usernames will still be active, but will expire after the interval specified by maxExpirationTimeInSeconds_; if updateUsernames is successful but commitUpdateUsernames 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 updated

newUsernames_ - the usernames to which the old usernames will be updated

maxExpirationTimeInSeconds_ - the interval, in seconds, after commitUpdateUsernames 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:

java.lang.IllegalArgumentException - if the length of oldUsernames_ is not the same as the length of newUsernames_.

DuplicateNameException - if any oldUsernames_ or newUsernames_ contain any duplicates.

ServiceException - if any system-level error occurs

commitUpdateUsernames

@Deprecated
void commitUpdateUsernames()

Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.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 by maxExpirationTimeInSeconds_; if commitUpdateUsernames is not called, the new usernames will not become active.

Throws:

ServiceException - if any system-level error occurs

rollbackUpdateUsernames

@Deprecated
void rollbackUpdateUsernames()

Deprecated. instead use UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])

DEPRECATED: See UserService.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
void 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

java.lang.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

DatabaseStatus validateDatabase(int thoroughness_)

Deprecated.

Performs validation on the database(s) associated with this service.

Parameters:

thoroughness_ - indicates the level of thoroughness of the query. Values are DatabaseStatus.QUICK and DatabaseStatus.SLOW

Returns:

a DatabaseStatus object encapsulating the results of the validation query.