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

S

saveQuestionnaire(IQuestionnaire) - Method in interface com.ibm.openpages.api.service.IQuestionnaireService
Save a questionnaire
saveResource(T) - Method in interface com.ibm.openpages.api.service.IResourceService
Save a resource.
saveRLSRules(IRLSTypeDefinitionRules) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Save Rules
scheduleJob(Id, String, Date, Date) - Method in interface com.ibm.openpages.api.service.ISchedulerService
Creates a new ISchedJobSchedule instance for a ISchedJobDetail, given a valid new cron expression.
scheduleJob(ISchedJobSchedule) - Method in interface com.ibm.openpages.api.service.ISchedulerService
Persist a new ISchedJobSchedule instance for a ISchedJobDetail
SCHEDULER_JOB_DOESNT_EXIST - Static variable in exception com.ibm.openpages.api.scheduler.SchedulerException
 
SCHEDULER_JOB_IS_DISABLED - Static variable in exception com.ibm.openpages.api.scheduler.SchedulerException
 
SchedulerException - Exception in com.ibm.openpages.api.scheduler
Represents exception thrown by the scheduler service
SchedulerException(int, List<Object>, Throwable) - Constructor for exception com.ibm.openpages.api.scheduler.SchedulerException
 
SchedulerJobInstanceList - Class in com.ibm.openpages.api.scheduler
The list class to provide fetching result of scheduler job instances.
SchedulerJobInstanceList(List<ISchedJobInstance>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerJobInstanceList
 
SchedulerJobInstanceList(int, List<ISchedJobInstance>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerJobInstanceList
 
SchedulerJobList - Class in com.ibm.openpages.api.scheduler
The list class to provide fetching result of scheduler jobs.
SchedulerJobList(List<ISchedJobDetail>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerJobList
 
SchedulerJobList(int, List<ISchedJobDetail>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerJobList
 
SchedulerScheduleList - Class in com.ibm.openpages.api.scheduler
The list class to provide fetching result of scheduler schedules.
SchedulerScheduleList(List<ISchedJobSchedule>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerScheduleList
 
SchedulerScheduleList(int, List<ISchedJobSchedule>) - Constructor for class com.ibm.openpages.api.scheduler.SchedulerScheduleList
 
ScheduleValidator - Class in com.ibm.openpages.api.scheduler
 
ScheduleValidator() - Constructor for class com.ibm.openpages.api.scheduler.ScheduleValidator
 
search(String, SearchOptions) - Method in interface com.ibm.openpages.api.service.ISearchService
Perform a search with the given search terms and options.
SearchEvent - Class in com.ibm.openpages.api.trigger.events
Represents the event type to search for objects.
SearchEvent(TriggerPositionType, Context, Object[]) - Constructor for class com.ibm.openpages.api.trigger.events.SearchEvent
 
SearchException - Exception in com.ibm.openpages.api.search
OpenPages Global Search function related Exception; for Search ErrorCodes.
SearchException() - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchException(ErrorCode, List<Object>, Throwable) - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchException(ErrorCode, String, Throwable) - Constructor for exception com.ibm.openpages.api.search.SearchException
Convenience constructor for SearchException with a single error message parameter, additionalErrorText and a Throwable cause.
SearchException(ErrorCode, String) - Constructor for exception com.ibm.openpages.api.search.SearchException
Convenience constructor for SearchException with a single error message parameter, additionalErrorText.
SearchException(ErrorCode, List<Object>) - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchException(String, Throwable) - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchException(String) - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchException(Throwable) - Constructor for exception com.ibm.openpages.api.search.SearchException
 
SearchFacetOptions - Class in com.ibm.openpages.api.search
 
SearchFacetOptions() - Constructor for class com.ibm.openpages.api.search.SearchFacetOptions
Constructs a SearchFacetOptions object that will hold various facet search data.
SearchMode - Enum in com.ibm.openpages.api.search
Enumeration for Global Search options.
SearchOptions - Class in com.ibm.openpages.api.search
Search method options specifying what to search and how to retrieve results.
SearchOptions() - Constructor for class com.ibm.openpages.api.search.SearchOptions
Construct with default options.
secureSendEmail(String, String, String, String, boolean, String, String, String, String) - Static method in class com.ibm.openpages.api.application.EmailUtil
This method sends out email by using a secured SMTP services.
SecurityPrincipalInfo - Class in com.ibm.openpages.api.security
Parent class for the specification of a security principal, which forms part of the specification of a user or group.
SELECTOR_INCLUDE_DISABLED_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
SELECTOR_INCLUDE_SUBGROUPS_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
SELECTOR_MIN_ACCESS_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
SELECTOR_SPAN_COLUMNS_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
SELECTOR_STARTING_GROUP_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
sendEmail(EmailOptions) - Static method in class com.ibm.openpages.api.application.EmailUtil
Send email
sendEmail(String, String, String, Object[], String, Object[], boolean, Context, StringBuffer, Locale) - Static method in class com.ibm.openpages.api.application.EmailUtil
Send email by using OpenPages Application Strings.
sendEmailBySecuredServer(String, String, String, Object[], String, Object[], boolean, Context, String, String, String, String, StringBuffer, Locale) - Static method in class com.ibm.openpages.api.application.EmailUtil
Send out emails by using a secured SMTP server and gets Subject and Body from OpenPages application string.
SendEmailEventHandler - Class in com.ibm.openpages.api.trigger.oob
This GRC trigger event handler sends email out to users specified in the fields of the Resource object.
SendEmailEventHandler() - Constructor for class com.ibm.openpages.api.trigger.oob.SendEmailEventHandler
 
ServerType - Enum in com.ibm.openpages.api
Application servers supported by OpenPages with Watson.
SERVICE_APPID - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_HOST_NAME - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_LOCAL - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_PORT - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_PROTOCOL - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_REMOTE_ADDRESS - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_REMOTE_HOST - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_SESSION - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_USER_NAME - Static variable in class com.ibm.openpages.api.Context
 
SERVICE_USER_PASSWORD - Static variable in class com.ibm.openpages.api.Context
 
ServiceFactory - Class in com.ibm.openpages.api.service
Gives access to an OpenPages service factory class.
ServiceFactory() - Constructor for class com.ibm.openpages.api.service.ServiceFactory
 
setAccess(List<IFLSPropertyAccess>) - Method in interface com.ibm.openpages.api.configuration.IFLSRule
Sets the List of FLSRule.
setAccess(List<IRLSAccess>) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Sets the List of RLSRule.
setAccessType(WFAccessType) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the access control type of the activity definition.
setAction(DateFacetParam.DateFacetAction) - Method in class com.ibm.openpages.api.search.DateFacetParam
Set the date facet action: On Date, Range Date, Previous Days, Next Days
setAction(UserFacetParam.UserFacetAction) - Method in class com.ibm.openpages.api.search.UserFacetParam
Set the user facet action: Me, and Others
setAction(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
Sets the name of the processed transition via transition actions.
setActionClass(String) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
Sets the name of the action class.
setActionFields(List<IRespViewField>) - Method in interface com.ibm.openpages.api.respview.IRespViewHeader
Sets the list of responsive view fields that provides actions of the task view ( such as lifecycle transitions )
setActions(List<IRespViewAction>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the list of actions associated to the current field.
setActions(List<ITBRuleAction>) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Sets the actions to be executed by the rule
setActions(List<IWFAction>) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns the list of actions.
setActivities(List<IWFActivity>) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the list of activities.
setAddCopiedFromComment(boolean) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets if add copied from comment
setAdminLevel(int) - Method in class com.ibm.openpages.api.security.GroupInfo
Sets the administration level for the user group.
setAdminLevel(int) - Method in interface com.ibm.openpages.api.security.IGroup
Updates the administration level associated with a security group.
setAdminMode(boolean) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Set whether Administrator mode should be enabled or disabled.
setAdvancedEvalId(Integer) - Method in class com.ibm.openpages.api.workflow.WFEvalResult
 
setAdvancedEvaluationResults(List<WFAdvancedEvalResult>) - Method in class com.ibm.openpages.api.workflow.WFConditionReport
 
setAggregationFieldName(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the Aggreation field
setAggregationFieldName(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the Aggreation field
setAndOr(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the AND or OR operator for the search conditions.
setAnswer(Object) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets answer of the question.
setAnswerType(AnswerType) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets answer type of the question
setAppend(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFFieldSetter
Sets whether this action appends the string value on the target field, or replaces it.
setAssignee(List<String>) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the assignee.
setAssignee(IGRCObject, String) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
 
setAssignees(Id, List<String>, boolean) - Method in interface com.ibm.openpages.api.service.IWorkflowService
Sets the list of assignees on the given activity instance.
setAssignees(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the assignees to apply to the target activity by the workflow action.
setAssignees(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
Sets the list of assignees via transition actions.
setAssociationTypeId(Id) - Method in enum com.ibm.openpages.api.tag.ResourceTagAssociationType
 
setAttribute(String) - Method in interface com.ibm.openpages.api.configuration.IFindInCondition
Assigns the attribute for the condition
setAttribute(String) - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
Assigns the attribute for the condition
setAttribute(String, Object) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns a process instance attribute by the attribute name via transition actions.
setAttribute(String, Object) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the process attribute by a name string.
setAttributes(HashMap<String, String>) - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
Sets the Map of all attributes of the event handler.
setAttributes(HashMap<String, String>) - Method in class com.ibm.openpages.api.trigger.AbstractRule
Sets the attributes for rules.
setAttributes(Map<String, Object>) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns the process instance attributes via transition actions.
setAttributes(Map<String, Object>) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the map of process attributes.
setAutomated(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets this as an automated workflow which can only contain automated stages.
setAutoNameChildren(boolean) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Sets whether the copy operation auto name children associated with the object being copied.
setBackground(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets if the workflow transition is executed in the background
setBaseDate(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
Assigns base date evaluation unit.
setBaseThemeName(String) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setBatchSize(int) - Method in interface com.ibm.openpages.api.BatchIterator
Set batch size
setBody(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the body of the email
setBodyKeyToNotifyActionCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets 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.
setBodyKeyToNotifyAssignees(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets application text key that is used as a template for notification body to assignees.
setBodyKeyToNotifySubscribers(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets application text key that is used as a template for notification body to subscribers.
setBodyKeyToNotifyWorkflowCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Sets 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.
setBodyKeyToNotifyWorkflowCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets 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.
setBodyParams(Object[]) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets parameters that will be formated into body text
setBodyTextKey(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the key that is used to locate the application string for body
setBooleanValue(Boolean) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a Boolean
setBulkAction(String) - Method in class com.ibm.openpages.api.workflow.BulkWorkflowActionOptions
Assigns the name of the action to be performed in bulk
setBulkEnabled(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns whether the activity has transitions which can be performed in bulk.
setBulkEnabled(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns whether the transition can be performed in bulk.
setBulkGridViewName(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Set the name of the grid view to use when performing bulk transitions.
setBulkTransitions(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
If bulk execution is enabled for this activity, set the list of transitions which can be performed in bulk.
setCalculationToRun(String) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the name of the calculation to run on a given object.
setCanChangePassword(Boolean) - Method in interface com.ibm.openpages.api.security.IUser
Sets whether a password can be changed
setCanChangePassword(boolean) - Method in class com.ibm.openpages.api.security.UserInfo
Sets whether password can be changed.
setCaseIncrease(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFRangeEval
 
setCaseInsensitive(boolean) - Method in interface com.ibm.openpages.api.query.IQuery
Specifies whether Query is applying case insensitive or case sensitive comparisons.
setCases(List<IWFSwitchesEval.IWFSwitchCase>) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
Assigns the list of case
setCategory(TBRuleDefinitionCategory) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Set the rule category
setCategory(JobDetailCategory) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets the type of the job detail.
setCategory(String) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set the category.
setCategory(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
Set the category.
setChartAttrs(Map<String, Object>) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Set the custom attributes that are needed by the chart
setChartDataField(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the field name that is used by the chart
setChartDataField(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the field name that is used by the chart
setChartType(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the type of chart
setChartType(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the type of chart
setChildrenTypesToCopy(List<ITypeDefinition>) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Explicit list of Object Types to include in the copyToParent operation, if isIncludeChildren is true.
setChildrenTypesToMove(List<ITypeDefinition>) - Method in class com.ibm.openpages.api.application.MoveObjectOptions
Explicit list of Object Types to include in the moveGRCObject operation.
setChildTypeId(Id) - Method in class com.ibm.openpages.api.application.TypeAssociationToHonor
Sets the child type Id of the TypeAssociationToHonor
setClassifierFieldName(String) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Set the classifier field name for suggestAssociations action types.
setCollapsed(Boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewSection
Sets the collapsed state of the responsive view section
setCollectDatabaseData(boolean) - Method in class com.ibm.openpages.api.application.LaunchLogCollectorOptions
 
setCollectLogFiles(boolean) - Method in class com.ibm.openpages.api.application.LaunchLogCollectorOptions
 
setColor(String) - Method in interface com.ibm.openpages.api.tag.ITag
 
setColors(Map<String, Object>) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setColumn2Field(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the column2Field
setComment(String) - Method in class com.ibm.openpages.api.workflow.BulkWorkflowActionOptions
If applicable, assigns the comment value set for the action
setCommentPromptKey(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets application text key that is used as the default prompt for the transition comment.
setCommentRequirement(WFTransitionCommentRequirementType) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets whether the user is required to provide a comment when transitioning the workflow, or if it is optional or not available.
setCompareTo(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the value/field to compare the current field's value to in a validation rule.
setCondition(IFindCondition) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Assigns the condition for the query
setCondition(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the condition, i.e., does the dependency evaluate to true if "allOf" the controllers are true, or if "anyOf" the controllers are true.
setCondition(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
Sets the condition, i.e., does the filter evaluate to true if "allOf" the rules apply, or if "anyOf" the rules apply.
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.rule.ITBAction
Assigns the condition to determine the action is taken or is skipped.
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Sets the rule criteria.
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
Assigns the condition evaluation unit
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the condition applied to the target object type.
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the workflow condition.
setCondition(IWFConditionEval) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns the condition for the transition availability.
setConditions(List<IFindCondition>) - Method in interface com.ibm.openpages.api.configuration.IFindGroupCondition
Assigns sub conditions
setConditions(String) - Method in interface com.ibm.openpages.api.configuration.IFLSRule
Sets the condition of FLSRule.
setConditions(String) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Sets the condition of RLSRule.
setConditions(List<DeletedResourceFilter.FilterCondition>) - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
Set the filter conditions.
setConditions(List<IRespViewRuleCondition>) - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
Sets the grouped child conditions when the type is RespViewRuleConditionType.conditions
setConditions(List<IWFRelationalConditionEval>) - Method in interface com.ibm.openpages.api.workflow.IWFAdvancedLogicConditionEval
Assigns list of conditions
setConditions(List<IWFSearchCondition>) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
Set the search conditions
setConditions(List<IWFConditionEval>) - Method in interface com.ibm.openpages.api.workflow.IWFConditionGroupEval
Assigns list of conditions
setConfigurable(boolean) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets whether the job is configurable or not.
setConfigurationItems(List<ISchedJobConfigurationItem>) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfiguration
Set the list of field definitions that describe the job's configuration
setConflictBehavior(CopyConflictBehavior) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Specifies the behavior of the copy operation when a GRCObject with the same name already exists at the location.
setConflictBehavior(MoveConflictBehavior) - Method in class com.ibm.openpages.api.application.MoveObjectOptions
Specifies the behavior for a move operation when a GRCObject with the same name already exists at the location.
setContent(InputStream, long) - Method in interface com.ibm.openpages.api.resource.IDocument
Sets the file content for this document.
setContent(InputStream, long, IFileTypeDefinition) - Method in interface com.ibm.openpages.api.resource.IDocument
Sets the file content for this document.
setContent(byte[]) - Method in interface com.ibm.openpages.api.resource.IDocument
Sets the file content for this document.
setContent(byte[], IFileTypeDefinition) - Method in interface com.ibm.openpages.api.resource.IDocument
Sets the file content for this document.
setContentTypeId(String) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the object type.
setContext(Context) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the API context
setControllerName(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the controller name.
setControllers(List<IRespViewFieldRuleController>) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the list of controller for a rule.
setCopyFromProgramId(String) - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
Sets the copy from program Id
setCopyObjectOptions(CopyObjectOptions) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the copy object options for copyRecursive action types.
setCopyQuestionAttachments(boolean) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets if copy question attachments
setCopyQuestionComments(boolean) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets if copy question comments
setCreatedById(Id) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set the creator (user) id of querying processes.
setCreatedOnBegin(Date) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set begin of the created time of querying processes.
setCreatedOnEnd(Date) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set the end of the created time of querying processes.
setCreateObjectName(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Assigns the name of the object to be created by the action.
setCreateObjectType(String) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Assigns the object type of the object to be created by the action.
setCriticality(List<String>) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the criticality.
setCriticality(WFProcessCriticality) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns criticality of the process instance via transition actions.
setCronExpression(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the schedule's CRON expression
setCurrencyValue(Double) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a Double
SetCurrentDateHandler - Class in com.ibm.openpages.api.trigger.oob
This GRC trigger event handler sets the value of a date field to the current date.
SetCurrentDateHandler() - Constructor for class com.ibm.openpages.api.trigger.oob.SetCurrentDateHandler
 
setCustomAction(IWFCustomActionDef) - Method in interface com.ibm.openpages.api.rule.ITBAction
Sets the custom action object that should be executed.
setDashboards(List<IDashboardView>) - Method in class com.ibm.openpages.api.respview.DashboardList
Assigns the list of dashboards being fetched
setData(Map<String, Object>) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
 
setDate(String) - Method in class com.ibm.openpages.api.search.DateFacetParam
Set the date facet data for Solr usage.
setDateAlterOperation(WFDateAlterOperation) - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
Assigns operation to alter the date
setDates(List<DateFacetParam>) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
Set the facet value(s) for date(s).
setDateValue(Date) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a Date
setDaysAddition(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFDateEval
Assigns days addition evaluation unit.
setDefault(boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
Sets the responsive view's default state.
setDefault(boolean) - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
Sets the solution layout's default state.
setDefault(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns whether this is the default transition.
setDefaultFilterRules(IRespViewFilterRules) - Method in interface com.ibm.openpages.api.respview.IRespView
Sets the filter information for a grid view
setDefaultMaxRows(int) - Method in interface com.ibm.openpages.api.service.IQueryService
Sets the default maximum number of rows to return.
setDefaultValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
Assigns the default value evaluation unit
setDescription(String) - Method in interface com.ibm.openpages.api.configuration.IFLSRule
Sets the description of FLSRule.
setDescription(String) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Sets the description of RLSRule.
setDescription(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
Sets the description of the questionnaire resource.
setDescription(String) - Method in interface com.ibm.openpages.api.resource.IResource
Sets the description of a resource.
setDescription(String) - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
Sets the description of the responsive view.
setDescription(String) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Set the description of the rule
setDescription(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets the description of the job detail
setDescription(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the description of the schedule
setDescription(String) - Method in class com.ibm.openpages.api.security.GroupInfo
Sets the description for the user group.
setDescription(String) - Method in interface com.ibm.openpages.api.security.IGroup
Updates description of a security group.
setDescription(String) - Method in interface com.ibm.openpages.api.security.IUser
Sets description information about the account.
setDescription(String) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Description
setDescription(String) - Method in interface com.ibm.openpages.api.solution.ISolution
Sets the description of the solution
setDescription(String) - Method in interface com.ibm.openpages.api.tag.ITag
 
setDescription(String) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setDisableAllTriggers(boolean) - Method in class com.ibm.openpages.api.Context
Sets whether disables (or enables) all triggers.
setDueDate(IWFDateEval) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Assigns the due-date to set by the workflow action
setDueDate(Date) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
Assigns the due date of the activity instance via transition actions.
setDueDate(Date) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationFindOptions
Configure the filter to get all notifications for tasks due on a specific date
setDueDate(Date) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns due date of the process instance via transition actions.
setDueDateCategoryColors(Map<String, String>) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets due-date category colors
setDueDateCountsGroupByField(WFConditionAttribute) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
Specifies an additional group by attribute beyond due date to group counts by.
setDueDateCountsOnProcess(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
Sets true to include due date counts on the process due date.
setDueDateCountsScope(IWFActivityInstanceFindOptions.DateScope) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
Sets the DateScope for grouping counts.
setDueSoonCutoff(Integer) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the due to cut off in week
setDueSoonCutoff(Integer) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the due to cut off in week
setEmail(String) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Email
setEmailAddress(String) - Method in interface com.ibm.openpages.api.security.IGroup
Updates the email address associated with a security group.
setEmailAddress(String) - Method in interface com.ibm.openpages.api.security.IUser
Sets the email address associated with a user.
setEmailOption(LaunchProgramOptions.EmailOption) - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
Sets the email option.
setEnabled(Boolean) - Method in interface com.ibm.openpages.api.configuration.IFLSRule
Enables or disables the rule.
setEnabled(Boolean) - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
Sets the boolean value for RLSAccess.
setEnabled(Boolean) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Enables or disables the rule.
setEnabled(Boolean) - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
Enables IRLSRule when set to true.
setEnabled(boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
Enables or disables the responsive view
setEnabled(boolean) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Enables or disables the rule definition.
setEnabled(boolean) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Enables or disables the job detail.
setEnabled(boolean) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Enabled
setEnabled(boolean) - Method in interface com.ibm.openpages.api.solution.ISolution
Sets whether the solution is enabled.
setEnabled(boolean) - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
Sets whether the solution layout is enabled.
setEnabled(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set the enabled flag for the notification
setEnabled(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Enables or disables the process definition.
setEncrypted(boolean) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
Specify whether the field value should be encrypted
setEndDate(Date) - Method in class com.ibm.openpages.api.audit.AuditLogFilter
Sets the end date for logs retrieval.
setEndRow(int) - Method in class com.ibm.openpages.api.process.ProcessLogQueryOptions
Set the paging end row index (1-based).
setEndRow(int) - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
Set the paging end row index.
setEndTime(Date) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the end time for the schedule
SetEnumFieldHandler - Class in com.ibm.openpages.api.trigger.oob
This GRC trigger event handler sets the value of an enumerate field to a specific value defined in the attributes.
SetEnumFieldHandler() - Constructor for class com.ibm.openpages.api.trigger.oob.SetEnumFieldHandler
 
setEnumValue(IEnumValue) - Method in interface com.ibm.openpages.api.resource.IEnumField
Sets the field value with an element of an enumeration.
setEnumValueColors(Map<String, String>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the map that represents colors for enumerated values.
setEnumValues(List<IEnumValue>) - Method in interface com.ibm.openpages.api.resource.IMultiEnumField
Sets the value of a multi-selectable enumerated field.
setErrorMessage() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
 
setErrorMessage(String) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setErrorMessage(String) - Method in class com.ibm.openpages.api.workflow.WFEvalResult
 
setErrorMessageId(int) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setErrorMessageId(int) - Method in class com.ibm.openpages.api.workflow.WFEvalResult
 
setErrorMessageParameters(List<Object>) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setErrorMessageParameters(List<Object>) - Method in class com.ibm.openpages.api.workflow.WFEvalResult
 
setEvals(List<IWFEvalUnit>) - Method in interface com.ibm.openpages.api.workflow.IWFListEval
Assigns the list of evaluation unit
setEvaluateComputedFields(boolean) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets whether to evaluate computed fields
setEvaluationResults(List<WFEvalResult>) - Method in class com.ibm.openpages.api.workflow.WFConditionReport
 
setExchangeRate(Double) - Method in interface com.ibm.openpages.api.resource.ICurrencyField
Sets the exchange rate.
setExchangeRate(IExchangeRate) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Set a new exchange rate.
setExchangeRate(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
Assigns evaluation unit for exchange rate;
setExchangeRates(List<IExchangeRate>) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Set a list of exchange rates.
setExecuteAsSystem(boolean) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
Sets whether the action will run with OPSystem administrator privileges.
setExecuteAsSystem(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Assigns whether the action should be executed as a system user.
setExecuteAsSystem(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets whether the workflow should be run as a system user
setExpr(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
Assigns the 'expr' evaluation unit
setExpression(String) - Method in interface com.ibm.openpages.api.workflow.IWFCalculationEval
 
setFacetOption(SearchFacetOptions) - Method in class com.ibm.openpages.api.search.SearchOptions
Set the list of types, identified by their Id, to scope the search.
setFail(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
Assigns the evaluation unit that is executed when the condition is NOT met
setField(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the name of the field being compared in the case where field is not implicit (i.e.
setField(IWFObjectFieldEval) - Method in interface com.ibm.openpages.api.workflow.IWFFieldSetter
Sets target field identifier.
setField(String) - Method in interface com.ibm.openpages.api.workflow.IWFObjectFieldEval
Assigns the object field value.
setFieldDefinition(IFieldDefinition) - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
Sets FieldDefinition for IFLSRule.
setFieldFilters(IFieldDefinition...) - Method in class com.ibm.openpages.api.audit.AuditLogFilter
Sets the list of field filters to include.
setFieldFilters(IFieldDefinition...) - Method in class com.ibm.openpages.api.resource.ContaineeFilter
Sets one or more field definition filters.
setFieldFilters(IFieldDefinition...) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets the list field filters to include.
setFieldName(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
Set the name of the configuration field
setFieldNames(List<String>) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the field names that are used by the chart or other dashboard component (i.e.
setFields(List<IRespViewField>) - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
Sets the list of responsive view fields
setFields(List<IRespViewField>) - Method in interface com.ibm.openpages.api.respview.IRespViewHeader
Sets the list of responsive view fields
setFields(List<IRespViewField>) - Method in interface com.ibm.openpages.api.respview.IRespViewSection
Sets the list of responsive view fields
setFields(List<IWFFieldSetter>) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
Sets the list of field setter objects.
setFieldSetters(List<IWFFieldSetter>) - Method in interface com.ibm.openpages.api.rule.ITBAction
Sets the field setter to run by the workflow action.
setFieldType(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
Set the type of the field
setFieldValue(IField, Object) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
Sets the value of the Field with the object specified.
setFieldValue(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
Set the value of the field
setFieldValue(IWFOperationContext, IGRCObject, IWFFieldSetter) - Static method in class com.ibm.openpages.api.workflow.actions.util.WFActionUtil
This method will apply the IWFFieldSetter object to the IGRCObject.
setFilterId(Id) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the filter Id
setFilterId(Id) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the filter Id
setFilterRules(IRespViewFilterRules) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the a filter definition for this action (only for associate, associatePrimary, and copyRecursive actions).
setFirstName(String) - Method in interface com.ibm.openpages.api.security.IUser
Sets the first name of the user.
setFirstName(String) - Method in class com.ibm.openpages.api.security.UserInfo
Sets first name.
setFirstNotification(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set the number of days before the task's due date on which to send the first notification for the task
setFloatValue(Double) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a Double
setFLsRules(List<IFLSRule>) - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
Sets the IFLSRules for a specific TypeDefinition
setFolder(String) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the folder name that limits the set of objects this action refers to
setFolderDepth(Integer) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the maximum depth that will be applied to the set of objects that this action represents
setFolderPath(String) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
Set the facet value for folder path.
setForToday(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationFindOptions
Set the filter to get all notifications that should be sent out today
setFrom(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Deprecated.
use `setFromAddress` and `setFromName` instead.
setFromAddress(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the from email address.
setFromName(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the sender name.
setGuidanceOverride(IRespViewGuidance) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the guidance of the task forcust user interface to override help topic and help text.
setHelpText(String) - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
Set the field help text.
setHelpTextLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
Sets the list of field help text labels.
setHelpTopic(String) - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
Set the field help topic.
setHelpTopicLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewGuidance
Sets the list of field help topic labels.
setHidden(boolean) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the locked status of the dashboard panel
setHidden(boolean) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the locked status of the dashboard tab
setHidden(boolean) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Hidden
setHonorPrimary(boolean) - Method in interface com.ibm.openpages.api.query.IQuery
Specifies whether primary associations are honored.
setHonorPrimary(boolean) - Method in class com.ibm.openpages.api.resource.AssociationFilter
Sets the status of HonorPrimary flag.
setHonorPrimary(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the flag to look up only primary relationships.
setId(Id) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
 
setId(Integer) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setIgnoreError(boolean) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets whether to continue sending out emails when an error occurred
setInclAssociationForReturnObjs(IncludeAssociations) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Specifies the associations to be included on returned GRCObjects by the copy operation.
setIncludeActiveWorkflows(boolean) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets whether to return ids of active workflows the resource is associated with.
setIncludeAllChildren(boolean) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set if include children processes in the query result.
setIncludeAssociations(IncludeAssociations) - Method in class com.ibm.openpages.api.resource.AssociationFilter
Sets include association type.
setIncludeCalcStatus(boolean) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets whether to include calculation status.
setIncludeChildren(boolean) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Sets whether the copy operation will include children associated with the object being copied.
setIncludeContainees(IncludeContainees) - Method in class com.ibm.openpages.api.resource.ContaineeFilter
Sets the type of containees to include.
setIncludeContextualAttributes(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
When set to true the returned value will include lists of workflows, object types and activities relevant to the entire result set.
setIncludeDisabledJobs(boolean) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set whether to return jobs that are disabled.
setIncludeDisabledRules(boolean) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set whether to return rules that are disabled.
setIncludeDisabledTypeDefinitions(boolean) - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinitionOptions
When set to true the returned value will include lists of ISolutionTypeDefinition objects that include associations that have been disabled from the vendor provided solutions.
setIncludeDueDateCounts(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstanceFindOptions
When set to true the returned value will include lists of counts based on grouping parameters.
setIncludeEnabledJobs(Boolean) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set enabled.
setIncludeEnabledRules(Boolean) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set enabled.
setIncludeMembers(boolean) - Method in class com.ibm.openpages.api.security.GroupOptions
Sets includeMembers setting
setIncludeMissingTypeDefinitions(boolean) - Method in interface com.ibm.openpages.api.solution.ISolutionTypeDefinitionOptions
When set to true the returned value will include lists of ISolutionTypeDefinition objects that include associations in vendor provided solutions that are to TypeDefinitions that have not been installed on the environment.
setIncludeOrphanFields(boolean) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets whether to return orphan fields.
setIncludeTotalCount(boolean) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Set the include total count of the search results.
setIncludeTotalCount(boolean) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the include total count of the search results.
setIntegerValue(Integer) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a Integer
setInvertMatch(boolean) - Method in interface com.ibm.openpages.api.configuration.IFindInCondition
Assigns the flag to invert the match
setInvertMatch(boolean) - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
Assigns the flag to invert the match
setInvertMatch(Boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
Sets if the condition inverts the match when the type is not RespViewRuleConditionType.conditions
setInvertMatch(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Assigns the flag to invert the result of this condition.
setIsBulkUpdateEnabled(boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets whether or not field is enabled for bulk update
setIsBulkUpdateOnly(boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets whether or not the field is only used for bulk update
setIsDefault(Boolean) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets the default state of the responsive view that is used for filtering
setIsDefault(Boolean) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setIsEnabled(Boolean) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets the enabled state of the responsive view that is used for filtering
setIsEnabled(Boolean) - Method in interface com.ibm.openpages.api.tag.ITag
 
setIsEnabled(Boolean) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setIsManual(boolean) - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
Set isManual.
setIsSuppliedByVendor(Boolean) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets the supplied-by-vendor state of the responsive view that is used for filtering
setIsTemporaryPassword(Boolean) - Method in interface com.ibm.openpages.api.security.IUser
Sets whether a password is temporary
setIsTemporaryPassword(boolean) - Method in class com.ibm.openpages.api.security.UserInfo
Sets the flag to make password temporary.
setJobClass(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets the fully qualified name of the java class associated with the job detail.
setJobClass(String) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set the quick filter.
setJobConfiguration(ISchedJobConfiguration) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Set the job configuration ISchedJobConfiguration
setJobId(Id) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobConfigurationItem
Set the Id of the job to which this configuration field belongs
setJobId(Id) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the Id of the Job to which this schedule belongs
setJobId(Id) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set the job id.
setJobId(Id) - Method in interface com.ibm.openpages.api.scheduler.ISchedulerJobInstanceFindOptions
Set Job Id.
setJobName(String) - Method in interface com.ibm.openpages.api.scheduler.IScheduleJobFindOptions
Set jobName.
setKey(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval.IWFSwitchCase
Assigns the 'key' evaluation unit
setLabel(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the label for static link
setLastName(String) - Method in interface com.ibm.openpages.api.security.IUser
Sets the last name of the user.
setLastName(String) - Method in class com.ibm.openpages.api.security.UserInfo
Sets last name.
setLatestVersionState(TBRuleDefinitionState) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Sets the state of the latest version of the rule to be draft ot published
setLaunchType(RespViewActionLaunchType) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the action's launch type
setLeftValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Assigns the left-side value of the relation
setLevel(int) - Method in class com.ibm.openpages.api.security.GroupInfo
Sets the level for the user group.
setLevel(Integer) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the level of relationships to look up.
setLinkBuffer(StringBuffer) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the string buffer for a URL that points to the object in OpenPages
setLinkLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the static link labels
setLocalAmount(Double) - Method in interface com.ibm.openpages.api.resource.ICurrencyField
Sets the local amount.
setLocalAmount(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
Assigns evaluation unit for local amount.
setLocalCurrency(ICurrency) - Method in interface com.ibm.openpages.api.resource.ICurrencyField
Sets the local currency.
setLocalCurrency(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFCurrencyEval
Assigns evaluation unit for local currency.
setLocale(Locale) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the locale to get translated application texts for subject and body
setLocale(Locale) - Method in interface com.ibm.openpages.api.security.IUser
Sets locale information associated with the user.
setLocale(Locale) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Locale
setLocked(boolean) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the locked status of the dashboard panel
setLocked(boolean) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the locked status of the dashboard tab
setLockObjects(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Assigns whether the action should lock the target objects (if false, unlock).
setLogger(IProcessStatusLogger) - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
 
setLogicalOperator(IFindGroupCondition.LogicalOp) - Method in interface com.ibm.openpages.api.configuration.IFindGroupCondition
Assigns logical operator
setLogicalOperator(LogicalOperatorType) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency
Sets the logical operator of the dependency.
setLogicalOperator(LogicalOperatorType) - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
Sets the logical operator type of the condition when the type is RespViewRuleConditionType.conditions
setLogicalOperator(LogicalOperatorType) - Method in interface com.ibm.openpages.api.workflow.IWFConditionGroupEval
Assigns logical operator type
setLogicalOperators(String) - Method in interface com.ibm.openpages.api.workflow.IWFAdvancedLogicConditionEval
Assigns logical operator application
setLogicalOperatorType(LogicalOperatorType) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Sets the RbsLogicalOperator for RLSRule.
setLogicOperators(String) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setMaxResults(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the Maximum results for the search results.
setMaxRows(int) - Method in interface com.ibm.openpages.api.query.IQuery
Sets the maximum number of rows to return as part of the ITabularResultSet.
setMiddleName(String) - Method in interface com.ibm.openpages.api.security.IUser
Sets the middle name of the user.
setMiddleName(String) - Method in class com.ibm.openpages.api.security.UserInfo
Sets middle name.
setMimeTypeIDs(List<Id>) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
Set the facet value for MIME type.
setMlModels(List<String>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
 
setMode(SearchMode) - Method in class com.ibm.openpages.api.search.SearchOptions
Sets the search mode either BASIC or ADVANCED.
setMultiSelect(Boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets if this action can result in multiple selections
setName(String) - Method in interface com.ibm.openpages.api.configuration.IFLSRule
Sets the name of FLSRule.
setName(String) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
Sets the name of RLSRule.
setName(String) - Method in interface com.ibm.openpages.api.resource.IResource
Sets the name of a resource.
setName(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRuleController
Set the name of the controller field (e.g., "OPSS-Ctl:Operating Effectiveness").
setName(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
Set the name of the filter definition
setName(String) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets the name of the responsive view that is used for filtering
setName(String) - Method in interface com.ibm.openpages.api.rule.ITBAction
Sets the name of the workflow action.
setName(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets the name of the job detail
setName(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the name of the schedule
setName(String) - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
Sets the name of the security principal.
setName(String) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
Set Name
setName(String) - Method in interface com.ibm.openpages.api.solution.ISolution
Sets the name of the solution
setName(String) - Method in interface com.ibm.openpages.api.solution.ISolutionLayout
Sets the name of the solution layout
setName(String) - Method in interface com.ibm.openpages.api.tag.ITag
 
setName(String) - Method in interface com.ibm.openpages.api.theme.ITheme
 
setName(String) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
Sets the name of the property.
setName(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns the name of the transition
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the list of panel name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the list of tab name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespView
Sets the list of responsive view name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
Sets the list of action name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the list of responsive view field name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
 
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IRespViewSection
Sets the list of responsive view section name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Sets the list of activity name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the list of process definition name labels
setNameLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets the list of transition name labels
setNameOverrides(Map<Id, String>) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Optionally specifies an explicit name to set on the copy of each Id.
setNotification(IWFActivityNotificationDefinition) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Set the notification details for the stage
setNotificationFrequency(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set the frequency, in days, for sending notifications after the first one is sent
setNotifyAssignees(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set whether notifications should be sent to the task assignees
setNotifyAssignees(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets if the workflow transition sends notifications to assignees.
setNotifyOnDueDate(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set whether a notification should be sent when the task becomes due
setNotifyOversight(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Deprecated.
no need to set the notify oversight since it is removed from end stage.
setNotifySubscribers(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set whether notifications should be sent to the task subscribers
setNotifySubscribers(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets if the workflow transition sends notifications to subscribers.
setNumberRangeColors(List<IDisplayTypeAttributes.INumberRangeColor>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the list of IDisplayTypeAttributes.INumberRangeColor.
setObjectFieldOverrides(List<IRespViewField>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the object fields of the task focused user interface to override visibility, editability, and importance.
setObjectInstanceReadOnly() - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
 
setObjectType(String) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
 
setObjectType(String) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the object type value.
setObjectTypeName(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the object type by name
setObjectTypeName(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the object type by name
setObjectTypes(List<Id>) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
Set the facet value for object-types.
setOffset(int) - Method in interface com.ibm.openpages.api.query.IQuery
Returns the offset.
setOffset(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the offset (in days) that will be used when doing date field comparisons.
setOptions(List<IQuestionOption>) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets options for selection question.
setOrder(int) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
Sets the order of the resource.
setOtherActors(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the other actors when reached an end stage.
setOtherActors(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
Sets the other actor list.
setOverdueNotificationFrequency(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFActivityNotificationDefinition
Set the frequency, in days, to send notifications once the task is overdue
setOverwriteAnswers(boolean) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets if any existing answers should be replaced by copied answers
setOwners(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns the oversight owners of the process instance via transition actions.
setOwners(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFProcessContext
Sets the list of oversight user/group name via custom transition actions.
setPageNum(int) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Set the page number to be retrieved in the search results.
setPageNum(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the page number to be retrieved in the search results.
setPageNum(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
Set the page number to be retrieved in the search results.
setPageSize(int) - Method in interface com.ibm.openpages.api.query.IQuery
Sets the page size to use for the result set.
setPagingOn(boolean) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the Pagination On for the search results Default value for this flag is false.
setPalette(String) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the name of the field's color palette.
setPanels(List<IDashboardPanel>) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the list of dashboard panels
setParameterValue(String, String...) - Method in interface com.ibm.openpages.api.application.IReportParameters
Sets the value for a specified parameter to pass to the report.
setParentFolder(IFolder) - Method in interface com.ibm.openpages.api.resource.IResource
Sets the parent folder using the supplied folder.
setParentProcessId(Id) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set the parent process id of querying processes.
setParentRelationTypeDefinition(ITypeDefinition) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the parentRelationTypeDefinition used in sibling relationship type.
setParentTypeId(Id) - Method in class com.ibm.openpages.api.application.TypeAssociationToHonor
Sets the non primary parent type Id of the TypeAssociationToHonor
setPass(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFIfElseEval
Assigns the evaluation unit that is executed when the condition is met
setPassword(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the password for authenticating into the SMTP server.
setPassword(String) - Method in class com.ibm.openpages.api.security.UserInfo
Sets password.
setPasswordChangeFromAdmin(boolean) - Method in class com.ibm.openpages.api.security.UserInfo
Specifies that the password was changed by administrator.
setPasswordExpiresInDays(Integer) - Method in interface com.ibm.openpages.api.security.IUser
Sets password duration in days.
setPasswordExpiresInDays(int) - Method in class com.ibm.openpages.api.security.UserInfo
Sets password expiry in days.
setPermission(Permissions) - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
Sets the Permissions(read, write, delete, associate, create) for IRLSRule.
setPort(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the port number that identifies the SMTP server port.
setPostActions(List<IWFAction>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the list of actions performed before the workflow transitions out of the activity.
setPreActions(List<IWFAction>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the list of actions performed after the workflow transitions in to the activity.
setPreferredProfile(IProfile, IUser) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Set the preferred profile for the user.
setPreferredProfile(IProfile) - Method in interface com.ibm.openpages.api.service.IConfigurationService
Set the preferred profile for the current user.
setPrimaryParent(IGRCObject) - Method in interface com.ibm.openpages.api.resource.IGRCObject
Set the primary parent.
setPrimaryParent(Id) - Method in interface com.ibm.openpages.api.resource.IGRCObject
Sets the primary parent.
setPrimaryParent(Boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewAction
 
setProcessCriticality(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Set the criticality to run by the workflow action.
setProcessDefinitionId(Id) - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
Assigns Id of the workflow definition to start.
setProcessDefinitionState(WFProcessDefinitionState) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinitionFindOptions
Set the Process Definition state.
setProcessId(Id) - Method in class com.ibm.openpages.api.process.AbstractExternalProcess
 
setProcessId(Id) - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
Set The process id to query.
setProcessOwners(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the oversight actors to apply by the workflow action.
setProcessStatus(String) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the process status massage to apply by the workflow action.
setProcessStatusLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the list of processStatus labels
setProcessToLaunch(String) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the workflow definition name to launch on the target object This is applicable only when the type is WFActionType.launchNewProcess.
setProgramName(String) - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
Sets the name of the Program object (used for UI-accessible process logs)
setProperties(Map<String, Object>) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
Set the properties defined for the action
setProperties(List<IWFCustomProperty>) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomActionDef
Sets the list of properties.
setQuestionnaireAssessmentTypeName(String) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets type definition name of the questionnaire assessment.
setQuestionnaireScoreThreshold(int) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the score threshold which determines whether an object is created.
setQuestionnaireTemplateTypeName(String) - Method in class com.ibm.openpages.api.questionnaire.CopyAssessmentOptions
Sets type definition name of the questionnaire template.
setQuickFilter(String) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the quick filter.
setRangeEnd(int) - Method in class com.ibm.openpages.api.search.SearchOptions
Sets the ending index of range to return in search results.
setRangeStart(int) - Method in class com.ibm.openpages.api.search.SearchOptions
Set the starting index of range to return in search results.
setRationale(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
Sets the rationale of the questionnaire resource.
setReadSelected(Boolean) - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
Sets the Boolean value for read-only on field definition.
setRecipients(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the recipients email addresses.
setReference(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
Sets the reference of this questionnaire resource.
setReferencePaths(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the reference paths to look up.
setReferenceType(WFObjectReferenceType) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the type of reference
setRelationalOperator(IFindSimpleCondition.RelationalOp) - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
Assigns the relational operator for the condition
setRelationalOperator(WFRelationalOperatorType) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Assigns relational operator type
setRelationFilterId(Id) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the id of the relation filter.
setRelationshipPaths(List<String>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the list of type definition paths to the related object.
setReportDataSource(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the report dataSource
setReportId(Id) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the report id of the report tab
setReportingPeriod(IReportingPeriod) - Method in class com.ibm.openpages.api.audit.AuditLogFilter
Sets the reporting period.
setReportingPeriod(IReportingPeriod) - Method in interface com.ibm.openpages.api.query.IQuery
Sets the IReportingPeriod to use during execution of this query.
setReportingPeriod(IReportingPeriod) - Method in class com.ibm.openpages.api.resource.FolderFilter
Sets the reporting period.
setReportingPeriod(IReportingPeriod) - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
Sets the reporting period.
setRequires(List<String>) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets the list of evidence types required by this question for the question to be considered complete.
setResourceIds(List<Id>) - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
Assigns resource Ids to start calculations.
setResourceIds(List<Id>) - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
Assigns resource Ids to start workflows.
setRespViews(List<IRespView>) - Method in class com.ibm.openpages.api.respview.RespViewList
Assigns the list of responsive views being fetched
setRespViewState(RespViewState) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets the state of the responsive view to retrieve.
setResult(boolean) - Method in class com.ibm.openpages.api.workflow.actions.WFAdvancedEvalResult
 
setResult(boolean) - Method in class com.ibm.openpages.api.workflow.WFConditionReport
 
setResult(boolean) - Method in class com.ibm.openpages.api.workflow.WFEvalResult
 
setResultsPerPage(int) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Set the results per page
setResultsPerPage(Integer) - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
Assigns the number of results per page.
setResultsPerPage(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the results per page
setResultsPerPage(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
Set the results per page when IBaseFindOptions.getIsPagingOn() is true
setResultsPerPage(Integer) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the number of results per page.
setResultsPerPage(Integer) - Method in class com.ibm.openpages.api.workflow.StartProcessesOptions
Assignes the number of results per page.
setRetrieveLatestVersions(boolean) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set whether the latest versions of the rule definitions should be returned.
setRetrieveVersions(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinitionFindOptions
Sets the flag to retrieve the latest version information for the retrieved process definitions.
setRetryTimes(int) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the retry times to send email.
setReturnLastRow(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the last row number to be returned
setReturnOnlyCounts(boolean) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Set the return only count flag.
setReturnOnlyCounts(boolean) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the return only count flag.
setReturnStartRow(int) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the start row number to be returned
setRightValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Assigns the right-side value of the relation
setRuleAttributes(HashMap<String, String>) - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
Sets the attributes from rule containing this event handler, for the event handler to access.
setRuleCondition(IRespViewRuleCondition) - Method in interface com.ibm.openpages.api.respview.IRespView
Sets the view identification rule condition.
setRuleDefinitionId(Id) - Method in class com.ibm.openpages.api.rule.BulkRunCalculationsOptions
Assigns Id of the rule definition to start.
setRuleDefinitionState(TBRuleDefinitionState) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the Process Definition state.
setRuleId(Id) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
 
setRuleOrder(int) - Method in interface com.ibm.openpages.api.respview.IRespView
Sets the view identification rule order.
setRules(List<IRLSRule>) - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
Sets the IRLSRules for a specific TypeDefinition
setRules(List<IRespViewFieldRule>) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the list of rules defined on this field.
setRules(List<IRespViewFieldRule>) - Method in interface com.ibm.openpages.api.respview.IRespViewFilterRules
Sets the list of rules for the filter definition
setRuleTypes(List<TBRuleDefinitionType>) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinitionFindOptions
Set the list of rule types to filter by.
setRuleVersionId(Id) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
 
setSchedJobDetail(ISchedJobDetail) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
 
setScheduleList(List<ISchedJobSchedule>) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Set the list of schedules ISchedJobSchedule for the job
setSearchFFP(String[]) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets facet folder path
setSearchFOT(String[]) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets facet object types
setSearchId(String) - Method in class com.ibm.openpages.api.search.SearchOptions
Not used.
setSectionOverrides(List<IRespViewSection>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the sections of the task focused user interface to override visibility and collapsed state.
setSections(List<IRespViewSection>) - Method in interface com.ibm.openpages.api.respview.IRespView
Sets the list of responsive view sections
setSecureType(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the security type of the SMTP server.
setSeverity(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the severity of the rule.
setShowAttachmentTab(boolean) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets if need to show the question attachment tab
setShowCommentTab(boolean) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets if need to show the question comment tab
setSmtpServer(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the SMTP server host or IP address.
setSortDirection(SortDirection) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the direction of sorting of the relationship rows.
setSortDirection(SortDirection) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
set the sort Direction.
setSortField(IFieldDefinition) - Method in interface com.ibm.openpages.api.respview.IRespViewField
Sets the field definition that is used for sorting of relationship rows.
setSortFieldName(String) - Method in interface com.ibm.openpages.api.rule.IBaseFindOptions
Set the sort field name.
setSortFieldName(String) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
Set the sort field name.
setSortFields(List<SortField>) - Method in interface com.ibm.openpages.api.configuration.IFindOptions
Assigns the list of sort field
setSortFields(List<SortField>) - Method in interface com.ibm.openpages.api.workflow.IWFObjectsEval
Assigns the list of sort field with direction
setStartDate(Date) - Method in class com.ibm.openpages.api.audit.AuditLogFilter
Sets the start date for logs retrieval.
setStartRow(int) - Method in class com.ibm.openpages.api.process.ProcessLogQueryOptions
Set the paging start row index (1-based).
setStartRow(int) - Method in class com.ibm.openpages.api.resource.DeletedResourceFilter
Set the paging start row index.
setStartTime(Date) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the start time for the schedule
setState(TBRuleDefinitionState) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Sets the current state of the rule - draft/published
setStatus(QuestionStatus) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets the status of the question
setStatusMessage(String) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns status message of the process instance via transition actions.
setStatusMessageLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
Assigns status message labels of the process instance via transition actions.
setStringValue(String) - Method in class com.ibm.openpages.api.query.ParameterValue
Sets the value of this input parameter as a String
setSubject(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the subject of the email
setSubjectKeyToNotifyActionCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets 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.
setSubjectKeyToNotifyAssignees(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets application text key that is used as a template for notification subject to assignees.
setSubjectKeyToNotifySubscribers(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets application text key that is used as a template for notification subject to subscribers.
setSubjectKeyToNotifyWorkflowCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Sets 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.
setSubjectKeyToNotifyWorkflowCompleted(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets 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.
setSubjectParams(Object[]) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets parameters that will be formated into subject text
setSubjectTextKey(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the key that is used to locate the application string for a subject
setSubscribers(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the activities subscribers to apply by the workflow action.
setSubscribers(List<String>) - Method in interface com.ibm.openpages.api.workflow.IWFActivityInstance
Sets the subscriber list via transition actions.
setSummaryType(String) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the summary type
setSummaryType(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the summary type
setSuppliedByVendor(boolean) - Method in interface com.ibm.openpages.api.respview.IRespViewContainer
Set/Resets the supplied-by-vendor state.
setTableColumns(List<IQuestionTableColumn>) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets table columns for selection question.
setTabs(List<IDashboardTab>) - Method in interface com.ibm.openpages.api.respview.IDashboardView
Sets the list of dashboard tabs
setTarget(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns the target activity name.
setTargetObjects(IWFObjectsEval) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
Sets the evaluation to get the target objects.
setTargetObjects(IWFObjectsEval) - Method in interface com.ibm.openpages.api.workflow.IWFAction
Sets the eval object for fetching target resources on which to perform the workflow action.
setText(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the text content for guidance
setTextLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the texts for all locales
setTextOverride(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Assigns text to replace default text in workflow transition popup
setTextOverrideEnabled(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Set whether or not text override is enabled
setTextOverrideLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
Sets the list of text to replace default text in workflow transition popup
setTimeout(int) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the time out (in seconds) to send email.
setTitle(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
Sets the title of this questionnaire resource.
setTotalResultCount(int) - Method in class com.ibm.openpages.api.respview.DashboardList
Assigns the total cound of the result.
setTotalResultCount(int) - Method in class com.ibm.openpages.api.respview.RespViewList
Assigns the total cound of the result.
setTransition(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
Sets transition of the questionnaire.
setTransitionComment(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
Sets transition comment of the questionnaire.
setTransitionComment(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransitionOptions
Provide a comment for the activity transition.
setTransitions(List<IWFTransition>) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the list of transitions that users can possibly select to process.
setTransitionsAttributes(HashMap<String, HashMap<String, String>>) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
 
setTriggerCategory(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the trigger category
setTriggerName(String) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobSchedule
Set the name of the trigger
setType(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
Sets the dependency type.
setType(TBRuleActionType) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
Sets the type of the rule action.
setType(TBRuleDefinitionType) - Method in interface com.ibm.openpages.api.rule.ITBRuleDefinition
Set the type of the rule to determine when it should be run
setType(JobDetailType) - Method in interface com.ibm.openpages.api.scheduler.ISchedJobDetail
Sets the type of the job detail.
setType(DateFacetParam.DateFacetType) - Method in class com.ibm.openpages.api.search.DateFacetParam
Set the date facet type: Creation Date, Last Modified Date, Other Dates
setType(UserFacetParam.UserFacetType) - Method in class com.ibm.openpages.api.search.UserFacetParam
Set the user facet type: Created By, Last Modified By, and Name On Object
setType(WFActivityType) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the type of the activity definition.
setType(WFProcessDefinitionType) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
Sets the type of the process definition.
setTypeAssociationsToHonor(List<TypeAssociationToHonor>) - Method in class com.ibm.openpages.api.application.CopyObjectOptions
Sets the the List of TypeAssociationToHonor objects that need to be honored during the copy operation
setTypeDefinitionId(ITypeDefinition) - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
Sets the ITypeDefinition on which the RLS rule is applied.
setTypeDefinitionId(Id) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets Id of the type definition that is used for filtering
setTypeFilters(ITypeDefinition...) - Method in class com.ibm.openpages.api.resource.AssociationFilter
Sets zero or more type definition to use as filters.
setTypeFilters(ITypeDefinition...) - Method in class com.ibm.openpages.api.resource.ContaineeFilter
Adds a one or more type filters.
setUpdateSelected(Boolean) - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
Sets the boolean value for 'read-and-update' on field definition.
setUrl(String) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the static link URL
setUser(String) - Method in class com.ibm.openpages.api.search.UserFacetParam
Set the user facet data for Solr usage.
setUsername(String) - Method in class com.ibm.openpages.api.application.EmailOptions
Sets the user name for authenticating into the SMTP server.
setUsers(List<UserFacetParam>) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
Set the facet value(s) for user(s).
setUuid(UUID) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the UUID of the dashboard panel
setUuid(UUID) - Method in interface com.ibm.openpages.api.respview.IDashboardTab
Sets the UUID of the dashboard tab
setUuid(UUID) - Method in interface com.ibm.openpages.api.respview.IDashboardWidget
Sets the UUID of the dashboard panel
setValidationMessage(String) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Assigns the validation message.
setValidationMessageLabels(List<ILabel>) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
Sets the list of validation message labels.
setValidator(IWFConditionEval) - Method in interface com.ibm.openpages.api.rule.ITBAction
Sets the validator to run by the workflow action.
setValue(String) - Method in interface com.ibm.openpages.api.configuration.IFindSimpleCondition
Assigns the value to match
setValue(Boolean) - Method in interface com.ibm.openpages.api.resource.IBooleanField
Sets the field value with a boolean.
setValue(Date) - Method in interface com.ibm.openpages.api.resource.IDateField
Sets the field value with a date.
setValue(Double) - Method in interface com.ibm.openpages.api.resource.IFloatField
Sets the field value with a double.
setValue(Integer) - Method in interface com.ibm.openpages.api.resource.IIntegerField
Sets the field value with a integer.
setValue(Id) - Method in interface com.ibm.openpages.api.resource.IReferenceField
Sets the field value with a reference Id.
setValue(String) - Method in interface com.ibm.openpages.api.resource.IStringField
Sets the field value with a string.
setValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
Sets the value.
setValue(String) - Method in interface com.ibm.openpages.api.workflow.actions.IWFCustomProperty
Sets the value as a String.
setValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFFieldSetter
Assigns the field value evaluation unit.
setValue(String) - Method in interface com.ibm.openpages.api.workflow.IWFStringEval
Assigns value that is evaluated at run-time
setValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval.IWFSwitchCase
Assigns the 'value' evaluation unit
setValues(List<String>) - Method in interface com.ibm.openpages.api.configuration.IFindInCondition
Assigns the list of values to match
setValues(Object) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRuleController
Sets the values of the controller for which the field dependency will evaluate to true.
setValues(List<String>) - Method in interface com.ibm.openpages.api.respview.IRespViewRuleCondition
Sets the values to match when the type is not RespViewRuleConditionType.conditions
setVariableValue(IWFEvalUnit) - Method in interface com.ibm.openpages.api.rule.ITBAction
Sets the eval unit for a calculation definition variable
setViewName(String) - Method in interface com.ibm.openpages.api.workflow.IWFActivity
Assigns the name of the view used by the task focused user interface.
setViewType(RespViewType) - Method in class com.ibm.openpages.api.respview.RespViewFilter
Sets type of the responsive view that is used for filtering
setVisibilityDependency(IQuestionDependency) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets a question dependency object.
setWeight(int) - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
Sets weight of the question.
setWeight(int) - Method in interface com.ibm.openpages.api.questionnaire.ISection
Sets the weight of the section.
setWFProcessDefinitionId(Id) - Method in interface com.ibm.openpages.api.rule.ITBRuleAction
Sets id of the workflow process definition.
setWidgets(List<IDashboardWidget>) - Method in interface com.ibm.openpages.api.respview.IDashboardPanel
Sets the list of dashboard widgets
SHOULDBE_GREATER_THAN_ERROR - Static variable in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
 
SHOULDBE_LESS_THAN_ERROR - Static variable in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
 
SIBLING_OBJECT_SELECT_DROPDOWN - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
Dropdown Sibling Object Selector
SolutionException - Exception in com.ibm.openpages.api.solution
 
SolutionException(int, List<Object>, Throwable) - Constructor for exception com.ibm.openpages.api.solution.SolutionException
 
SolutionLayoutType - Enum in com.ibm.openpages.api.solution
 
SolutionType - Enum in com.ibm.openpages.api.solution
 
SortDirection - Enum in com.ibm.openpages.api.respview
Represents the sort direction
SortField - Class in com.ibm.openpages.api.configuration
Represents sorting field for the configuration data query, used by IFindOption .
SortField() - Constructor for class com.ibm.openpages.api.configuration.SortField
 
SortField(String, SortField.SortDirection) - Constructor for class com.ibm.openpages.api.configuration.SortField
 
SortField.SortDirection - Enum in com.ibm.openpages.api.configuration
Type of sorting direction
SPAN_COLUMNS_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
 
START_NODE_MISSING_CONDITIONS - Static variable in exception com.ibm.openpages.api.workflow.WFException
 
startBulkWorkflowAction(BulkWorkflowActionOptions) - Method in interface com.ibm.openpages.api.service.IWorkflowService
Executes the selected action on the given set of resources, through a long running process
startCalculationsInBulk(BulkRunCalculationsOptions) - Method in interface com.ibm.openpages.api.service.ITBRuleService
Starts calculations on any objects that meet the following criteria, through a long running process - on the object type of the calculation - object is unlocked - the object meets the applicability criteria of the calculation definition
startProcess(Id, Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
Instantiates a workflow process for the given resource id.
startProcess(Id, Id, Map<String, Object>) - Method in interface com.ibm.openpages.api.service.IWorkflowService
Instantiates a workflow process for the given resource id with given process variables.
startProcessesInBulk(StartProcessesOptions) - Method in interface com.ibm.openpages.api.service.IWorkflowService
Starts workflow process on any objects that meet the following criteria, through a long running process - on the object type referred by the process definition - there is no active workflow on the object - object is unlocked - the object meets the applicability criteria of the process definition
StartProcessesOptions - Class in com.ibm.openpages.api.workflow
Represents the options to start workflows in bulk, used by IWorkflowService.startProcessesInBulk(StartProcessesOptions)
StartProcessesOptions() - Constructor for class com.ibm.openpages.api.workflow.StartProcessesOptions
 
strongPasswordEnforced() - Method in interface com.ibm.openpages.api.security.IPasswordPolicy
If strong password policy is enforced, each password will be required to contain at least one character from each group configured by admin.
syncProcess(Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
The process/activity fields are typically set based on related objects.
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.