com.netegrity.imapi
Interface NotificationRuleContext

All Superinterfaces:

EventROContext, IMContext, Logger, ProviderAccessor, java.io.Serializable, ServiceProvider, TaskInfo

public interface NotificationRuleContext
extends EventROContext

Provides access to one or all name/value pairs of user-defined data that were specified in the email template.

This interface also provides access to:

• IMContext information about the current task.
• EventROContext information (read-only) about managed objects associated with the current event.
• ProviderAccessor methods for accessing managed objects in the data store.
• Logging methods and other Identity Manager services.

Identity Manager passes NotificationRuleContext into every call it makes to NotificationRuleAdapter.

Since:

IdentityMinder 5.6

Method Summary

java.lang.String	getTemplateParameter(java.lang.String key) Retrieves the value of the specified item of user-defined data.
java.util.Hashtable	getTemplateParameters() Retrieves all the user-defined data from the email template.

Methods inherited from interface com.netegrity.imapi.EventROContext

getEvent, getEventDescription, getEventName

Methods inherited from interface com.netegrity.imapi.IMContext

getAuxDataRoot, getSessionAttribute, removeSessionAttribute, setSessionAttribute

Methods inherited from interface com.netegrity.imapi.Logger

logDebugMessage, logErrorMessage, logInfoMessage, logWarningMessage

Methods inherited from interface com.netegrity.imapi.TaskInfo

addErrorObject, addMessageObject, addMessageObject, addStatusDetail, createRuntimeStatusDetail, getActionType, getAdminFriendlyName, getAdministrator, getAdminTask, getAdminUniqueName, getAuthDirFriendlyName, getAuthDirUniqueName, getEnvironmentFriendlyName, getEnvironmentUniqueName, getObjectOrganization, getObjectOrganizationFriendlyName, getSessionCreateTime, getSessionId, getSiteMinderSessionId, getSiteMinderSessionSpec, getSiteMinderTransactionId, getSMHeader, getSubject, getSubjects, getTaskApplication, getTaskCategory, getTaskFriendlyName, getTaskUniqueName, getTSContext, getUserLocale, isAuditableTask, isTaskReadOnly, isWorkflowTask, sendAuditEvent

Methods inherited from interface com.netegrity.imapi.ServiceProvider

canUserAdministerGroup, convertLogicalToPhysical, convertPhysicalToLogical, decryptString, decryptString, doesSupportGroup, doesSupportOrganization, encryptString, encryptString, findAdminTask, getAllUsersAccessRoles, getGroupAdmins, getGroupMembers, getGroups, getGroupsAdminCanAdminister, getManagedObject, getManagedObjects, getManagedObjects, getOrg, getOrgMembers, getRootOrg, getSubOrgs, getTemporaryPassword, getTempPassword, isPasswordValid, isPasswordValid, isTopMostOrgWhichTaskIsBoundTo, validatePassword, validatePassword

Methods inherited from interface com.netegrity.imapi.ProviderAccessor

getAccessControlProvider, getAccessRoleProvider, getAccessTaskProvider, getAdminRoleProvider, getAdminTaskProvider, getAnalyticsEngineProvider, getEnvironmentSettingsProvider, getGroupProvider, getManagedObjectProvider, getOrganizationProvider, getProvisioningPolicyProvider, getProvisioningRoleProvider, getRelationshipProvider, getSecurityProvider, getSynchronizationProvider, getTabDefinitionProvider, getUserProvider

Method Detail

getTemplateParameters

java.util.Hashtable getTemplateParameters()

Retrieves all the user-defined data from the email template.

Returns:

Name/value pairs of user-defined data.

getTemplateParameter

java.lang.String getTemplateParameter(java.lang.String key)

Retrieves the value of the specified item of user-defined data.

Parameters:

key - The name portion of the name/value pair as specified in the email template.

Returns:

The value assigned to the specified name in the email template.