com.netegrity.imapi
Interface TabSequenceContext

All Superinterfaces:

BLTHContext, IMContext, IMPersistentContext, Logger, ProviderAccessor, java.io.Serializable, ServiceProvider, TabControllerContext, TaskInfo

public interface TabSequenceContext
extends TabControllerContext

Provides access to information and services for working with tabs. Information and services include:

• IMContext information about the current task.
• get... methods for accessing managed objects in the task session.
• A ProviderAccessor object for direct access to the managed objects in the data store.
  
  Identity Manager passes TabControllerContext into JavaScript methods configured for TabController javascript.
  

  Since:

  Framework r12

  Field Summary

  static int	ACTION_CANCEL
  static int	ACTION_NONE
  static int	ACTION_SUBMIT
  static int	BUTTON_FINISH
  static int	BUTTON_NEXT
  static int	BUTTON_NO
  static int	BUTTON_NONE
  static int	BUTTON_OK
  static int	BUTTON_PREV
  static int	BUTTON_SUBMIT
  static int	BUTTON_YES
  static int	DEFAULT_PROCESS The javascript method can return this to accept the default processing.
  static int	PHASE_INITIAL
  static int	PHASE_RESPONSE

  Method Summary

  void	addButton(int buttonmask) This methods allows buttons (as defined in the constants above) to be added to the form.
  int	getButtonClicked() Returns the button clicked Will be -1 if we are in the initial tab creation step.
  int	getCurrentTabIndex() Returns the index of the current tab.
  int	getDefaultResultTabIndex() Returns the tab that the framework would give as the result tab based on the visible tabs, the current tab and the processing state and the buttons pressed.
  void	removeButton(int buttonmask) This methods removes a button that was previously added.
  void	setProcessingAction(int action) Sets the action to process in the update phase.

  Methods inherited from interface com.netegrity.imapi.TabControllerContext

  disableTab, enableTab, getFieldMultiValue, getFieldValue, getTab, getTabCount, getTabDefinition, isObjectBeingCreated

  Methods inherited from interface com.netegrity.imapi.BLTHContext

  getAccessRole, getAccessRoleAdmins, getAccessRoleMembers, getAccessTask, getAdminRole, getAdminRoleAdmins, getAdminRoleMembers, getAdminTask, getDeletedGroups, getDeletedOrgs, getDeletedUsers, getDisabledUsers, getEnabledUsers, getGroup, getGroupAdmins, getGroupMembers, getOrg, getProvisioningRole, getProvisioningRoleAdmins, getProvisioningRoleMembers, getTask, getTaskTabHandlers, getUser, getUsersAssignedAccessRoles, getUsersAssignedAdminRoles, getUsersAssignedProvisioningRoles, getUsersGrantableAccessRoles, getUsersGrantableAdminRoles, getUsersGrantableProvisioningRoles, getUsersGroups, isTaskReadOnly

  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, getAdminUniqueName, getAuthDirFriendlyName, getAuthDirUniqueName, getEnvironmentFriendlyName, getEnvironmentUniqueName, getObjectOrganization, getObjectOrganizationFriendlyName, getSessionCreateTime, getSessionId, getSiteMinderSessionId, getSiteMinderSessionSpec, getSiteMinderTransactionId, getSMHeader, getSubject, getSubjects, getTaskApplication, getTaskCategory, getTaskFriendlyName, getTaskUniqueName, getTSContext, getUserLocale, isAuditableTask, 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

  Field Detail

  PHASE_INITIAL

  static final int PHASE_INITIAL

  See Also:

  Constant Field Values

  PHASE_RESPONSE

  static final int PHASE_RESPONSE

  See Also:

  Constant Field Values

  DEFAULT_PROCESS

  static final int DEFAULT_PROCESS

  The javascript method can return this to accept the default processing. This can be used to provide default processing to most tabs in the task and to only do special processing in the exceptional cases.

  See Also:

  Constant Field Values

  ACTION_NONE

  static final int ACTION_NONE

  See Also:

  Constant Field Values

  ACTION_CANCEL

  static final int ACTION_CANCEL

  See Also:

  Constant Field Values

  ACTION_SUBMIT

  static final int ACTION_SUBMIT

  See Also:

  Constant Field Values

  BUTTON_NONE

  static final int BUTTON_NONE

  See Also:

  Constant Field Values

  BUTTON_NEXT

  static final int BUTTON_NEXT

  See Also:

  Constant Field Values

  BUTTON_PREV

  static final int BUTTON_PREV

  See Also:

  Constant Field Values

  BUTTON_OK

  static final int BUTTON_OK

  See Also:

  Constant Field Values

  BUTTON_SUBMIT

  static final int BUTTON_SUBMIT

  See Also:

  Constant Field Values

  BUTTON_FINISH

  static final int BUTTON_FINISH

  See Also:

  Constant Field Values

  BUTTON_YES

  static final int BUTTON_YES

  See Also:

  Constant Field Values

  BUTTON_NO

  static final int BUTTON_NO

  See Also:

  Constant Field Values

  Method Detail

  addButton

  void addButton(int buttonmask)

  This methods allows buttons (as defined in the constants above) to be added to the form.

  Parameters:

  buttonmask -

  removeButton

  void removeButton(int buttonmask)

  This methods removes a button that was previously added. Note that the inital state of buttons is none.

  Parameters:

  buttonmask -

  getCurrentTabIndex

  int getCurrentTabIndex()

  Returns the index of the current tab. Will be -1 if we are in the initial tab creation step.

  Returns:

  getButtonClicked

  int getButtonClicked()

  Returns the button clicked Will be -1 if we are in the initial tab creation step.

  Returns:

  setProcessingAction

  void setProcessingAction(int action)

  Sets the action to process in the update phase. Default is none, can be set to ACTION_CANCEL, ACTION_SUBMIT

  Parameters:

  action -

  getDefaultResultTabIndex

  int getDefaultResultTabIndex()

  Returns the tab that the framework would give as the result tab based on the visible tabs, the current tab and the processing state and the buttons pressed. The javascript method can return this if desired

  Returns: