com.netegrity.imapi
Interface FieldContext

All Superinterfaces:

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

public interface FieldContext
extends ScreenContext

Provides access to information and services for the current field 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.
• ScreenContext methods for information about the current screen in a profile tab.

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

Since:

Framework r12

Method Summary

void	disable() disable this field.
void	enable() enable this field.
PropertyDict	getConfig() Get the configuration properties for this field.
java.util.Vector	getMultiValue() Get multi-value attribute for this field.
ScreenField	getScreenField()
java.lang.String	getValue() Get attribute value for this field.
void	hide() Hide this field.
void	setMultiValue(java.util.Vector newValues) Set multi-value attribute for this field.
void	setValue(java.lang.String newValue) Set attribute value for this field.
void	show() Show this field.

Methods inherited from interface com.netegrity.imapi.ScreenContext

disableField, enableField, getFieldMultiValue, getFieldValue, getOverridingValues, getProfileObject, getScreen, getScreenConfig, hideField, setFieldMultiValue, setFieldValue, setOverridingFieldMultiValue, setOverridingFieldValue, showField

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

getScreenField

ScreenField getScreenField()

getConfig

PropertyDict getConfig()

Get the configuration properties for this field.

Returns:

PropertyDict

Throws:

java.lang.Exception

getValue

java.lang.String getValue()
                          throws java.lang.Exception

Get attribute value for this field.

Returns:

String

Throws:

java.lang.Exception

getMultiValue

java.util.Vector getMultiValue()
                               throws java.lang.Exception

Get multi-value attribute for this field.

Returns:

Vector

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String newValue)
              throws java.lang.Exception

Set attribute value for this field.

Parameters:

newValues -

Throws:

java.lang.Exception

setMultiValue

void setMultiValue(java.util.Vector newValues)
                   throws java.lang.Exception

Set multi-value attribute for this field.

Parameters:

newValues -

Throws:

java.lang.Exception

hide

void hide()

Hide this field.

show

void show()

Show this field.

disable

void disable()

disable this field.

enable

void enable()

enable this field.