A B C D E F G H I J K L M N O P Q R S T U V W

## G

get(String) - Method in class com.ibm.openpages.api.Context
  Returns the value to which the specified key is mapped, or null if this context contains no mapping for the key.
getAcceptance() - Method in interface com.ibm.openpages.api.questionnaire.IComment
  Deprecated.
  This method is deprecated as of release 7.3.0.1, use method `IComment.getCommentType()` instead.
getAccess() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
  Returns the List for this rule.
getAccess() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the List for this rule.
getAccessFor(int) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the IRLSAccess for this rule.
getAccessibleGroups() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves all groups accessible by current user.
getAccessType() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the access control type of the activity definition.
getAction() - Method in class com.ibm.openpages.api.search.DateFacetParam
  Get the date facet action: On Date, Range Date, Previous Days, Next Days
getAction() - Method in class com.ibm.openpages.api.search.UserFacetParam
  Get the user facet action: Me, and Others
getAction() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the name of the processed transition.
getActionClass() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
  Returns the name of the action class.
getActionFields() - Method in interface com.ibm.openpages.api.respview.IRespViewHeader
  Returns the list of responsive view fields that provides actions of the task view ( such as lifecycle transitions )
getActions() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Gets all actions associated with the current field
getActions() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the list of actions for the rule.
getActions() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the list of actions executed during the transition operation.
getActionType() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
getActionType() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the action type
getActiveProcesses(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns list of active processes (open/executing) for the given resource id.
getActiveWorkflowIds() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns a list of ids for the active workflows associated with this GRC Object.
getActivities() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the list of activities.
getActivity(Id, Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
getActivity(String) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the activity by the activity name.
getActivity(Id) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the activity by the activity ID.
getActivityContext() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
  Returns the activity context.
getActivityId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the activity definition.
getActivityInstance() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
getActivityInstance(Id) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
  Returns an `IWFActivityInstance` by the activity instance ID.
getActivityInstanceId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the ID of the activity instance
getActivityInstanceId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the Id of the activity the event occurred in.
getActivityInstances(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves the list of activity instances for the given process id.
getActivityInstances(List<Id>) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves the list of activity instances for the given list of activity instance ids.
getActivityInstances(IWFActivityInstanceFindOptions) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves activity instances based on the supplied options.
getActivityInstances() - Method in interface com.ibm.openpages.api.workflow.IWFProcess
  Returns list of `IWFActivityInstance` created out of the process instance.
getActivityInstances() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Get the list of `IWFActivityInstance` results based on the Search options provided via `IWFActivityInstanceFindOptions`
getActivityLabel() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the localized name of the workflow task for this notification
getActivityName() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the name of the workflow task for this notification
getActivityNotifications(IWFActivityNotificationFindOptions) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns the notification for active workflow activity instances.
getActivityNotifications() - Method in class com.ibm.openpages.api.workflow.WFActivityNotificationList
  Get the list of `IWFActivityNotification` results based on the Search options provided via `IWFActivityNotificationFindOptions`
getActor() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the actor affected by the event.
getActorImpersonates(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Find all actors, users or groups, that the given actor impersonates.
getAdditionalMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
  Returns the OpenPages message of this exception if there is any, otherwise returns the message of the exception.
getAdditionalParents() - Method in class com.ibm.openpages.api.trigger.events.CreateResourceWithRelationsEvent
getAdministrator() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns `ISecurityPrincipal` of the administrator to whom this administrative permission applies.
getAdminLevel() - Method in class com.ibm.openpages.api.security.GroupInfo
  Gets the administration level for the user group.
getAdminLevel() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns the OpenPages administration level associated with the security group.
getAdminLevel() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the administration level associated to this user.
getAdminPermissions() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Retrieves the administrative permissions for a security principal.
getAdminPermissions(List<Id>, List<Id>) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Finds administrator permissions for provided list of group ids and list of administrator ids.
getAdvancedEvalId() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getAdvancedEvaluationResults() - Method in class com.ibm.openpages.api.workflow.WFConditionReport
getAggregationFieldName() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the aggregation Field
getAggregationFieldName() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the aggregation Field
getAllMembers() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns all members of a security group.
getAllParameterNames() - Method in interface com.ibm.openpages.api.application.IReportParameters
  Gets all the report parameter names.
getAllQuestionsMatched() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  If all questions in the program template are matched.
getAllRLSRules() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns list of All the rules
getAndOr() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the AND or OR operator for search conditions.
getAnswer() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns answer of the question.
getAnswerCount() - Method in interface com.ibm.openpages.api.questionnaire.ISection
getAnsweredBy() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns the user who last answered
getAnsweredOnDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns the timestamp when the answer was persisted
getAnswerType() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns answer type
getApplicableAdminView(ITypeDefinition) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
getApplicableAdminView(ITypeDefinition, String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object for a specific profile, or null if there is no applicable view.
getApplicableCreationView(ITypeDefinition, ITypeDefinition) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
getApplicableCreationView(ITypeDefinition, ITypeDefinition, String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
getApplicableGridView(ITypeDefinition) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
getApplicableTaskView(IGRCObject) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
getApplicationContext() - Method in class com.ibm.openpages.api.scheduler.AbstractScheduledProcess
getApplicationPermission(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves application permission by Id.
getApplicationPermission(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves application permission by name.
getApplicationPermissions() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves all the application permissions
getArgumentCount() - Method in interface com.ibm.openpages.api.configuration.ITextFormatter
  Returns the number of arguments that can be bound to this message template.
getAssetContentTypeId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
getAssignee() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns the assignee (user) of this questionnaire.
getAssignee() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get the assignee.
getAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getAssigneeId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the ID of the individual assigned to the workflow task
getAssignees() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the assignees to apply to the target activity by the workflow action.
getAssignees() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the list of user or groups names who the activity is assigned to.
getAssociatedTags(Id, Id) - Method in interface com.ibm.openpages.api.service.ITagService
getAssociatedTemplateName() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  For questionnaire assessments, the name of the associated questionnaire template.
getAssociationAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a List of AssociationAuditLogs for a given GRCObject Id.
getAssociationAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a list of AssociationAuditLogs for a given GRCObject Id.
getAssociationDefinition(Id) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the association based on the Id.
getAssociationDefinition() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
  Returns the association definition for this node.
getAssociationFilter() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
  Returns the association filter.
getAssociationFilter() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns the association filter.
getAssociationTypeId() - Method in enum com.ibm.openpages.api.tag.ResourceTagAssociationType
getAsyncCalculationRequests(Set<Id>) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the resources in the asynchronous calculation queue.
getAttachments() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a list of attachments of the assessment.
getAttribute() - Method in interface com.ibm.openpages.api.configuration.IFindInCondition
  Returns the attribute for the condition
getAttribute() - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
  Returns the attribute for the condition
getAttribute(String) - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the value of attribute in the context.
getAttribute(String) - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the process instance attribute by a name string.
getAttribute(String) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the process attribute by a name string.
getAttribute() - Method in interface com.ibm.openpages.api.workflow.IWFSearchInCondition
  Returns the condition attribute
getAttribute() - Method in interface com.ibm.openpages.api.workflow.IWFSearchRangeCondition
  Returns the condition attribute
getAttribute() - Method in interface com.ibm.openpages.api.workflow.IWFSearchSimpleCondition
  Returns the condition attribute
getAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
  Returns a Map containing the event handler's attributes and their values.
getAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractRule
  Returns HashMap containing rule attributes and their values.
getAttributes() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the name/value pairs of process instance attributes.
getAttributes() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the map of process attributes.
getAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog) for a given GRCObject Id.
getAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog) for a given GRCObject Id and AuditLogFilter.
getAuthor() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getAuthor() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getAvailableActions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns available transitions to set, which is determined by the lifecycle or the workflow.
getAvailableTransitions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Deprecated.
  - call `IQuestionnaire.getAvailableActions()` instead.
getBaseAmount() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
  Returns the currency base amount.
getBaseCurrency() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
  Returns the base currency.
getBaseCurrency() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the base currency.
getBaseDate() - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
  Returns base date evaluation unit.
getBaseThemeName() - Method in interface com.ibm.openpages.api.theme.ITheme
getBody() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the body of the email
getBodyKeyToNotifyActionCompleted() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for body of notification that is sent to the user who submitted a background transition when that transition has completed.
getBodyKeyToNotifyAssignees() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for notification body to assignees.
getBodyKeyToNotifySubscribers() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for notification body to subscribers.
getBodyKeyToNotifyWorkflowCompleted() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for body of notification that is sent to the oversight and other actors when the workflow has completed.
getBodyParams() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets parameters that will be formated into body text
getBodyTextKey() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the key that is used to locate the application string for body
getBooleanValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as a `Boolean`
getBottom() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes.INumberRangeColor
  Deprecated.
  This truncates decimal places. Use `#bottomDouble()` instead.
getBottomDouble() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes.INumberRangeColor
  bottom number of the range as a Double
getBuildInfo() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the build information for the latest version.
getBulkAction() - Method in class com.ibm.openpages.api.workflow.BulkWorkflowActionOptions
  Returns the name of the action to be performed in bulk
getBulkGridViewName() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the grid view to use when performing bulk transitions.
getBulkTransitions() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  If bulk execution is enabled for this activity, get the list of transitions which can be performed in bulk.
getBundleName(String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Gets the name of the Bundle from the bundleFieldPath.
getCalcId() - Method in class com.ibm.openpages.api.rule.TBCalcLog
  Returns calculation definition Id
getCalcLogs() - Method in interface com.ibm.openpages.api.resource.IField
  Returns a list of calculation error/warning results if there is, such as insufficient information.
getCalcLogs() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns a Map of calculation error results if there is, such as circular calculation.
getCalcStats(Set<Id>) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the statistics of the calculations such as how many resources are in the queue for asynchronous calculation, or how many resources have calculation errors for a given calculation definition.
getCalculationToRun() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the name of the calculation to run on a given object.
getCanAddGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the add group permission of the administrator on the security domain.
getCanAssignRole() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the role assignment permission of the administrator on the security domain.
getCanAssociate() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  Returns associate permission.
getCanAssociate() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns associate permission.
getCanBrowse() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the browse user or group permission of the administrator on the security domain.
getCanCreate() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the create user or group permission of the administrator on the security domain.
getCanDelete() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  Returns delete permission.
getCanDelete() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns delete permission.
getCanDisable() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the disable user or group permission of the administrator on the security domain.
getCanEnable() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the enable user or group permission of the administrator on the security domain.
getCanLock() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the lock permission of the administrator on the security domain.
getCanManage() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the manage user or group permission of the administrator on the security domain.
getCanModify() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the modify user or group permission of the administrator on the security domain.
getCanProcessTransition() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns true if the user can process the transition based on `IWFActivity.getAccessType()`.
getCanRead() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  Returns read permission.
getCanRead() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns read permission.
getCanReadResource() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns true if the user can read the associated GRC object based on `IWFActivity.getAccessType()`.
getCanRemove() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the remove user or group permission of the administrator on the security domain.
getCanRemoveGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the remove group permission of the administrator on the security domain.
getCanResetPassword() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the password reset permission of the administrator on the security domain.
getCanRevokeRole() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the role revoke permission of the administrator on the security domain.
getCanUnLock() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the unlock permission of the administrator on the security domain.
getCanUpdateResource() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns true if the user can update the associated GRC object based on `IWFActivity.getAccessType()`.
getCanWrite() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  Returns write permission.
getCanWrite() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns write permission.
getCaseInsensitive() - Method in interface com.ibm.openpages.api.query.IQuery
  Returns true when case insensitive comparison is done; otherwise, false is returned.
getCases() - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
  Returns the list of case
getCategory() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
  Returns the category of an application text
getCategory() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Get the rule category
getCategory() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the type of the job detail.
getCategory() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Get category.
getCategory() - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
  Get category.
getChartAttrs() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Get the custom attributes that are needed by the chart
getChartDataField() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the field name that is used by the chart
getChartDataField() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the field name that is used by the chart
getChartType() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the type of chart
getChartType() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the type of chart
getChild() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
  Returns the "child" type definition of this association.
getChild() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
  Returns the single child Id for the child object of this event.
getChild() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
  Returns the single child Id for the child object of this event.
getChild() - Method in class com.ibm.openpages.api.trigger.events.ReassignPrimaryParentEvent
  Returns the single child Id for the child object of this event.
getChildProcesses() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the children processes of the process.
getChildProperties(String) - Method in interface com.ibm.openpages.api.configuration.IConfigProperties
  Retrieves all child configuration setting under specified propertyName.
getChildren() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns direct children GRC Object associations defined by the AssociationFilter supplied to the `IResourceService.getGRCObject(Id, GRCObjectFilter)` and `IResourceService.getGRCObject(String, GRCObjectFilter)` methods.
getChildren() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
  Returns the list of Ids of the children objects of this event.
getChildren() - Method in class com.ibm.openpages.api.trigger.events.CreateResourceWithRelationsEvent
getChildren() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
  Returns the list of Ids of the children objects of this event.
getChildrenAssociations() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns all children associations for this type (i.e., all other type definitions for which this type has a direct navigation path).
getChildrenTypesToCopy() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
  Gets the children Object Types to be copied.
getChildrenTypesToCopy() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  Gets the children Object Types to be copied.
getChildrenTypesToMove() - Method in class com.ibm.openpages.api.application.MoveObjectOptions
getChildTypeId() - Method in class com.ibm.openpages.api.application.TypeAssociationToHonor
  Gets the child type Id of the TypeAssociationToHonor
getClassifierFieldName() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Get the classifier field name for suggestAssociations action types.
getCode() - Method in class com.ibm.openpages.api.ErrorCode
  The numeric error code Id for this error.
getCode() - Method in exception com.ibm.openpages.api.OpenPagesException
getCollapsed() - Method in interface com.ibm.openpages.api.respview.IRespViewSection
  Returns the collapsed state of the responsive view section
getColor() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes.INumberRangeColor
  color of the number-range definition
getColor() - Method in interface com.ibm.openpages.api.tag.ITag
getColors() - Method in interface com.ibm.openpages.api.theme.ITheme
getColumn2Field() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the column2Field
getColumnName() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
  Gets the name of the column.
getColumnValue(int) - Method in interface com.ibm.openpages.api.application.ICognosReportRow
  Returns the column value for the specified column.
getColumnValueByName(String) - Method in interface com.ibm.openpages.api.application.ICognosReportRow
  Returns the column value for the specified column name.
getComment() - Method in class com.ibm.openpages.api.workflow.BulkWorkflowActionOptions
  If applicable, returns the comment value set for the action
getCommentDate() - Method in interface com.ibm.openpages.api.workflow.IWFTransitionComment
  The date the comment was provided.
getCommentOwner() - Method in interface com.ibm.openpages.api.workflow.IWFTransitionComment
  The user who provided the comment.
getCommentPromptKey() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as the default prompt for the transition comment.
getCommentRequirement() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns whether the user is required to provide a comment when transitioning the workflow, or if it is optional or not available.
getComments() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a list of comments of the assessment.
getCommentType() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getCommentValue() - Method in interface com.ibm.openpages.api.workflow.IWFTransitionComment
  The comment provided by the user.
getCompareTo() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the value/field to compare the current field's value to.
getCompletionRequired() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
getCondition() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Returns the condition for the query
getCondition() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the condition, also called "operator" internally.
getCondition() - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
  Returns the condition.
getCondition() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the condition that is evaluated right before the action is taken to determine if the action is executed further.
getCondition() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the rule criteria.
getCondition() - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
  Returns the condition evaluation unit
getCondition() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the condition applied to the target object type ( `IWFObjectsEval.getObjectType()` ).
getCondition() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the workflow condition.
getCondition() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the condition that tells if this transition is available for users to select on the task view.
getConditionReport() - Method in exception com.ibm.openpages.api.rule.TBRuleException
  Returns the `WFConditionReport` which contains all the validation results od the criteria in the rule definition.
getConditionReport() - Method in exception com.ibm.openpages.api.workflow.WFException
  Returns the `WFConditionReport` which contains all the validation results in the transition of a process definition.
getConditions() - Method in interface com.ibm.openpages.api.configuration.IFindGroupCondition
  Returns sub conditions
getConditions() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
  Returns the condition of FLSRule.
getConditions() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the condition of RLSRule.
getConditions() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
  Get the filter conditions.
getConditions() - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
  Returns the grouped child conditions when the type is `RespViewRuleConditionType.conditions`
getConditions() - Method in interface com.ibm.openpages.api.workflow.IWFAdvancedLogicConditionEval
  Returns list of conditions
getConditions() - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
  Returns the search conditions
getConditions() - Method in interface com.ibm.openpages.api.workflow.IWFConditionGroupEval
  Returns list of conditions
getConfigProperties() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve configuration properties.
getConfigurationFactory() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Get an instance of IConfigurationFactory.
getConfigurationItem(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfiguration
  Get the field definitions for the specified name.
getConfigurationItems() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfiguration
  Get the field definitions that describe the job's configuration
getConflictBehavior() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
  Gets the conflict resolution behavior for this copy operation.
getConflictBehavior() - Method in class com.ibm.openpages.api.application.MoveObjectOptions
getConflictBehavior() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  Gets the conflict resolution behavior for this copy operation.
getContainees(ContaineeFilter) - Method in interface com.ibm.openpages.api.resource.IFolder
  Returns contained object based on the supplied filter.
getContainees() - Method in interface com.ibm.openpages.api.resource.IFolder
  Returns contained objects including both folders and GRCObjects with all fields, and for all types, based on the reporting period of the folder.
getContent() - Method in interface com.ibm.openpages.api.resource.IDocument
  Returns the file content for this document.
getContentLength() - Method in interface com.ibm.openpages.api.resource.IDocument
  Returns the length of the content associated with this document.
getContentTypeId() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get the object type.
getContext() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the API context
getContext() - Method in interface com.ibm.openpages.api.service.IServiceFactory
  Returns the `Context` used to create this `IServiceFactory`
getContext() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
  Provides access to the API context object.
getContext() - Method in class com.ibm.openpages.api.workflow.actions.AbstractCustomAction
getContext() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomAction
  Returns the operation context for the action.
getContext(HttpServletRequest) - Method in class com.ibm.openpages.ext.rest.BaseExtController
  Attempts to retrieve or initialize a new GRC API Context using the Http Request object.
getContextualActivityIds() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Returns a list of activity ids relevant to the result set.
getContextualActivityLabels() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Returns a list of activity labels relevant to the result set.
getContextualObjectTypes() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Returns a list of object type ids relevant to the result set.
getContextualProcessDefinitions() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Returns a list of process definition ids relevant to the result set.
getControllerField() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
  Gets the Field Definition for this Controller field.
getControllerName() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the controllerName if set directly on the dependency.
getControllerPath() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
  Returns path of the controlling object.
getControllers() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
  Returns the fields and their values that control the state of the current IFieldDefinition for this dependency type.
getControllers() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency
  Returns the fields and their values that control the state of the current IQuestion.
getControllers() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the list of controllers set on the rule.
getControllerType() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
getControllerValues() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
  Gets all Controlling values.
getControllerValues() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
  Gets all the Controlling values.
getCopiedObjectId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  Returns the Id of the copied object in this event.
getCopyFromProgramId() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
getCopyFromTemplateId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The Id of the copy from Questionnaire Template object used by the Program.
getCopyObjectOptions() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the copy object options if they are available for the current action.
getCount() - Method in interface com.ibm.openpages.api.workflow.IWFResultCount
  Returns the count value.
getCreatedBy() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the creator (user) of the process.
getCreatedBy() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the user name who created the rule definition
getCreatedBy() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the user name who created the job detail
getCreatedBy() - Method in interface com.ibm.openpages.api.tag.ITag
getCreatedBy() - Method in interface com.ibm.openpages.api.theme.ITheme
getCreatedBy() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the user name who created the process instance
getCreatedBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the user name who created the process instance
getCreatedBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the user name who created the process definition
getCreatedBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the name of the actor that performed the event.
getCreatedById() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The creator (user) id of querying processes.
getCreatedDate() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.tag.ITag
getCreatedDate() - Method in interface com.ibm.openpages.api.theme.ITheme
getCreatedDate() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the creation date
getCreatedDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the datetime the event occurred.
getCreatedOn() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the created time of the process.
getCreatedOn() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns creation date.
getCreatedOnBegin() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The begin of the created time of querying processes.
getCreatedOnEnd() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The end of the created time of querying processes.
getCreatedResource() - Method in class com.ibm.openpages.api.trigger.events.CreateResourceEvent
  If available, as in a POST event, Returns the created resource object that was the result of this create event i.e.
getCreateObjectName() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the evaluation to determine the name of an object to be created by the `WFactionType#createObjects` action.
getCreateObjectType() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the object type of the object to be created by the `WFactionType#createObjects` action.
getCreationDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getCreationDate() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the creation date of this resource.
getCreationDate() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the creation date of this resource.
getCreationDate() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the creation date of this resource.
getCreator() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the creator id of this resource.
getCreator() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the creator (user) of this resource.
getCriticality() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get the criticality.
getCriticality() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the ciriticality of the process instance.
getCronExpression() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the CRON expression for the schedule
getCurrencies(boolean) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieves a list of ICurrency objects that are available in the configuration.
getCurrency() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
  Returns the currency for which the exchange rate applies.
getCurrency(ISOCurrencyCode) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve currency information for the specified currency code.
getCurrencyCode() - Method in interface com.ibm.openpages.api.configuration.ICurrency
  Returns the ISO 4217 currency code.
getCurrencyValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as a `Double`
getCurrentActivityInstance() - Method in interface com.ibm.openpages.api.workflow.IWFProcess
  Returns an `IWFActivityInstance` for the current activity.
getCurrentExchangeRate(ICurrency) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the current exchange rate for the currency.
getCurrentPasswordPolicy() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves current OpenPages password policy.
getCurrentReportingPeriod() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the "current" reporting period.
getCurrentUser() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Returns the currently logged in user.
getCustomAction() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the custom action object.
getDashboard(Id, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a dashboard view
getDashboard(Id, String, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a dashboard view
getDashboards() - Method in class com.ibm.openpages.api.respview.DashboardList
  Returns the list of dashboards being fetched
getDashboards(IFindOptions, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Searches the dashboard views that meets the filter criteria with paging and sorting
getData() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
getDataType() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
  Gets the data type of the column.
getDataType() - Method in interface com.ibm.openpages.api.application.IParameter
  Gets the data type of the parameter.
getDataType() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the data type part of the property definition.
getDataType() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the `DataType` for this input parameter
getDataType() - Method in interface com.ibm.openpages.api.resource.IField
  Returns the data type for this field.
getDate() - Method in class com.ibm.openpages.api.search.DateFacetParam
  Get the date facet data formated for Solr usage.
getDate() - Method in interface com.ibm.openpages.api.workflow.IWFResultDateCount
  Returns the date value.
getDateAlterOperation() - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
  Returns operation to alter the date
getDateChanged() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the role assignment changed date.
getDateChanged() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns role template changed date.
getDateCreated() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the role assignment creation date.
getDateCreated() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns the role template creation date.
getDates() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
  Get the facet value(s) for date(s).
getDateValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as a `Date`
getDateValue() - Method in interface com.ibm.openpages.api.workflow.IWFSearchSimpleCondition
getDay() - Method in interface com.ibm.openpages.api.workflow.IWFResultDateCount
  Returns the grouped by day of the year.
getDaysAddition() - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
  Returns days addition evaluation unit.
getDefaultFilterRules() - Method in interface com.ibm.openpages.api.respview.IRespView
  Gets the filter information for a grid view
getDefaultMaxRows() - Method in interface com.ibm.openpages.api.service.IQueryService
  Returns the default maximum number of rows to return.
getDefaultOptions() - Static method in class com.ibm.openpages.api.application.CopyObjectOptions
  Constructs a new instance of CopyObjectOptions with default parameters:
  - includeChildren = true
  - ChildrenTypesToCopy = ALL
  - conflictBehavior = CopyConflictBehavior.CREATECOPYOF
getDefaultOptions() - Static method in class com.ibm.openpages.api.application.MoveObjectOptions
  Constructs a new instance of MoveObjectOptions with default parameters.
getDefaultProfile() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the system's default profile.
getDefaultTheme() - Method in interface com.ibm.openpages.api.service.IThemeService
  Returns the theme currently marked as 'default'
getDefaultTimeSeconds() - Method in interface com.ibm.openpages.api.process.IProcessType
  Returns the default time seconds of the process type.
getDefaultValue() - Method in interface com.ibm.openpages.api.application.IParameter
  Gets the default value set for this parameter in the report.
getDefaultValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the default value for this field when specified in the model.
getDefaultValue() - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
  Returns the default value evaluation unit
getDefinition() - Method in interface com.ibm.openpages.api.configuration.IProfile
  Returns the profile definition in XML format.
getDependencies() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the list of all dependencies for this field.
getDependencyType() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
  Returns the dependency type (PICKLIST, VISIBILITY, EDITABILITY, REQUIREDNESS).
getDependentValues(String) - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
  For FieldDependencyType: PICKLIST, the Controller Field's value will be mapped to a List of EnumValues that are from the Dependent Field.
getDescendantEnumValuesByParentId(Id) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the IEnumValue by its Id.
getDescendantEnumValuesByParentName(String) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the IEnumValue by its system name.
getDescription() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
  Returns the description of FLSRule.
getDescription() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getDescription() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the description of RLSRule.
getDescription() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns description of this enumerated value.
getDescription() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the system level description of the property.
getDescription() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the system type description part of the model.
getDescription() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getDescription() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the description of the process.
getDescription() - Method in interface com.ibm.openpages.api.process.IProcessType
  Returns the description of the process type.
getDescription() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the description of this questionnaire resource.
getDescription() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
getDescription() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the description of this resource.
getDescription() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the description of this resource.
getDescription() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the description of the responsive view.
getDescription() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Get the description of the rule
getDescription() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the description of the job detail
getDescription() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the description of the schedule
getDescription() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the description of this resource.
getDescription() - Method in class com.ibm.openpages.api.security.GroupInfo
  Gets the description for the user group.
getDescription() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
  Returns descriptive text for an application permission.
getDescription() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns descriptive information about the security group.
getDescription() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns descriptive text for this role template.
getDescription() - Method in interface com.ibm.openpages.api.security.IUser
  Returns description information about the account.
getDescription() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
  Get Description
getDescription() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the description of the solution
getDescription() - Method in interface com.ibm.openpages.api.tag.ITag
getDescription() - Method in interface com.ibm.openpages.api.theme.ITheme
getDestinationName() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  Returns the destination name for the copied resource for this event.
getDirection() - Method in class com.ibm.openpages.api.configuration.SortField
  Returns the sorting direction
getDisableAllTriggers() - Method in class com.ibm.openpages.api.Context
  Returns whether all triggers are disabled or not.
getDisplayName() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the display name according to application text information com.display.name.format
getDisplayName(Locale) - Method in interface com.ibm.openpages.api.security.IUser
  Returns the display name according to application text information com.display.name.format on the specified locale
getDisplayType() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
  Retrieves the displayType information for this field.
getDisplayTypeAttributes() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns display-type attributes defined on the field definition, or null if it is not set.
getDueDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
getDueDate() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the due-date to set by the workflow action.
getDueDate() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the due date of the activity instance.
getDueDate() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the date the workflow task is due
getDueDate() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationFindOptions
  Get the due date filter
getDueDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the due date of the process instance.
getDueDateCategoryColors() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns due-date category colors
getDueDateCounts() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
getDueDateCountsGroupByField() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
  Returns the groupByField value.
getDueDateCountsScope() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
  Returns the DateScope used for grouping counts.
getDueSoonCutoff() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the due to cut off in week
getDueSoonCutoff() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the due to cut off in week
getEffectivePermissions(Id, Id) - Method in interface com.ibm.openpages.api.service.IResourceService
  Retrieves the effective resource permissions, read, write, delete, and associate that a user has for a specific OpenPages resource.
getEmail() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
  Get Email
getEmailAddress() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns the email address associated with a security group.
getEmailAddress() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the email address associated with a user.
getEmailOption() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
getEndDate() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
getEndDate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
  Returns the end date of the applicability period of an exchange rate.
getEndRow() - Method in class com.ibm.openpages.api.process.ProcessLogQueryOptions
  Gets the paging end row index (1-based).
getEndRow() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
  Gets the paging end row index.
getEndTime() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the end time of the process log.
getEndTime() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the end time for the schedule
getEnumAnswers() - Method in interface com.ibm.openpages.api.resource.IEnumAnswersField
  Returns the ordered values of an enumerated answers field.
getEnumValue(String) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the IEnumValue by its system name.
getEnumValue(String, boolean) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the IEnumValue by its system name.
getEnumValue() - Method in interface com.ibm.openpages.api.resource.IEnumField
  Returns the field value as an element of an enumeration.
getEnumValueById(Id) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the IEnumValue by its Id.
getEnumValueColors() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes
  Returns colors for enum values on the responsive view.
getEnumValueColors() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the map that represents colors for enumerated values, or null if it is not set.
getEnumValues() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the list of `IEnumValue` for all the elements that are part of an enumeration.
getEnumValues() - Method in interface com.ibm.openpages.api.resource.IMultiEnumField
  Returns the value of a multi-selectable enumerated field.
getErrorMessage() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getErrorMessage() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getErrorMessageId() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the id of the error code of the process log.
getErrorMessageId() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getErrorMessageId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns an error message id for exception events.
getErrorMessageId() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getErrorMessageParameters() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getErrorMessageParameters() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getErrorParams() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns a delimited list of parameters for the error message.
getEstimatedTotalResults() - Method in interface com.ibm.openpages.api.search.ISearchResults
  Gets the estimated total number of results matching the provided search terms.
getEvals() - Method in interface com.ibm.openpages.api.workflow.IWFListEval
  Returns the list of evaluation unit
getEvalType() - Method in interface com.ibm.openpages.api.workflow.IWFEvalUnit
  Returns type of evaluation type
getEvaluateComputedFields() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns whether computed fields are evaluated
getEvaluationResults() - Method in class com.ibm.openpages.api.workflow.WFConditionReport
getEvaluationUnit() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getEventForName(String) - Static method in enum com.ibm.openpages.api.trigger.events.TriggerEventType
  Returns the supported trigger event type, provided the standard name.
getExchangeRate() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
  Returns the exchange rate.
getExchangeRate(ICurrency, Date) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the exchange rate for the currency on a particular date.
getExchangeRate() - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
  Returns evaluation unit for exchange rate.
getExchangeRateHistory(ICurrency) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the exchange rate history for the currency.
getExchangeRates(boolean) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the exchange rates for all currencies based on the parameter.
getExpr() - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
  Returns the 'expr' evaluation unit
getExpression() - Method in interface com.ibm.openpages.api.workflow.IWFCalculationEval
getExpressionSummary() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the CRON expression in English
getFacetOption() - Method in class com.ibm.openpages.api.search.SearchOptions
  The list of types, identified by their Id, to scope the search.
getFactory() - Static method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory
  Returns new instance of GRCTriggerEventFactory
getFail() - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
  Returns the evaluation unit that is executed when the condition is NOT met
getField(String) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the field definition with the specified system name.
getField(Id) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the field definition with the specified Id.
getField(int) - Method in interface com.ibm.openpages.api.query.IResultSetRow
  Directly access the value of the designated column in this IResultSetRow object as an IField object.
getField() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter.FilterCondition
  Get the field name.
getField(String) - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns a field based on its system name, if it exists.
getField(Id) - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns a field based on its field definition Id.
getField() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Gets the name of the field being compared in the case where field is not implicit (i.e.
getField(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Returns a Field Definition by propertyid.
getField(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Returns the field definition with the specified system name.
getField() - Method in interface com.ibm.openpages.api.workflow.IWFFieldSetter
  Gets target field to set.
getField() - Method in interface com.ibm.openpages.api.workflow.IWFObjectFieldEval
  Returns the object field to look up, such as "OPSS-Ctl:Control Owner".
getFieldAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a list of FieldAuditLogs for a given GRCObject Id.
getFieldAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
  Retrieves a list of FieldAuditLogs for a given GRCObject Id.
getFieldDefinition() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
  Returns the Field Definition for IFLSRule.
getFieldDefinition() - Method in interface com.ibm.openpages.api.resource.IField
  Returns the field definition.
getFieldDefinition() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the field definition of the responsive view field or null.
getFieldDefinition() - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
  Returns the field definition to evaluate when the type is field conditions `RespViewRuleConditionType.isFieldCondition()`
getFieldFilters() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
  Returns a unique list of field definition used as filters.
getFieldFilters() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
  Returns a unique list of field definition filters.
getFieldFilters() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns a unique list of field definition used as filters.
getFieldGroup() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getFieldGroup() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getFieldId() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getFieldName(String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Gets the name of the Field from the bundleFieldPath.
getFieldName() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
  Get the name of the configuration field
getFieldNames() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the names of the fields used by a dashboard component (i.e.
getFields() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns the list of fields that compose this object.
getFields() - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
  Returns the list of responsive view fields
getFields() - Method in interface com.ibm.openpages.api.respview.IRespViewHeader
  Returns the list of responsive view fields
getFields() - Method in interface com.ibm.openpages.api.respview.IRespViewSection
  Returns the list of responsive view fields
getFields() - Method in class com.ibm.openpages.api.workflow.actions.AbstractCustomAction
getFields() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomAction
  Returns the list of field objects.
getFields() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
  Returns a list of field setter objects.
getFieldsDefinition() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns all field definitions part of this type definition.
getFieldSetters() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the field setter to run by the workflow action.
getFieldType() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns type of the responsive view field.
getFieldType() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
  Get the type of the configuration field
getFieldVal() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getFieldValue() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
  Get the value of the field
getFileExtension() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
  Returns file extension.
getFilename() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getFileSize() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getFileType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Return a supported file type based on the file extension.
getFileType(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Return a supported file type based on it's Id.
getFileType(String, String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Gets a file type from the set of all possible file types defined in the OpenPages instance for a given mime type and extension combination.
getFileTypeByMimeType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Return a supported file type based on mime type.
getFileTypeDefinition() - Method in interface com.ibm.openpages.api.resource.IDocument
  Returns the file type definition.
getFileTypes() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns all the valid combinations of file extensions and MIME types defined for this type.
getFilterId() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the filter Id
getFilterId() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the filter Id
getFilterRules() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the filter definition for this action (only for associate, associatePrimary, and copyRecursive actions).
getFinalizedDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getFirstName() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the first name of the user.
getFirstName() - Method in class com.ibm.openpages.api.security.UserInfo
  Gets first name.
getFirstNotification() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the number of days before the task's due date on which to send the first notification for the task
getFirstNotification() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
  Get the number of days before the task's due date on which to send the first notification for the task
getFixPackVersion() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns fixpack version number of the solution
getFloatValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as a `Double`
getFlsRules() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
  Returns the list of IFLRule applied to a specific TypeDefinition.
getFolder() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the folder name that limits the set of objects this action refers to
getFolder() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the folder that is the scope of the object permissions assignment.
getFolder(String, FolderFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a Folder object by path.
getFolder(String) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a Folder object by path for the current period.
getFolder(Id, FolderFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a Folder object by Id.
getFolder(Id) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a Folder object by Id for the current period.
getFolderDepth() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the maximum depth that will be applied to the set of objects that this action represents
getFolderPath() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
  Get the facet value for folder path.
getFrom() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the from email address
getFromAddress() - Static method in class com.ibm.openpages.api.application.EmailUtil
getFullName() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
  Returns a full path name associated with an application permission.
getFullPath(String, boolean, List<ITypeDefinition>) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns full resource path provided relative path, boolean isFolder, and list of all ITypeDefinitions.
getFullPath(ContentType, String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
getFullPath(String, boolean, ITypeDefinition) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns full resource path provided relative path, boolean isFolder and the ITypeDefinition for the GRCObject.
getGRCObject(String, GRCObjectFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a GRC object by path with specified filter for fields and associations.
getGRCObject(String) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a GRC object by path for the current period including all fields and no associations.
getGRCObject(String, IncludeAssociations) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a GRC object by path for the current period including all fields and associations.
getGRCObject(Id, GRCObjectFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a GRC object by ID with specified filter for fields and associations.
getGRCObject(Id) - Method in interface com.ibm.openpages.api.service.IResourceService
  Get a GRC object by Id for the the current period including all fields and no associations.
getGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns `IGroup` of the security domain on which this administrative permission applies.
getGroup(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves group by Id.
getGroup(Id, GroupOptions) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves group by Id.
getGroup(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves group by name.
getGroup(String, GroupOptions) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves group by name.
getGroupByAttribute() - Method in interface com.ibm.openpages.api.workflow.IWFResultCount
  Returns the group by attribute.
getGroupByValue() - Method in interface com.ibm.openpages.api.workflow.IWFResultCount
  Returns the group by value.
getGroupIds() - Method in interface com.ibm.openpages.api.security.IUser
  Returns a list of group Ids that the user belongs to.
getGroups() - Method in interface com.ibm.openpages.api.security.IUser
  Returns all the groups the user belongs to.
getGroups(boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves groups from the OpenPages security system.
getGuidance() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the responsive view guidance
getGuidanceOverride() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the guidance of the task focused user interface to override help topic and help text, including localized ones.
getHeader() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the responsive view header
getHelpText() - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
  Returns the help text for the field.
getHelpTextLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
  Returns the field help text labels for all locales.
getHelpTopic() - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
  Returns the help topic for the field.
getHelpTopicLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
  Returns the field help topic labels for all locales.
getHighValue() - Method in interface com.ibm.openpages.api.workflow.IWFSearchRangeCondition
  Returns the high condition value
getHonorPrimary() - Method in interface com.ibm.openpages.api.query.IQuery
  Returns true to honor primary association; otherwise, false is returned.
getHonorPrimary() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the flag to look up only primary relationships.
getI18NKeyId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns a I18N key for a localized message.
getId() - Method in interface com.ibm.openpages.api.audit.IAuditLog
  Gets the Id of the object.
getId() - Method in interface com.ibm.openpages.api.configuration.ICurrency
  Returns id associated to a currency.
getId() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
  Returns the id associated to an exchange rate.
getId() - Method in interface com.ibm.openpages.api.configuration.IProfile
  Returns the profile unique Id.
getId() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getId() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
  Returns the Id of the association.
getId() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns `Id` - unique identifier of the enum value.
getId() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the unique id associated with the field definition.
getId() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
  Return the unique Id associated with the file type definition.
getId() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the unique identifier for this type.
getId() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getId() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getId() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the Id of this questionnaire resource.
getId() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
  Returns the id of this node.
getId() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the Id of this resource.
getId() - Method in interface com.ibm.openpages.api.resource.IField
  Returns the id for this field.
getId() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the Id of this resource.
getId() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the unique identifier for this responsive view.
getId() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Returns unique identifier of the rule action definition
getId() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns unique identifier of the rule definition
getId() - Method in enum com.ibm.openpages.api.rule.TBRuleActionType
getId() - Method in enum com.ibm.openpages.api.rule.TBRuleDefinitionCategory
getId() - Method in enum com.ibm.openpages.api.rule.TBRuleDefinitionState
getId() - Method in enum com.ibm.openpages.api.rule.TBRuleDefinitionType
getId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
  Get the Id of the job field configuration
getId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns unique identifier of the job detail
getId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
  Returns unique identifier of this `ISchedJobInstance`
getId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Returns unique identifier of the job schedule
getId() - Method in enum com.ibm.openpages.api.scheduler.JobDetailCategory
getId() - Method in enum com.ibm.openpages.api.scheduler.JobDetailType
getId() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the Resource Id of this resource.
getId() - Method in interface com.ibm.openpages.api.security.IAdminPermission
  Returns the Id for this administrative permission.
getId() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
  Returns the Id associated with an application permission.
getId() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns the Id for this object-level permission.
getId() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the Id of the assignment.
getId() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns the Id for this role template.
getId() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns the Id for a security principal.
getId() - Method in interface com.ibm.openpages.api.security.IUser
  Returns OpenPages system Id of the user.
getId() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns local unique identifier of the solution
getId() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns local unique identifier of the solution layout
getId() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the id of this object.
getId() - Method in enum com.ibm.openpages.api.solution.SolutionLayoutType
getId() - Method in enum com.ibm.openpages.api.solution.SolutionType
getId() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getId() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns unique identifier of the process definition
getId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the activity instance
getId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the ID of the activity notification instance
getId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the identifier of the process instance.
getId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns unique identifier of the process definition
getId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the id of the event.
getId() - Method in enum com.ibm.openpages.api.workflow.WFAccessType.WFRole
getId() - Method in enum com.ibm.openpages.api.workflow.WFActivityInstanceState
getId() - Method in enum com.ibm.openpages.api.workflow.WFActivityType
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessCriticality
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessDefinitionState
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessDefinitionType
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessEventType
  Returns the internal id for the event type.
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessState
getId() - Method in enum com.ibm.openpages.api.workflow.WFProcessType
getId() - Method in enum com.ibm.openpages.api.workflow.WFRelationalOperatorType
getId() - Method in enum com.ibm.openpages.api.workflow.WFTransitionCommentRequirementType
getIdForPath(String) - Method in interface com.ibm.openpages.api.service.IResourceService
  Retrieves just the Id for a GRC Object or Folder given a full path without retrieving the entire object.
getIgnoreError() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets whether to continue sending out emails when an error occurred
getInclAssociationForReturnObjs() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
  Gets the association filter value for returned GRCObjects.
getIncludeActiveWorkflows() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns whether ids of active workflows are included
getIncludeAssociations() - Method in class com.ibm.openpages.api.resource.AssociationFilter
  Returns the include associations type.
getIncludeCalcStatus() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns whether to include calculation status.
getIncludeContainees() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
  Returns the type of containees included.
getIncludeDisabledJobs() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Gets whether to return jobs that are disabled.
getIncludeDisabledRules() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Gets whether to return rules that are disabled.
getIncludeEnabledJobs() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Get enabled.
getIncludeEnabledRules() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get enabled.
getIncludeOrphanField() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns whether orphan fields are included
getIncludeTotalCount() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Get the include total count of the search results.
getIncludeTotalCount() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the include total count of the search results.
getIndex() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the index of the enum value.
getInstances() - Method in class com.ibm.openpages.api.scheduler.SchedulerJobInstanceList
  Get the list of `ISchedJobInstance` results based on the Search options provided
getIntegerValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as an `Integer`
getInternalObjId() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getIntValue() - Method in interface com.ibm.openpages.api.workflow.IWFSearchSimpleCondition
  Returns the condition value
getInvertMatch() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns the flag to invert the result of this condition.
getIsDefault() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns the default state of the responsive view that is used for filtering
getIsEnabled() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns the enabled state of the responsive view that is used for filtering
getIsHierarchical() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns true if the field is a hierarchical enum data type
getIsManual() - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
  Get isManual
getIsPagingOn() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Returns if Paging is On on the search results
getIsSuppliedByVendor() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns the supplied-by-vendor state of the responsive view that is used for filtering
getJob(Id) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJob(String) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobClass() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the fully qualified name of the java class associated with the job detai.
getJobClass() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Get the job class.
getJobConfiguration() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Get the job configuration `ISchedJobConfiguration`
getJobConfiguration(Id) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
  Get the Id of the job to which this configuration field belongs
getJobId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
getJobId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the Id of the job to which this schedule belongs
getJobId() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Get the job id.
getJobId() - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
  Get Job ID
getJobInstanceProcId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
getJobInstances(Id) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobInstances(ISchedulerJobInstanceFindOptions) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobName() - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
  Get the job name.
getJobs() - Method in class com.ibm.openpages.api.scheduler.SchedulerJobList
  Get the list of `ISchedJobDetail` results based on the Search options provided
getJobs() - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobs(IScheduleJobFindOptions) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getJobScheduleId() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
getJspPath() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the path for a JSP resource associated to this type definition.
getKey() - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval.IWFSwitchCase
  Returns the 'key' evaluation unit
getLabel() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getLabel() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
getLabel() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionTableColumn
getLabel() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the label for static link
getLabel() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns a localized string describing the event.
getLastManualRun(Id, String) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getLastModifiedBy() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the user id who last modified this resource.
getLastModifiedBy() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the user who last modified this resource.
getLastModifiedBy() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the user who last modified the responsive view.
getLastModifiedDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
getLastModifiedDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
getLastName() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the last name of the user.
getLastName() - Method in class com.ibm.openpages.api.security.UserInfo
  Gets last name.
getLastNotificationSent() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the date of the last notification sent for this workflow task to the assignee and subscriber
getLastScheduledRun(Id, String) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getLastTransition() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the last transition
getLastTransitionBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the user name who processed the last transition
getLastTransitionComment() - Method in interface com.ibm.openpages.api.workflow.IWFProcess
  Returns the comment provided by the user on the last transition.
getLastTransitionComment() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the comment provided by the user on the last transition.
getLastTransitionDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the last transition date
getLatestProcess(Id) - Method in interface com.ibm.openpages.api.service.IProcessService
  Get latest process information of a specific process type.
getLatestVersionId() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the id of the latest solution version
getLatestVersionInstalledDate() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the date the latest version was installed.
getLatestVersionNumber() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns version number of the latest rule definition.
getLatestVersionNumber() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns version number of the latest process definition.
getLatestVersionState() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Gets the state of the latest version of the rule - draft/published
getLatestVersionState() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the state of the latest process definition.
getLaunchType() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the action's launch type
getLeftValue() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns evaluation unit for the left-side operand of the relation
getLevel() - Method in class com.ibm.openpages.api.security.GroupInfo
  Gets the level for the user group.
getLevel() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the level of relationships to look up.
getLifecycleAssigneeField(IGRCObject) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getLifecycleNameFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleStageFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleStatusFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleTransitionFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLifecycleUpdateAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getLinkBuffer() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the string buffer for a URL that points to the object in OpenPages
getLinkLabels() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the static link labels for all locales
getLocalAmount() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
  Returns the local amount.
getLocalAmount() - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
  Returns evaluation unit for local amount.
getLocalCurrency() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
  Returns the local currency.
getLocalCurrency() - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
  Returns evaluation unit for local currency.
getLocale() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the locale to get translated application texts for subject and body
getLocale() - Method in interface com.ibm.openpages.api.metadata.ILabel
  Returns the locale of the label
getLocale() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns locale information associated with the security principal.
getLocale() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
  Get Locale
getLocalizedApplicationText(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the translated string associated with the key.
getLocalizedApplicationText(Id) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the translated string associated with the key id.
getLocalizedApplicationText(String, Locale) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the translated string associated with the key and the locale.
getLocalizedApplicationTexts(Set<String>) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve list of application text for the given categories, or for every category if given categoryFilters is empty.
getLocalizedApplicationTexts(Set<String>, Locale) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve list of application text for given locale and for the given categories, or for every category if given categoryFilters is empty.
getLocalizedErrorText(int) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve the translated error message associated with the error code.
getLocalizedGuidance() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the field guidance in the user locale.
getLocalizedGuidances() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the map of the field guidance in every locale
getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the localized name of the enum value.
getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the field definition name in the user locale.
getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the type definition singular name in the user locale.
getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the map of the field definition name in every locale
getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the map of the field definition name in every locale
getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the map of the type definition singular name in every locale
getLocalizedMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
  Returns the localized message of this exception.
getLocalizedPluralLabel() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the type definition plural name in the user locale.
getLocalizedPluralLabels() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the map of the type definition plural name in every locale
getLockObjects() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns whether the action should lock the target objects (if false, unlock).
getLog() - Method in class com.ibm.openpages.api.rule.TBCalcLog
  Returns an `OpenPagesException` object that represents the error/warning
getLogger(Class<?>) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns Logger instance.
getLogger(String) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns Logger instance.
getLogger() - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns Logger instance.
getLogger() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getLoggerFactory() - Static method in class com.ibm.openpages.api.logging.LoggerFactory
  Returns `ILoggerFactory` instance.
getLogicalOperator() - Method in interface com.ibm.openpages.api.configuration.IFindGroupCondition
  Returns logical operator
getLogicalOperator() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
  Returns the logical operator used to group conditions from controllers (AND, OR).
getLogicalOperator() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency
  Returns the logical operator used to group conditions from controllers (AND, OR).
getLogicalOperator() - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
  Returns the logical operator type of the condition when the type is `RespViewRuleConditionType.conditions`
getLogicalOperator() - Method in interface com.ibm.openpages.api.workflow.IWFConditionGroupEval
  Returns logical operator type ( "AND" or "OR" )
getLogicalOperators() - Method in interface com.ibm.openpages.api.workflow.IWFAdvancedLogicConditionEval
  Returns logical operator application ( "AND", "OR", and "NOT" )
getLogicalOperatorType() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the security rules logical operator.
getLogicOperators() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getLowValue() - Method in interface com.ibm.openpages.api.workflow.IWFSearchRangeCondition
  Returns the low condition value
getMajorVersion() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns major version number of the solution
getMax() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
  Upper bound of the cardinality associated with this association definition.
getMaxLength() - Method in interface com.ibm.openpages.api.security.IPasswordPolicy
  Returns the maximum length for a password.
getMaxResults() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the Maximum results for the search results
getMaxRiskScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns maximum risk score of the question.
getMaxRiskScore() - Method in interface com.ibm.openpages.api.questionnaire.ISection
getMaxRows() - Method in interface com.ibm.openpages.api.query.IQuery
  Specifies the maximum number of rows to return as part of the `ITabularResultSet`.
getMaxValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the maximum allowable value for this field when specified in the model.
getMembers(boolean) - Method in interface com.ibm.openpages.api.security.IGroup
  Returns all members of a security group.
getMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
  Returns the message of this exception.
getMessage() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns a string describing the event.
getMiddleName() - Method in interface com.ibm.openpages.api.security.IUser
  Returns the middle name of the user.
getMiddleName() - Method in class com.ibm.openpages.api.security.UserInfo
  Gets middle name.
getMimeType() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
  Returns the MIME type of the file.
getMimeTypeIDs() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
  Get the facet value for MIME type.
getMin() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
  Lower bound of the cardinality associated with this association definition.
getMinLength() - Method in interface com.ibm.openpages.api.security.IPasswordPolicy
  Returns the minimum length for a valid password.The default value is 6.
getMinorVersion() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns minor version number of the solution
getMinValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the minimum allowable value for this field when specified in the model.
getMlModels() - Method in interface com.ibm.openpages.api.respview.IRespViewField
getMode() - Method in class com.ibm.openpages.api.search.SearchOptions
  The search mode either BASIC or ADVANCED.
getModifiedBy() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the user name who last modified the rule definition
getModifiedBy() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the user name who last modified the job detail
getModifiedBy() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Returns the user name who last modified the job schedule
getModifiedBy() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the user name who last modified the process definition
getModifiedBy() - Method in interface com.ibm.openpages.api.tag.ITag
getModifiedBy() - Method in interface com.ibm.openpages.api.theme.ITheme
getModifiedBy() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the user name who last modified the process instance
getModifiedBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the user name who last modified the process instance
getModifiedBy() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the user name who last modified the process definition
getModifiedDate() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the last modified date of this resource.
getModifiedDate() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the last modified date of this resource.
getModifiedDate() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the last modified date of the responsive view.
getModifiedDate() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobInstance
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the last modified date of this resource.
getModifiedDate() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the last date the solution was updated.
getModifiedDate() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns the last date the solution layout was updated.
getModifiedDate() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.tag.ITag
getModifiedDate() - Method in interface com.ibm.openpages.api.theme.ITheme
getModifiedDate() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the last modified date
getModifiedDate() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the last modified date
getModifiedFields(IGRCObject) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Gets a list of Fields that have been modified on the GRCObject before it is saved (committed).
getModVersion() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns mod version number of the solution
getMonth() - Method in interface com.ibm.openpages.api.workflow.IWFResultDateCount
  Returns the grouped by month.
getName() - Method in interface com.ibm.openpages.api.application.IParameter
  Gets the name of the parameter as defined in a Cognos report specification.
getName() - Method in interface com.ibm.openpages.api.audit.IAuditLog
  Gets the name of the object.
getName() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
  Returns the name of an application text
getName() - Method in interface com.ibm.openpages.api.configuration.ICurrency
  Returns the descriptive name of a currency.
getName() - Method in interface com.ibm.openpages.api.configuration.IDisplayType
  Retrieves the display type name.
getName() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
  Returns the name of FLSRule.
getName() - Method in interface com.ibm.openpages.api.configuration.IProfile
  Returns the profile system name.
getName() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
  Returns the name of RLSRule.
getName() - Method in class com.ibm.openpages.api.configuration.SortField
  Returns the name of the column used for sorting
getName() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the system name of the enum value.
getName() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
  Returns the system name associated with the field definition.
getName() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the system name of the type definition.
getName() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getName() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the name of the process.
getName() - Method in interface com.ibm.openpages.api.process.IProcessType
  Returns the name of the process type.
getName() - Method in interface com.ibm.openpages.api.resource.IField
  Returns the system name for this field.
getName() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the name of this resource.
getName() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns name of the dashboard panel
getName() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns name of the dashboard tab
getName() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns name of the dashboard widget
getName() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Gets the action name
getName() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the system name of the responsive view.
getName() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRuleController
  Returns the name of the controller field (e.g., "OPSS-Ctl:Operating Effectiveness").
getName() - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
  Returns the name of the filter definition.
getName() - Method in interface com.ibm.openpages.api.respview.IRespViewSection
  Returns name of the responsive view section
getName() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns the name of the responsive view that is used for filtering
getName() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the name of the workflow action.
getName() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns name of the rule definition
getName() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns name of the job detail
getName() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the name of the schedule
getName() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the name of this resource.
getName() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
  Returns the name for this application permission.
getName() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns the name of this role template.
getName() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns the security principal name.
getName() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
  Get Name
getName() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the name of the solution
getName() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns the name of the solution layout
getName() - Method in interface com.ibm.openpages.api.tag.ITag
getName() - Method in interface com.ibm.openpages.api.theme.ITheme
getName() - Method in enum com.ibm.openpages.api.trigger.events.TriggerEventType
  Returns the event name for the enum
getName() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
  Returns the name of the property.
getName() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns name of the process definition
getName() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns name of the process definition
getName() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns name of the transition
getNameLabel() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the localized name label of the responsive view for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Returns the localized name label of the action for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the localized name label of the relationship field for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
getNameLabel() - Method in interface com.ibm.openpages.api.respview.IRespViewSection
  Returns the localized name label of the section for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the localized name label of the activity for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the localized name label of the process definition for the user session
getNameLabel() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the localized name label of the transition for the user session
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the panel name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns the tab name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the responsive view name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewAction
  Returns the action name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the responsive view field name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
getNameLabels() - Method in interface com.ibm.openpages.api.respview.IRespViewSection
  Returns the responsive view section name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the activity name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the process definition name labels for all locales
getNameLabels() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the transition name labels for all locales
getNameOverrides() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
  Specifies a name to set on the copy of each Id.
getNewName() - Method in class com.ibm.openpages.api.trigger.events.RenameResourceEvent
getNextFireTime() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
getNotification() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Get the notification details for the stage
getNotificationFrequency() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the frequency, in days, for sending notifications after the first one is sent
getNotificationFrequency() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
  Get the frequency, in days, for sending notifications after the first one is sent
getNotifyOversight() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Deprecated.
getNumberRangeColors() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes
  Returns color for specific range of integers on the responsive view.
getNumberRangeColors() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns list of `IDisplayTypeAttributes.INumberRangeColor`, or null if it is not set.
getObjectFieldOverrides() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the object fields of the task focused user interface to override visibility, editability, and importance.
getObjectIds() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getObjectOrder() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
  Retrieves this profile field's order number.
getObjectPermissions() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Retrieves all object permissions for this role template.
getObjectsInCalcQueue() - Method in class com.ibm.openpages.api.rule.TBCalcCounts
  The count of resources in the asynchronous calculation queue.
getObjectsWithCalcErrors() - Method in class com.ibm.openpages.api.rule.TBCalcCounts
  The count of resources with calculation errors.
getObjectType() - Method in interface com.ibm.openpages.api.audit.IAssociationAuditLog
  Returns the TypeDefinition of the object.
getObjectType() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the object type name.
getObjectType() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getObjectType() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the object type of the GRCObject in the context.
getObjectType() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the object type to look up.
getObjectType() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the object type name.
getObjectTypeIDs() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
  Get the facet value for object-types.
getObjectTypeName() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the object type name
getObjectTypeName() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the object type name
getOffset() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the offset (in days) that will be used when doing date field comparisons.
getOldValue() - Method in interface com.ibm.openpages.api.audit.IFieldAuditLog
  Returns the old value of the field.
getOperationName() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the current operation name which can be used by the error/information messages.
getOperator() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter.FilterCondition
  Get the condition operator
getOperator() - Method in interface com.ibm.openpages.api.workflow.IWFSearchSimpleCondition
  Returns conditional operator
getOptions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns list of `IQuestionOption` for a selection question.
getOptions() - Method in class com.ibm.openpages.api.trigger.events.MoveResourceEvent
getOrder() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the order integer of this questionnaire resource.
getOriginalValueForField(String, IGRCObject) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Gets the original value of an IField object by using bundleFieldPath.
getOriginatingProcessId() - Method in interface com.ibm.openpages.api.workflow.IWFProcess
  If this process was started by another process, this method returns the Id value of that process.
getOtherActors() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the other actors list when reached an end stage.
getOtherActors() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the list of user or groups who will be notified when reached an end stage.
getOutputMetaData() - Method in interface com.ibm.openpages.api.application.ICognosReportRowReader
  Gets the metadata that describes the column values in the report output as provided by the report output format.
getOverdueNotificationFrequency() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the frequency, in days, to send notifications once the task is overdue
getOverdueNotificationFrequency() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
  Get the frequency, in days, to send notifications once the task is overdue
getOwners() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the process oversight user/group names for the process instance.
getPageNum() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Returns the Page number that needs to be retrieved in the search results
getPageNum() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Returns the Page number that needs to be retrieved in the search results
getPageNum() - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
  Returns the Page number that needs to be retrieved in the search results when `IBaseFindOptions.getIsPagingOn()` is true
getPages() - Method in interface com.ibm.openpages.api.query.ITabularResultSet
  Returns pages of rows.
getPageSize() - Method in interface com.ibm.openpages.api.query.IQuery
  Returns the page size.
getPalette() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the field's color palette.
getPanels() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns the list of dashboard panels
getParameter(String) - Method in interface com.ibm.openpages.api.application.IReportParameters
  Gets the parameter information which has name, data type, default values, and values.
getParameters() - Method in interface com.ibm.openpages.api.configuration.IDisplayType
  Retrieves the parameters for the display type.
getParameters() - Method in exception com.ibm.openpages.api.OpenPagesException
getParametersForReport(String) - Method in interface com.ibm.openpages.api.service.IApplicationService
  Retrieve IReportParameters that contains all parameters a report expects for inputs.
getParameterValue(String) - Method in interface com.ibm.openpages.api.application.IReportParameters
  Gets the value for a specified parameter.
getParams() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The parameters of the warning message.
getParent() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
  Returns the "parent" type definition of this association.
getParent() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
  Returns the single parent Id for the parent object of this event.
getParent() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
  Returns the single parent Id for the parent object of this event.
getParent() - Method in class com.ibm.openpages.api.trigger.events.ReassignPrimaryParentEvent
  Returns the single parent Id for the parent object of this event.
getParentAssociations() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns all parent associations for this type definition (i.e., all other type definitions from which a direct navigation path to this type has been specified).
getParentFolder() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the parent folder for this resource, if it exists; otherwise null.
getParentFolderId() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the parent folder for this resource, if it exists; otherwise null.
getParentGroups() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns this group membership to other groups.
getParentId() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the parenid for hierarchical `IEnumValue`s, or null.
getParentId() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the Id of the parent resource for sub-sections and questions.
getParentId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the parent activity instance when the activity instance is created by the hierarchical launch operation.
getParentName() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
  Returns the parent name for the hierarchical `IEnumValue`, or null.
getParentProcessId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the creator (user) of the process.
getParentProcessId() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The parent process id of querying processes.
getParentRelationTypeDefinition() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the parent type definition of the responsive view field or null.
getParents() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns direct parent GRC Object associations defined by the AssociationFilter supplied to the `IResourceService.getGRCObject(Id, GRCObjectFilter)` and `IResourceService.getGRCObject(String, GRCObjectFilter)` methods.
getParents() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
  Returns the list of Ids of the parent objects of this event.
getParents() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
  Returns the list of Ids of the parent objects of this event.
getParentTypeId() - Method in class com.ibm.openpages.api.application.TypeAssociationToHonor
  Gets the non primary parent type Id of the TypeAssociationToHonor
getPass() - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
  Returns the evaluation unit that is executed when the condition is met
getPassword() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the password for authenticating into the SMTP server.
getPassword() - Method in class com.ibm.openpages.api.security.UserInfo
  Gets password.
getPasswordCreationDate() - Method in interface com.ibm.openpages.api.security.IUser
  Returns creation date for user password.
getPasswordExpiresInDays() - Method in class com.ibm.openpages.api.security.UserInfo
  Gets password expires in days.
getPath() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
  Returns the path of this node.
getPath() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the full path of this resource.
getPath() - Method in interface com.ibm.openpages.api.resource.IResource
  Returns the full path of this resource.
getPath() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the full path of this resource.
getPercentComplete() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the completed percent of the process.
getPermission() - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
  Returns the Permissions(read, write, delete, associate, create) applied on IRLSRule.
getPermissionIds() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns a list of Id for application permissions.
getPermissions() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Retrieves all application-level permissions for this role template.
getPermissions() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
  Returns an iterator on application permissions.
getPermissionType() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns the object type definition that this permission grants access to.
getPort() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the port number that identifies the SMTP server port.
getPosition() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
  Returns type of the trigger position.
getPosition() - Method in enum com.ibm.openpages.api.trigger.TriggerPositionType
  Returns the trigger position type as a String
getPostActions() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the list of actions performed right before the workflow transitions out of the activity.
getPreActions() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the list of actions performed right after the workflow transitions in to the activity.
getPrecision() - Method in interface com.ibm.openpages.api.configuration.ICurrency
  Returns the decimal precision for this currency.
getPreferredProfile() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the preferred profile for the current user.
getPreferredProfile(IUser) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the preferred profile for the specified user.
getPreviousActivityId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the previous activity instance when the activity instance is created.
getPreviousFireTime() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
getPrimaryParent() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns the primary parent GRCObject Id.
getProcess(Id) - Method in interface com.ibm.openpages.api.service.IProcessService
  Get the process information of a specific process.
getProcess(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves a process object for the given id.
getProcess() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
  Returns the process.
getProcessContext() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the process instance context.
getProcessCriticality() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the criticality to set by the workflow action.
getProcessDefinition(String, Id, boolean) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns a process definition by name, type definition ID
getProcessDefinition(Id, boolean) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns a process definition by ID
getProcessDefinition() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
  Returns the process definition.
getProcessDefinitionByVersionId(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns a process definition by the version ID
getProcessDefinitionId() - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
  Returns Id of the workflow definition to start.
getProcessDefinitions(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns the published and draft versions of the process definition if they exist.
getProcessDefinitions(IWFProcessDefinitionFindOptions) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Fetches list of process definitions based on the criteria defined by the `IWFProcessDefinitionFindOptions`
getProcessDefinitions() - Method in class com.ibm.openpages.api.workflow.WFProcessDefinitionList
  Get the list of `IWFProcessDefinition` results based on the Search options provided via {#link IWFProcessDefinitionFindOptions}
getProcessDefinitionState() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinitionFindOptions
  Returns the Process Definition state
getProcessDefinitionsToStartOn(IGRCObject) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns the list of process definitions that a user can start on the given resource.
getProcessEventLog(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves the list of process events for the given process id.
getProcessEventLog(Id, Id, List<WFProcessEventType>) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Retrieves process events for the given parameters.
getProcessId() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getProcessId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the id of the process.
getProcessId() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the id of the process.
getProcessId() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The process id to query.
getProcessId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the Id of the process the event occurred in.
getProcessInstanceId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the process instance
getProcessLabel() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the localized name of the workflow process for this notification
getProcessList(ProcessQueryOptions) - Method in interface com.ibm.openpages.api.service.IProcessService
  Query a list of processes.
getProcessLogId() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the id of the process log.
getProcessLogs(Id, ProcessLogQueryOptions) - Method in interface com.ibm.openpages.api.service.IProcessService
  Get process logs of a specific process.
getProcessName() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the name of the workflow process associated with this notification
getProcessOwners() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the oversight actors to apply by the workflow action.
getProcessStatus() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the process status massage to apply by the workflow action.
getProcessStatusLabel() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the localized processStatus label for the user session
getProcessStatusLabels() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the processStatus labels for all locales
getProcessToLaunch() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the workflow definition name to launch on the target object This is applicable only when the type is `WFActionType.launchNewProcess`.
getProcessType() - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
getProcessTypeId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the process type id of the process.
getProcessTypeId() - Method in interface com.ibm.openpages.api.process.IProcessType
  Returns the id of the process type.
getProcessTypes() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The process types of querying processes.
getProcessTypes() - Method in interface com.ibm.openpages.api.service.IProcessService
  Get process types.
getProcessVersionId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the identifier of the process definition version.
getProfile(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the profile associated with the specified profile name.
getProfile(Id) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the profile associated with the specified profile Identifier.
getProfileFieldId() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
  Returns the unique Profile Field Id for this Field Definition in the requested Profile.
getProfileFields(String, String, String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a list of profile field definitions for a specific view in a profile.
getProfileId() - Method in interface com.ibm.openpages.api.respview.IDashboardView
  Returns object profile ID
getProfiles() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the list of profiles available in the system.
getProfiles(IUser) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns the list of profiles associated with the specified user.
getProfileTypeDefinitionId() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
  Returns the Profile Object Type Definition Id for the Type that this Field Definition belongs to on the requested Type and Profile.
getProgramName() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
getProperties() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Get the properties defined for the action
getProperties() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
  Returns the list of properties.
getProperty(String) - Method in interface com.ibm.openpages.api.configuration.IConfigProperties
  Retrieves configuration setting specified by propertyName.
getProperty(String, String) - Method in interface com.ibm.openpages.api.configuration.IConfigProperties
  Returns value of configuration setting.
getProperty() - Method in interface com.ibm.openpages.api.search.ISearchResource
  The property of this resource item used to hold the information about the additional fields values the UI will display which are: field-label, display-type and the value of the field.
getProperty(String) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
  Returns the property for the given name.
getPropertyValue(String) - Method in class com.ibm.openpages.api.workflow.actions.AbstractCustomAction
getPropertyValue(String) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomAction
  Returns custom property values by name.
getQueryOptions() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
  Returns the query options for this event.
getQuestionBy(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a question that has the specified id.
getQuestionId() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getQuestionId() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getQuestionnaire(Id) - Method in interface com.ibm.openpages.api.service.IQuestionnaireService
  Get a questionnaire object by Id for the the current period including all sections and questions
getQuestionnaireAssessmentTypeName() - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
getQuestionnaireFactory() - Method in interface com.ibm.openpages.api.service.IQuestionnaireService
  Returns the factory for creating in memory instances of objects.
getQuestionnaireScoreThreshold() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the score threshold which determines whether an object is created.
getQuestionnaireTemplateTypeName() - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
getQuestions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a list of questions, sorted by the order configured on the child objects.
getQuickFilter() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get the quick filter.
getRangeEnd() - Method in class com.ibm.openpages.api.search.SearchOptions
  Ending index of range to return in search results.
getRangeStart() - Method in class com.ibm.openpages.api.search.SearchOptions
  Starting index of range to return in search results.
getRank() - Method in interface com.ibm.openpages.api.search.ISearchResource
  The order in the original search results as returned from the search server.
getRate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
  Returns actual exchange rate calculated relative to a system wide base currency.
getRationale() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the rationale of this questionnaire resource.
getReadSelected() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
  Returns the Boolean value if read-only is applied on field definition.
getRecipients() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the recipients email addresses
getReference() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the reference of this questionnaire resource.
getReferencePaths() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the reference paths to look up.
getReferenceType() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the type of reference
getRegisteredDate() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the date the solution was registered
getRejection() - Method in interface com.ibm.openpages.api.questionnaire.IComment
  Deprecated.
  This method is deprecated as of release 7.3.0.1, use method `IComment.getCommentType()` instead.
getRelationalOperator() - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
  Returns the relational operator for the condition
getRelationalOperator() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns relational operator type to evaluate left value and right value
getRelationFilterId() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the id of the relation filter.
getRelationshipName() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the name of the responsive view field or null.
getRelationshipPaths() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the list of type definition paths to the related object.
getRelationTypeDefinition() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the type definition of the responsive view field or null.
getRelativePath(String, List<ITypeDefinition>) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns relative path of the IResource provided full path and List of all ITypeDefinitions.
getRelativePath(String, ITypeDefinition) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns relative path of the IResource provided full path and ITypedefinition.
getRelativePath(String, String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns relative path of the IResource provided full path, and root folder path.
getRelativePath(String, String, boolean) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Returns relative path of the IResource provided full path, and root folder path.
getReportDataSource() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the report data source
getReportID() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the report UUID of this questionnaire resource.
getReportId() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns the reportId of the report tab
getReportingPeriod() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
  Returns the reporting period label.
getReportingPeriod() - Method in interface com.ibm.openpages.api.query.IQuery
  Returns the `IReportingPeriod` for this query.
getReportingPeriod() - Method in class com.ibm.openpages.api.resource.FolderFilter
  Returns the reporting period label.
getReportingPeriod() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
  Returns the reporting period label.
getReportingPeriod(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a specific reporting period.
getReportingPeriods() - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Retrieve Reporting Periods
getRequires() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns the list of evidence types required by this question for the question to be considered complete.
getRequires() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
  Returns the list of evidence types required by this answer for this question to be considered complete.
getRequires() - Method in interface com.ibm.openpages.api.resource.IEnumAnswer
  Returns the list of evidence types required by this answer.
getResource() - Method in class com.ibm.openpages.api.trigger.events.AbstractResourceEvent
  Return the resource object that is the focus of the event.
getResource() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the GRCObject associated in this context.
getResourceContext() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the context of resource to retrieve system fields without susequent fetch operation.
getResourceFactory() - Method in interface com.ibm.openpages.api.service.IResourceService
  Returns the factory for creating in memory instances of objects.
getResourceId() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  The Resource Permissions are describing the access to a particular OpenPages resource.
getResourceId() - Method in class com.ibm.openpages.api.trigger.events.DeleteResourceEvent
  Returns the single Id for the resource being deleted for this event.
getResourceId() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the id of the GRCObject associated in this context.
getResourceId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the identifier of the resource.
getResourceId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the Resource ID for which the workflow was started
getResourceId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the identifier of the resource where the process instance is associated to.
getResourceIds() - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
  Returns resource Ids to start calculations.
getResourceIds() - Method in class com.ibm.openpages.api.trigger.events.DeleteResourceEvent
  Returns list of resource Ids being deleted.
getResourceIds() - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
  Returns resource Ids to start workflows.
getResourceLevel(ContentType, Resource) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
  Global Financial Services / Corporate / HR --> 3 Global Financial Services / Corporate --> 2 -> 0 Note: this seems like a hack to calculate the level based on the path rather than doing a proper lookup.
getRespView(Id, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a responsive view
getRespView(ITypeDefinition, RespViewType, String, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a responsive view
getRespViewForWFActivity(IWFActivity, Id, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Returns a responsive view
getRespViews() - Method in class com.ibm.openpages.api.respview.RespViewList
  Returns the list of responsive views being fetched
getRespViews(RespViewFilter) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Searches the responsive views that meets the filter criteria
getRespViews(IFindOptions, RespViewState) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Searches the responsive views that meets the filter criteria with paging and sorting
getRespViewState() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns the state of the responsive view to retrieve
getRespViewType() - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
  Returns the responsive view type.
getResult() - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
getResult() - Method in class com.ibm.openpages.api.workflow.WFConditionReport
getResult() - Method in class com.ibm.openpages.api.workflow.WFEvalResult
getResultList() - Method in interface com.ibm.openpages.api.search.ISearchResults
  Gets the results that have been returned from search, processed for the end-user's security access, for the current range.
getResultRangeEnd() - Method in interface com.ibm.openpages.api.search.ISearchResults
  Gets the ending index of the results this SearchResults represented.
getResultRangeStart() - Method in interface com.ibm.openpages.api.search.ISearchResults
  Gets the starting index of the results this SearchResults represented.
getResultsPerPage() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Get the results per page
getResultsPerPage() - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
  Returns the number of results per page.
getResultsPerPage() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the results per page
getResultsPerPage() - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
  Get the results per page when `IBaseFindOptions.getIsPagingOn()` is true
getResultsPerPage() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the number of results per page.
getResultsPerPage() - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
  Returns the number of results per page.
getRetryTimes() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the retry times to send email.
getReturnLastRow() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the last row number to be returned
getReturnOnlyCounts() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Get the return only count flag.
getReturnOnlyCounts() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the return only count flag.
getReturnStartRow() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the start row number to be returned
getRightValue() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns evaluation unit for the right-side operand of the relation
getRLSRules(ITypeDefinition) - Method in interface com.ibm.openpages.api.service.IConfigurationService
  Return a Rule for a specific contentTypeID
getRoleAssignment(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Returns the role assignment corresponding to the specified Id.
getRoleAssignmentIds() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns a list of Id for role assignments.
getRoleAssignments() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns an iterator over role assignments.
getRoleAssignments() - Method in interface com.ibm.openpages.api.security.IUser
  Returns all role assignments for a user.
getRoleAssignments() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Returns an iterator over all role assignments effective in the system.
getRoleAssignments(ISecurityPrincipal, IRoleTemplate, IFolder) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Returns an iterator over all role assignments effective in the user or group
getRoleTemplate() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the role template which permissions get assigned.
getRoleTemplate(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves role template by Id.
getRoleTemplate(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves role template by name.
getRoleTemplateName() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the name of an assignment.
getRoleTemplates() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns an iterator over all roles assigned with this group.
getRoleTemplates() - Method in interface com.ibm.openpages.api.security.IUser
  Returns all roles for a user.
getRoleTemplates(boolean, boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves role templates based on the specified criteria.
getRoleTemplateType() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the type of an assignment.
getRootFolder() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns root folder associated to permission.
getRootFolderId() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the unique identifier for this type root folder.
getRootFolderId() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns Id of root folder associated to permission.
getRootFolderPath() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
  Returns the root folder for instances of this type.
getRuleAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
  Returns a Map containing rule attributes and their values.
getRuleCategory() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the dependency category as a string.
getRuleCondition() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the view identification rule condition.
getRuleDefinition(String, Id, boolean) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns a rule definition by name, type definition ID
getRuleDefinition(Id, boolean) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns a rule definition by ID
getRuleDefinitionByVersionId(Id) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the rule definition by the version ID
getRuleDefinitionId() - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
  Returns Id of the rule definition to start.
getRuleDefinitions() - Method in class com.ibm.openpages.api.rule.TBRuleDefinitionList
  Get the list of `ITBRuleDefinition` results based on the Search options provided via {#link IRuleDefinitionFindOptions}
getRuleDefinitions(Id) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the published and draft versions of the rule definition if they exist.
getRuleDefinitions() - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Deprecated.
getRuleDefinitions(ITBRuleDefinitionFindOptions) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns list of rule definitions based on the criteria defined by the `ITBRuleDefinitionFindOptions`
getRuleDefinitionsByRuleType(TBRuleDefinitionType) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the latest published version of all `ITBRuleDefinitions`s by `TBRuleDefinitionType` that are currently enabled.
getRuleDefinitionsByType(Id) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns the latest version of all `ITBRuleDefinition`s by object type
getRuleDefinitionState() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Returns the Process Definition state
getRuleFactory() - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Returns a new rule factory object.
getRuleId() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Returns identifier of the rule definition
getRuleOrder() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the view identification rule order.
getRules() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
  Returns the list of IRLSRule applied to a specific TypeDefinition.
getRules() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Gets the list of rules defined on this field.
getRules() - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
  Get the list of rules for the filter definiton
getRuleTypes() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
  Get the rule types to filter by.
getRuleVersionId() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Returns version id of the rule definition.
getRunnableRules(Id, TBRuleDefinitionType) - Method in interface com.ibm.openpages.api.service.ITBRuleService
  Get all runnable rules for an object type
getSchedJobDetail() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
getScheduleList() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Get the list of schedules `ISchedJobSchedule` defined for the job
getSchedules() - Method in class com.ibm.openpages.api.scheduler.SchedulerScheduleList
  Get the list of `ISchedJobSchedule` results based on the Search options provided
getSchedules(Optional<Id>) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getSchedules(IScheduleJobFindOptions) - Method in interface com.ibm.openpages.api.service.ISchedulerService
getScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns score of the question.
getScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
getScore() - Method in interface com.ibm.openpages.api.questionnaire.ISection
getScore() - Method in interface com.ibm.openpages.api.resource.IEnumAnswer
  Returns score of this enumerated answer.
getScore() - Method in interface com.ibm.openpages.api.search.ISearchResource
  The score is a decimal value that is an indicator of how relevant the result is to the search terms.
getSdkArgs() - Method in class com.ibm.openpages.api.trigger.events.SearchEvent
  Returns the raw arguments used to invoke the SDK search method in the OpenPages platform for this event.
getSearchFFP() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns facet folder path
getSearchFOT() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns facet object types
getSearchId() - Method in class com.ibm.openpages.api.search.SearchOptions
  Not used.
getSectionBy(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a section or sub-section that has the specified id.
getSectionOverrides() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the sections of the task focused user interface to override visibility and collapsed state.
getSections() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns a list of sections and sub-sections, sorted by the order configured on the child objects.
getSections() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the list of responsive view sections
getSecureType() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the security type of the SMTP server.
getSecurityPrincipal() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
  The Resource Permission belong to a User or a Group.
getSecurityPrincipal() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the user or group that is assigned the object permissions specified by the role template.
getServer() - Static method in class com.ibm.openpages.api.application.EmailUtil
getServiceFactory(Context) - Static method in class com.ibm.openpages.api.service.ServiceFactory
  Instantiates a service factory based on the factory class name specified by the com.ibm.openpages.sdk.service.factory key in the context.
getServiceFactory(HttpServletRequest) - Static method in class com.ibm.openpages.api.service.ServiceFactory
  Instantiates a service factory based on the http request.
getServiceFactory() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the service factory.
getServiceFactory(HttpServletRequest) - Method in class com.ibm.openpages.ext.rest.BaseExtController
  Attempts to retrieve or initialize a new GRC API IServiceFactory using the Http Request object.
getSet() - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
  Returns the List(Permissions) for this field.
getSeverity() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the severity of the rules ("error", "warning", "info", "success").
getSimpleLogger(Class<?>) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns slf4j Logger instance.
getSimpleLogger(String) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns slf4j Logger instance.
getSimpleLogger() - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
  Returns slf4j Logger instance.
getSimpleLogger(Class) - Method in class com.ibm.openpages.ext.rest.BaseExtController
  Gets a SLF4J logger which can be used to log to aurora logging framework.
getSmtpServer() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the SMTP server host or IP address.
getSolution(Id) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Retrieves a solution by Id.
getSolution(String) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Retrieves a solution by name.
getSolution(UUID) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Retrieves a solution by uuid.
getSolutionFactory() - Method in interface com.ibm.openpages.api.service.ISolutionService
  Returns a new solution factory object.
getSolutionId() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns local unique identifier of the solution
getSolutionId() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the Id of the Solution.
getSolutionLayout(Id) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Retrieves a solution layout by Id.
getSolutionLayouts(Id) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Returns all solution layouts for the specified solution id.
getSolutions() - Method in interface com.ibm.openpages.api.service.ISolutionService
  Returns all solutions.
getSolutionTypeDefinitions(Id, ISolutionTypeDefinitionOptions) - Method in interface com.ibm.openpages.api.service.ISolutionService
  Retrieves all associations between a solution and typedefinitions.
getSolutionVersionId() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns local unique identifier of the version of the solution
getSolutionVersionId() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the Id of the Solution Version.
getSortDirection() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the direction of sorting of the relationship rows.
getSortDirection() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the sort direction
getSortField() - Method in interface com.ibm.openpages.api.respview.IRespViewField
  Returns the field definition that is used for sorting of relationship rows.
getSortFieldName() - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
  Get the sort field name.
getSortFields() - Method in interface com.ibm.openpages.api.configuration.IFindOptions
  Returns the list of sort field
getSortFields() - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
  Returns the list of sort field with direction
getSourceId() - Method in class com.ibm.openpages.api.trigger.events.MoveResourceEvent
getSourceResouceId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  Returns the source Id for the object to be copied in this event.
getSqlQuery() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
  Returns query syntax SQL query for this event as produced by the user.
getStartActivity() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the starting activity.
getStartDate() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
  Gets the start date for logs retrieval.
getStartDate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
  Returns the start date of the applicability period of an exchange rate.
getStartedProcesses(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns list of started processes (open/executing/initialization error) for the given resource id.
getStartIndex() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
  Returns the starting row index for this event.
getStartRow() - Method in class com.ibm.openpages.api.process.ProcessLogQueryOptions
  Gets the paging start row index (1-based).
getStartRow() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
  Gets the paging start row index.
getStartTime() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the start time of the process log.
getStartTime() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the start time for the schedule
getState() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns the current state of the rule - draft/published
getState() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the state of the activity instance.
getState() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the state of the process instance.
getState() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the state of the process definition.
getStatus() - Method in interface com.ibm.openpages.api.audit.IAssociationAuditLog
  Returns the status of the association.
getStatus() - Method in interface com.ibm.openpages.api.process.IProcessInfo
  Returns the status of the process.
getStatus() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the status of the process log.
getStatus() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns the status of the question
getStatus() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
  Returns the status of the questionnaire, which is determined by lifecycle.
getStatusList() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
  The process status of querying processes.
getStatusMessage() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the message of the process log.
getStatusMessage() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the status message of the process instance.
getStatusMessageLabel() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the localized status message for the user session.
getStatusMessageLabels() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the process status message labels for all locales
getStatusTranslationParams() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the parameters of the message of the process log.
getStatusTranslationStringId() - Method in interface com.ibm.openpages.api.process.IProcessLog
  Returns the id of the message of the process log.
getStringValue() - Method in class com.ibm.openpages.api.query.ParameterValue
  Returns the value of this input parameter as a `String`
getStringValue() - Method in interface com.ibm.openpages.api.workflow.IWFSearchSimpleCondition
  Returns the condition value
getSubGroups() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns all groups that are members of a security group.
getSubject() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the subject of the email
getSubjectKeyToNotifyActionCompleted() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for subject of notification that is sent to the user who submitted a background transition when that transition has completed.
getSubjectKeyToNotifyAssignees() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for notification subject to assignees.
getSubjectKeyToNotifySubscribers() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for notification subject to subscribers.
getSubjectKeyToNotifyWorkflowCompleted() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns application text key that is used as a template for subject of notification that is sent to the oversight and other actors when the workflow has completed.
getSubjectParams() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets parameters that will be formated into subject text
getSubjectTextKey() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the key that is used to locate the application string for a subject
getSubPermissions() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
  Gets the sub-permissions associated with this application permission.
getSubscriberId() - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotification
  Get the ID of the workflow task subscriber
getSubscribers() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the activities subscribers to apply by the workflow action.
getSubscribers() - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
  Returns the list of user or groups subscribed on the activity.
getSummaryType() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the summary Type
getSummaryType() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the summary Type
getSymbol() - Method in interface com.ibm.openpages.api.configuration.ICurrency
  Returns the currency symbol as specified by ISO 4217.
getTableColumns() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns list of `IQuestionTableColumn` for a selection question.
getTabs() - Method in interface com.ibm.openpages.api.respview.IDashboardView
  Returns the list of dashboard tabs
getTag(Id) - Method in interface com.ibm.openpages.api.service.ITagService
getTag(String) - Method in interface com.ibm.openpages.api.service.ITagService
getTagFactory() - Method in interface com.ibm.openpages.api.service.ITagService
  Returns a new tag factory object.
getTagId() - Method in interface com.ibm.openpages.api.tag.ITag
getTags(IFindOptions) - Method in interface com.ibm.openpages.api.service.ITagService
getTags() - Method in class com.ibm.openpages.api.tag.TagList
  Get the list of `ITag` results based on the Search options provided via {#link ITagFindOptions}
getTarget() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the target activity name.
getTargetId() - Method in class com.ibm.openpages.api.trigger.events.MoveResourceEvent
getTargetObjects() - Method in class com.ibm.openpages.api.workflow.actions.AbstractCustomAction
getTargetObjects() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomAction
  Returns the evaluation to get the target objects
getTargetObjects() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
  Returns the evaluation to get the target objects.
getTargetObjects() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the eval object for fetching target resources on which to perform the workflow action.
getTargetResourceId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
  The target Id for the destination of where the source is to be copied to in this event.
getTemplateId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The Id of the Questionnaire Template object used by the Program.
getText() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getText() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getText() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the text content for guidance
getTextLabels() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the texts for all locales
getTextOverride() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the override text to replace default text in workflow transition popup
getTextOverrideLabel() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the localized text override label of the transition for the user session
getTextOverrideLabels() - Method in interface com.ibm.openpages.api.workflow.IWFTransition
  Returns the text override labels for all locales
getTheme(Id) - Method in interface com.ibm.openpages.api.service.IThemeService
  Returns the theme specified by the given theme id
getTheme(String) - Method in interface com.ibm.openpages.api.service.IThemeService
  Returns the theme specified by the given theme name
getThemeId() - Method in interface com.ibm.openpages.api.theme.ITheme
getThemes(IFindOptions) - Method in interface com.ibm.openpages.api.service.IThemeService
  Returns a list of themes based on the criteria defined by the Options
getTimeout() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the time out (in seconds) to send email.
getTimestamp() - Method in exception com.ibm.openpages.api.OpenPagesException
getTimestamp() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
getTimestamp() - Method in interface com.ibm.openpages.api.questionnaire.IComment
getTitle() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
  Returns the title of this questionnaire resource.
getToday() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns the `LocalDate` that represents today
getTop() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes.INumberRangeColor
  Deprecated.
  This truncates decimal places. Use `#topDouble()` instead.
getTopDouble() - Method in interface com.ibm.openpages.api.metadata.IDisplayTypeAttributes.INumberRangeColor
  top number of the range as a Double
getTopLevelGroups() - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves top level security groups from the OpenPages security model.
getTotalAssessments() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The number of assessments associated to the program.
getTotalAssets() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The number of assets associated to the Program.
getTotalCount() - Method in interface com.ibm.openpages.api.questionnaire.ISection
getTotalMatchingQuestions() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The number of matching questions between the program template and the copy from program template.
getTotalResultCount() - Method in class com.ibm.openpages.api.respview.DashboardList
  Returns the total count of the result.
getTotalResultCount() - Method in class com.ibm.openpages.api.respview.RespViewList
  Returns the total count of the result.
getTotalResultCount() - Method in class com.ibm.openpages.api.rule.TBRuleDefinitionList
  Returns the total count of results regardless of paging..
getTotalResultCount() - Method in class com.ibm.openpages.api.scheduler.SchedulerJobInstanceList
  Returns the total count of results regardless of paging.
getTotalResultCount() - Method in class com.ibm.openpages.api.scheduler.SchedulerJobList
  Returns the total count of results regardless of paging.
getTotalResultCount() - Method in class com.ibm.openpages.api.scheduler.SchedulerScheduleList
  Returns the total count of results regardless of paging.
getTotalResultCount() - Method in class com.ibm.openpages.api.tag.TagList
  Returns the total count of results regardless of paging..
getTotalResultCount() - Method in class com.ibm.openpages.api.workflow.WFActivityInstanceList
  Returns the total count of results regardless of paging..
getTotalResultCount() - Method in class com.ibm.openpages.api.workflow.WFProcessDefinitionList
  Returns the total count of results regardless of paging..
getTransition() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
  Returns the transition being performed.
getTransition(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns a transition for given name.
getTransitionAttribute(IGRCObject, String) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getTransitionAttribute(IGRCObject, String, boolean) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getTransitionComment() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
getTransitionComment() - Method in interface com.ibm.openpages.api.workflow.actions.IWFOperationContext
  Returns the user-provided comment value.
getTransitionComment() - Method in interface com.ibm.openpages.api.workflow.IWFTransitionOptions
  Get the comment provided by the user when the activity was transitioned.
getTransitionFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getTransitions(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns currently valid transitions for the given process id.
getTransitions(IWFProcess) - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns currently valid transitions for the given process instance.
getTransitions() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the list of transitions that users can possibly select to process.
getTransitionsAttributes() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
getTriggerCategory() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the category of the trigger
getTriggerEventType() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
  Returns type of the trigger event.
getTriggerName() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
  Get the name of the trigger
getType() - Method in interface com.ibm.openpages.api.configuration.IFindCondition
  Returns type of this condition
getType() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
  Returns the type of this node.
getType() - Method in interface com.ibm.openpages.api.resource.IGRCObject
  Returns the type definition for this object.
getType() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns type of the dashboard panel
getType() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns type of the dashboard tab
getType() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns type of the dashboard widget
getType() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
  Returns the dependency type, also called "behavior" internally (e.g., "visible", "required", "equal").
getType() - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
  Returns the type of the condition.
getType() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Returns the type of the rule action.
getType() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Get the type of the rule that determines when it should be run
getType() - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
  Returns the type of the job detail.
getType() - Method in class com.ibm.openpages.api.search.DateFacetParam
  Get the date facet type: Creation Date, Last Modified Date, Other Dates
getType() - Method in class com.ibm.openpages.api.search.UserFacetParam
  Get the user facet type: Created By, Last Modified By, and Name On Object
getType(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Returns a type definition by id.
getType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Returns the type definition with the specified system name.
getType() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the type of solution
getType() - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
  Returns the type of solution layout
getType() - Method in interface com.ibm.openpages.api.workflow.IWFAction
  Returns the type of the workflow action.
getType() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the type of the activity definition.
getType() - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
  Returns the type of the process instance.
getType() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns the type of the process definition.
getType() - Method in interface com.ibm.openpages.api.workflow.IWFProcessEvent
  Returns the type of event.
getType() - Method in interface com.ibm.openpages.api.workflow.IWFSearchCondition
getTypeAssociationsToHonor() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
  Gets the List of `TypeAssociationToHonor` objects that need to be honored during the copy operation.
getTypeDefinition() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
  Returns the ITypeDefinition for RLS rules.
getTypeDefinition() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
  Gets the TypeDefinition for this Controller field.
getTypeDefinition() - Method in interface com.ibm.openpages.api.respview.IRespView
  Returns the type definition that the responsive view belongs to.
getTypeDefinition() - Method in interface com.ibm.openpages.api.search.ISearchResource
  Returns the Object Type definition for this GRC Object.
getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IObjectPermission
  Returns the type definition associated to this ObjectPermissions Role Template type.
getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
  Returns the type definition of the scope for this assignment.
getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
  Returns the type definition for this role template.
getTypeDefinitionId() - Method in interface com.ibm.openpages.api.resource.IDeletedResource
  Returns the type definition id for this resource.
getTypeDefinitionId() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns Id of the type definition that is used for filtering
getTypeDefinitionName() - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinition
  Returns the name of the type definition associated to the Solution.
getTypeFilters() - Method in class com.ibm.openpages.api.resource.AssociationFilter
  Returns the list of type definition used for filtering.
getTypeFilters() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
  Returns a unique list of type definition filters.
getTypes() - Method in interface com.ibm.openpages.api.service.IMetaDataService
  Gives access to a list of type definitions supported by the system.
getUpdateAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
getUpdatedResource() - Method in class com.ibm.openpages.api.trigger.events.UpdateResourceEvent
  If available, as in during a POST event, it returns the updated resource object that resulted from this update event.
getUpdateSelected() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
  Returns the Boolean value if 'read-and-update' is applied on field definition.
getUrl() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the static link URL
getUser() - Method in class com.ibm.openpages.api.search.UserFacetParam
  Get the user facet data formated for Solr usage.
getUser(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves user by Id.
getUser(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves user information by name.
getUser() - Method in interface com.ibm.openpages.api.workflow.IEvaluationContext
  Returns user who runs the operation in the context.
getUserIds() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns all user Ids directly associated with a security group.
getUsername() - Method in class com.ibm.openpages.api.application.EmailOptions
  Gets the user name for authenticating into the SMTP server.
getUsers() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
  Get the facet value(s) for user(s).
getUsers() - Method in interface com.ibm.openpages.api.security.IGroup
  Returns all users of a security group.
getUsers(boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
  Retrieves users from the OpenPages security system.
getUuid() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the UUID of the dashboard panel
getUuid() - Method in interface com.ibm.openpages.api.respview.IDashboardTab
  Returns the UUID of the dashboard tab
getUuid() - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
  Returns the UUID of the dashboard panel
getUUID() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the globally unique identifier of the solution
getValidationMessage() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns validation message.
getValidationMessageLabel() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns the localized validation message label for the user session
getValidationMessageLabels() - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
  Returns the validation message labels for all locales
getValidator() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the validator to run by the workflow action.
getValue() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
  Gets the value of the column in the report row.
getValue() - Method in interface com.ibm.openpages.api.application.IParameter
  Gets the current value set for this parameter.
getValue() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
  Returns the localized value of an application text
getValue() - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
  Returns the value to match
getValue() - Method in interface com.ibm.openpages.api.metadata.ILabel
  Returns the localized value of the label
getValue() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
getValue() - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter.FilterCondition
  Get the condition value
getValue() - Method in interface com.ibm.openpages.api.resource.IBooleanField
  Returns the field value as a boolean.
getValue() - Method in interface com.ibm.openpages.api.resource.IDateField
  Returns the field value as a date.
getValue() - Method in interface com.ibm.openpages.api.resource.IFloatField
  Returns the field value as a double if it exists.
getValue() - Method in interface com.ibm.openpages.api.resource.IIdField
  Returns the value as an Id.
getValue() - Method in interface com.ibm.openpages.api.resource.IIntegerField
  Returns the field value as an integer.
getValue() - Method in interface com.ibm.openpages.api.resource.IReferenceField
  Returns the field value as a reference Id.
getValue() - Method in interface com.ibm.openpages.api.resource.IStringField
  Returns the field value as a string.
getValue(long) - Static method in enum com.ibm.openpages.api.rule.TBRuleActionType
getValue(int) - Static method in enum com.ibm.openpages.api.rule.TBRuleDefinitionCategory
getValue(int) - Static method in enum com.ibm.openpages.api.rule.TBRuleDefinitionState
getValue(int) - Static method in enum com.ibm.openpages.api.rule.TBRuleDefinitionType
getValue(int) - Static method in enum com.ibm.openpages.api.scheduler.JobDetailCategory
getValue(int) - Static method in enum com.ibm.openpages.api.scheduler.JobDetailType
getValue(int) - Static method in enum com.ibm.openpages.api.solution.SolutionLayoutType
getValue(int) - Static method in enum com.ibm.openpages.api.solution.SolutionType
getValue() - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
  Returns the value.
getValue() - Method in interface com.ibm.openpages.api.workflow.IWFFieldSetter
  Returns the value to assign to the target field as an evaluation unit.
getValue() - Method in interface com.ibm.openpages.api.workflow.IWFStringEval
  Returns value that is evaluated at run-time
getValue() - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval.IWFSwitchCase
  Returns the 'value' evaluation unit
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFActivityInstanceState
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFActivityType
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessCriticality
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessDefinitionState
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessDefinitionType
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessEventType
  Returns the event type for the internal id.
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessState
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFProcessType
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFRelationalOperatorType
getValue(int) - Static method in enum com.ibm.openpages.api.workflow.WFTransitionCommentRequirementType
getValueInContext(IWFOperationContext) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
  Returns the evaluated value given the supplied context.
getValues() - Method in interface com.ibm.openpages.api.configuration.IFindInCondition
  Returns the list of values to match
getValues() - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRuleController
  Returns the values of the controller for which the field dependency will evaluate to true.
getValues() - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
  Returns the values to match when the type is not `RespViewRuleConditionType.conditions`
getValues() - Method in interface com.ibm.openpages.api.workflow.IWFSearchInCondition
getVariableValue() - Method in interface com.ibm.openpages.api.rule.ITBAction
  Returns the eval unit associated with a calculation definition variable
getVersion() - Method in interface com.ibm.openpages.api.solution.ISolution
  Returns the full version string of the solution, including major, minor, mod and fixpack numbers.
getVersionId() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns version id of the rule definition.
getVersionId() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns version id of the process definition.
getVersionNumber() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
  Returns version number of the rule definition.
getVersionNumber() - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
  Returns version number of the process definition.
getViewName() - Method in interface com.ibm.openpages.api.workflow.IWFActivity
  Returns the name of the view used by the task focused user interface, when a GRC object is on this activity.
getViewType() - Method in class com.ibm.openpages.api.respview.RespViewFilter
  Returns type of the responsive view that is used for filtering
getVisibilityDependency() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns a question dependency object that represents visibility dependency.
getWarningMessage() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
  The application string key of the warning message.
getWeek() - Method in interface com.ibm.openpages.api.workflow.IWFResultDateCount
  Returns the grouped by week of the year.
getWeight() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
  Returns weight of the question.
getWeight() - Method in interface com.ibm.openpages.api.questionnaire.ISection
getWFProcessDefinitionId() - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
  Returns id of the workflow process definition.
getWidgets() - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
  Returns the list of dashboard widgets
getWorkflowFactory() - Method in interface com.ibm.openpages.api.service.IWorkflowService
  Returns a new workflow factory object.
getYear() - Method in interface com.ibm.openpages.api.workflow.IWFResultDateCount
  Returns the grouped by year.
GRCObjectFilter - Class in com.ibm.openpages.api.resource
  Filtering class for GRCObject.
GRCObjectFilter() - Constructor for class com.ibm.openpages.api.resource.GRCObjectFilter
  Constructor- Creates the GRCObjectFilter with default values.
GRCObjectFilter(IReportingPeriod) - Constructor for class com.ibm.openpages.api.resource.GRCObjectFilter
  Constructor- Creates the GRCObjectFilter with the reporting period.
GRCTriggerEventFactory - Class in com.ibm.openpages.api.trigger.events
  Utility class which creates instances of Events based on the TriggerEventType, Position and other method/operation specific parameters.
GRCTriggerException - Class in com.ibm.openpages.api.trigger
  Exception thrown for all GRC trigger related errors.
GRCTriggerException(ErrorMessage, List<Object>, Throwable) - Constructor for class com.ibm.openpages.api.trigger.GRCTriggerException
  Constructs a new GRCTriggerException with the specified error message, list of parameters and cause of the exception.
GREATER_THAN_ERROR - Static variable in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
GROUP_SELECTOR - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
  Group Selector
GroupInfo - Class in com.ibm.openpages.api.security
  Class for the specification of a user group.
GroupInfo(String) - Constructor for class com.ibm.openpages.api.security.GroupInfo
  Constructor for group information.
GroupInfo(String, Locale) - Constructor for class com.ibm.openpages.api.security.GroupInfo
  Constructor for group information.
GroupOptions - Class in com.ibm.openpages.api.security
  Options for retrieving Group.
GroupOptions() - Constructor for class com.ibm.openpages.api.security.GroupOptions
  Default constructor.
GroupOptions(boolean) - Constructor for class com.ibm.openpages.api.security.GroupOptions
  Constructor with parameter

A B C D E F G H I J K L M N O P Q R S T U V W

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.