com.netegrity.imapi
Interface WorkflowContext

All Superinterfaces:

EventContext, IMContext, IMPersistentContext, Logger, ProviderAccessor, java.io.Serializable, ServiceProvider, TaskInfo

public interface WorkflowContext
extends EventContext

Allows a WorkPoint workflow script to approve or reject a workflow process. Also allows a script to retrieve the list of approvers for a workflow activity.

This interface also provides access to:

• IMContext information about the current task.
• EventContext information (read/write) about managed objects associated with the current event.
• IMPersistentContext methods for passing user-defined data between scripts in a given workflow process. The persisted data is not written to the data store.
• ProviderAccessor methods for accessing managed objects in the data store.
• Logging methods and other Identity Manager services.

Before you call the methods in this interface, you must retrieve the Identity Manager context information for this workflow process by calling generateWorkflowContext().

You can call the methods in the Workflow API from a WorkPoint script, or you can call them from a Java object which is then accessed from a WorkPoint script. For more information, see the WorkPoint documentation.

Since:

IdentityMinder 5.6

Method Summary

void	approve(java.util.Hashtable userData) Approves the workflow process.
AdminRole	getAdminRole(java.lang.String roleName, java.util.Vector attributes)
Group	getGroup(java.lang.String groupName, java.util.Vector attributes)
Organization	getOrganization(java.lang.String orgName, java.util.Vector attributes)
java.lang.Object	getParticipants(java.util.Hashtable userData, java.lang.String wfApprovalTaskName, IWFObjectId workItemId) Retrieves the participants who are authorized to approve or reject the specified workflow activity.
int	getTimeout(java.util.Hashtable metaData, java.lang.String activityName, IWFObjectId workItemId)
User	getUser(java.lang.String userName, java.util.Vector attributes)
java.lang.Object	getUserAccounts(java.lang.String username)
java.lang.Object	getUserAdminRolesAdministrators(java.lang.String username)
java.lang.Object	getUserAdminRolesMembership(java.lang.String username)
java.lang.Object	getUserGroups(java.lang.String username)
java.lang.Object	getUserProvisioningRolesAdministrators(java.lang.String username)
java.lang.Object	getUserProvisioningRolesMembership(java.lang.String username)
void	reject(java.util.Hashtable userData) Rejects the workflow process.

Methods inherited from interface com.netegrity.imapi.EventContext

generateEvent, getEvent, getEventDescription, getEventName

Methods inherited from interface com.netegrity.imapi.IMPersistentContext

getPersistentData, setPersistentData

Methods inherited from interface com.netegrity.imapi.IMContext

getAuxDataRoot, getLocalizer, getLocalizer, 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

approve

void approve(java.util.Hashtable userData)
             throws java.lang.Exception

Approves the workflow process.

Parameters:

userData - Information defined in the User Data tab of the WorkPoint Activity Properties dialog box. This information includes the identifier of the participant resolver and any user-defined data.

Throws:

java.lang.Exception

getParticipants

java.lang.Object getParticipants(java.util.Hashtable userData,
                                 java.lang.String wfApprovalTaskName,
                                 IWFObjectId workItemId)
                                 throws java.lang.Exception

Retrieves the participants who are authorized to approve or reject the specified workflow activity.

By default, an activity's participants are provided through the pre-defined script IM Approvers, which is specified in the Select Resources dialog box for the activity's properties. This script should not be modified. However, you can customize the participant list using this method.

Parameters:

userData - Information defined in the User Data tab of the WorkPoint Activity Properties dialog box. This information includes the identifier of the participant resolver and any user-defined data.

wfApprovalTaskName - The name of the Identity Manager workflow approval task associated with this activity. The task name is the same as the activity name.

workItemId - The workitem Id this request is related to, for audit.

Returns:

The unique IDs of the activity's participants.

Throws:

java.lang.Exception

reject

void reject(java.util.Hashtable userData)
            throws java.lang.Exception

Rejects the workflow process.

Parameters:

userData - Information defined in the User Data tab of the WorkPoint Activity Properties dialog box. This information includes the identifier of the participant resolver and any user-defined data.

Throws:

java.lang.Exception

getUser

User getUser(java.lang.String userName,
             java.util.Vector attributes)

getGroup

Group getGroup(java.lang.String groupName,
               java.util.Vector attributes)

getOrganization

Organization getOrganization(java.lang.String orgName,
                             java.util.Vector attributes)

getAdminRole

AdminRole getAdminRole(java.lang.String roleName,
                       java.util.Vector attributes)

getUserAdminRolesMembership

java.lang.Object getUserAdminRolesMembership(java.lang.String username)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getUserAdminRolesAdministrators

java.lang.Object getUserAdminRolesAdministrators(java.lang.String username)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getUserProvisioningRolesMembership

java.lang.Object getUserProvisioningRolesMembership(java.lang.String username)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getUserProvisioningRolesAdministrators

java.lang.Object getUserProvisioningRolesAdministrators(java.lang.String username)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getUserGroups

java.lang.Object getUserGroups(java.lang.String username)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getUserAccounts

java.lang.Object getUserAccounts(java.lang.String username)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getTimeout

int getTimeout(java.util.Hashtable metaData,
               java.lang.String activityName,
               IWFObjectId workItemId)
               throws java.lang.Exception

Throws:

java.lang.Exception