com.netegrity.imapi
Interface ScreenContext

All Superinterfaces:

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

All Known Subinterfaces:

FieldContext

public interface ScreenContext
extends BLTHContext

Provides access to information and services for the current screen in a profile tab. 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.
• IMPersistentContext methods for passing data between business logic task handlers executed for a given task. The persisted data is abandoned after all business logic task handlers for the task have been executed.
• BLTHContext methods for information about the current task session, Logging methods and other Identity Manager services.

Identity Manager passes ScreenContext into JavaScript methods configured for screens on Profile screens.

Since:

Framework r12.1

Method Summary

void	disableField(java.lang.String attrName) disable field for specified attribute.
void	enableField(java.lang.String attrName) Enable field for specified attribute
java.util.Vector	getFieldMultiValue(java.lang.String attributeName)
java.lang.String	getFieldValue(java.lang.String attributeName)
java.util.Map	getOverridingValues() Deprecated. use screen validation rather than field validation when setting values of fields
ManagedObject	getProfileObject()
Screen	getScreen()
PropertyDict	getScreenConfig()
void	hideField(java.lang.String attrName) Hide field for specified attribute.
void	setFieldMultiValue(java.lang.String attributeName, java.util.Vector newValues)
void	setFieldValue(java.lang.String attributeName, java.lang.String newValue)
void	setOverridingFieldMultiValue(java.lang.String attributeName, java.util.Vector newValues) Deprecated. use screen validation rather than field validation when setting values of fields
void	setOverridingFieldValue(java.lang.String attributeName, java.lang.String newValue) Deprecated. use screen validation rather than field validation when setting values of fields
void	showField(java.lang.String attrName) Show field for specified attribute.

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, isObjectBeingCreated, 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

getProfileObject

ManagedObject getProfileObject()

getScreen

Screen getScreen()

getScreenConfig

PropertyDict getScreenConfig()

getFieldValue

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

Throws:

java.lang.Exception

getFieldMultiValue

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

Throws:

java.lang.Exception

setFieldValue

void setFieldValue(java.lang.String attributeName,
                   java.lang.String newValue)
                   throws java.lang.Exception

Throws:

java.lang.Exception

setFieldMultiValue

void setFieldMultiValue(java.lang.String attributeName,
                        java.util.Vector newValues)
                        throws java.lang.Exception

Throws:

java.lang.Exception

setOverridingFieldValue

void setOverridingFieldValue(java.lang.String attributeName,
                             java.lang.String newValue)
                             throws java.lang.Exception

Deprecated. use screen validation rather than field validation when setting values of fields

Sets value of the field to newValue and marks it as overriding value compared to other values that setFieldValue calls may be trying to set during the same update transaction in one request.

Parameters:

attributeName -

newValue -

Throws:

java.lang.Exception

setOverridingFieldMultiValue

void setOverridingFieldMultiValue(java.lang.String attributeName,
                                  java.util.Vector newValues)
                                  throws java.lang.Exception

Deprecated. use screen validation rather than field validation when setting values of fields

Sets value of the field to newValues vector and marks it as overriding value compared to other values that setFieldMultiValue calls may be trying to set during the same update trasaction in one request.

Parameters:

attributeName -

newValues -

Throws:

java.lang.Exception

getOverridingValues

java.util.Map getOverridingValues()

Deprecated. use screen validation rather than field validation when setting values of fields

Returns Hashtable of key=String attributeName, value=field value pairs.

Returns:

hideField

void hideField(java.lang.String attrName)

Hide field for specified attribute.

Parameters:

attrName -

showField

void showField(java.lang.String attrName)

Show field for specified attribute.

Parameters:

attrName -

disableField

void disableField(java.lang.String attrName)

disable field for specified attribute.

Parameters:

attrName -

enableField

void enableField(java.lang.String attrName)

Enable field for specified attribute

Parameters:

attrName -