com.netegrity.imapi
Interface TabControllerContext

All Superinterfaces:

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

All Known Subinterfaces:

TabSequenceContext

public interface TabControllerContext
extends BLTHContext

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

  Method Summary

  void	disableTab(java.lang.String tabTag) Enable a tab.
  void	enableTab(java.lang.String tabTag) Disable a tab.
  java.util.Vector	getFieldMultiValue(java.lang.String attributeName) Returns the value of the subject
  java.lang.String	getFieldValue(java.lang.String attributeName) Returns the value of the subject
  Tab	getTab(int index) Returns the TAB
  int	getTabCount() Returns the number of tabs
  TabDefinition	getTabDefinition(int index) Returns the tab definition.
  boolean	isObjectBeingCreated() Returns true if this is a creational action.

  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

  Method Detail

  getTab

  Tab getTab(int index)

  Returns the TAB

  Parameters:

  index -

  getTabDefinition

  TabDefinition getTabDefinition(int index)
                                 throws SmApiException

  Returns the tab definition.

  Parameters:

  index -

  Throws:

  SmApiException

  getTabCount

  int getTabCount()

  Returns the number of tabs

  isObjectBeingCreated

  boolean isObjectBeingCreated()
                               throws java.lang.Exception

  Returns true if this is a creational action.

  Specified by:

  isObjectBeingCreated in interface BLTHContext

  Returns:

  Throws:

  java.lang.Exception

  getFieldValue

  java.lang.String getFieldValue(java.lang.String attributeName)
                                 throws java.lang.Exception

  Returns the value of the subject

  Parameters:

  attributeName -

  Returns:

  Throws:

  java.lang.Exception

  getFieldMultiValue

  java.util.Vector getFieldMultiValue(java.lang.String attributeName)
                                      throws java.lang.Exception

  Returns the value of the subject

  Parameters:

  attributeName -

  Returns:

  Throws:

  java.lang.Exception

  disableTab

  void disableTab(java.lang.String tabTag)

  Enable a tab.

  Parameters:

  tabTag -

  enableTab

  void enableTab(java.lang.String tabTag)

  Disable a tab.

  Parameters:

  tabTag -