- 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
- 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 GRC.
- 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 currewnt field.
- 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.LaunchProgramOptions
-
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.
- setAndOr(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
-
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(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.
- 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.
- 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.
- 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.
- 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
- 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.
- 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
- 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
- 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(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.workflow.IWFAction
-
Assigns the condition to determine the action is taken or is skipped.
- 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.IWFObjectCountEval
-
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(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
-
- 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
- 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.
- 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.LaunchProgramOptions
-
Sets if copy question attachments
- setCopyQuestionComments(boolean) - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
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.
- setCriticality(WFProcessCriticality) - Method in interface com.ibm.openpages.api.workflow.IWFProcess
-
Assigns criticality of the process instance via transition actions.
- 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.workflow.IWFAction
-
Sets the custom action object that should be executed.
- 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.IRespView
-
Sets the responsive view'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.IRespView
-
Sets the description of the responsive view.
- 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
- 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.IWFProcess
-
Assigns due date of the process instance via transition actions.
- 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.
- 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.IRespView
-
Enables or disables the responsive view
- setEnabled(boolean) - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
-
Set Enabled
- setEnabled(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFProcessDefinition
-
Enables or disables the process definition.
- 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.
- 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
-
- 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
- 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.
- setExpr(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval
-
Assigns the 'expr' evaluation unit
- 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 string.
- 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.
- 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.workflow.IWFAction
-
Sets the field setter to run by the workflow action.
- 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(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.
- 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.
- 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.
- setFrom(String) - Method in class com.ibm.openpages.api.application.EmailOptions
-
Sets the from email address.
- 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 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.IWFObjectCountEval
-
Assigns the flag to look up only primary relationships.
- 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.
- 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.
- 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.
- setIncludeMembers(boolean) - Method in class com.ibm.openpages.api.security.GroupOptions
-
Sets includeMembers setting
- 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.workflow.IWFBaseFindOptions
-
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.respview.IRespViewRuleCondition
-
- setInvertMatch(Boolean) - Method in interface com.ibm.openpages.api.workflow.IWFRelationalConditionEval
-
Assigns the flag to invert the result of this condition.
- setIsDefault(Boolean) - Method in class com.ibm.openpages.api.respview.RespViewFilter
-
Sets the default state of the responsive view that is used for filtering
- setIsEnabled(Boolean) - Method in class com.ibm.openpages.api.respview.RespViewFilter
-
Sets the enabled state of the responsive view that is used for filtering
- 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.
- setKey(IWFEvalUnit) - Method in interface com.ibm.openpages.api.workflow.IWFSwitchesEval.IWFSwitchCase
-
Assigns the 'key' evaluation unit
- 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.
- 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.IWFObjectCountEval
-
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
- 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
- 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
-
- setLogicalOperator(LogicalOperatorType) - Method in interface com.ibm.openpages.api.workflow.IWFConditionGroupEval
-
Assigns logical operator type
- setLogicalOperatorType(LogicalOperatorType) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Sets the RbsLogicalOperator for RLSRule.
- setMaxResults(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
-
Set the Maximum results for the search results.
- setMaxRows(int) - Method in interface com.ibm.openpages.api.query.IQuery
-
- 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.
- 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.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.workflow.actions.IWFCustomProperty
-
Sets the name of the property.
- setName(String) - Method in interface com.ibm.openpages.api.workflow.IWFAction
-
Sets the name of the workflow action.
- 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.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
- setNotifyAssignees(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
-
Sets if the workflow transition sends notifications to assignees.
- 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.
- setObjectType(String) - Method in interface com.ibm.openpages.api.workflow.IWFObjectCountEval
-
Assigns the object type value.
- setObjectTypes(List<Id>) - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Set the facet value for object-types.
- 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.
- 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.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.workflow.IWFBaseFindOptions
-
Set the Pagination On for the search results
Default value for this flag is false.
- 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.
- 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.
- 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.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
- 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.LaunchProgramOptions
-
Sets type definition name of the questionnaire assessment.
- setQuestionnaireTemplateTypeName(String) - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
Sets type definition name of the questionnaire template.
- 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.IWFObjectCountEval
-
Assigns the reference paths to look up.
- setReferenceType(WFObjectReferenceType) - Method in interface com.ibm.openpages.api.workflow.IWFObjectCountEval
-
Assigns the type of reference
- 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.
- 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
-
- 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.
- setRespViewState(RespViewState) - Method in class com.ibm.openpages.api.respview.RespViewFilter
-
Sets the state of the responsive view to retrieve.
- setResultsPerPage(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
-
- 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.workflow.IWFBaseFindOptions
-
Set the last row number to be returned
- setReturnOnlyCounts(boolean) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
-
Set the return only count flag.
- setReturnStartRow(int) - Method in interface com.ibm.openpages.api.workflow.IWFBaseFindOptions
-
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.
- 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
- setSearchId(String) - Method in class com.ibm.openpages.api.search.SearchOptions
-
Not used.
- 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.workflow.IWFBaseFindOptions
-
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.workflow.IWFBaseFindOptions
-
Set the sort field name.
- 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.
- 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.
- 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.
- setSuppliedByVendor(boolean) - Method in interface com.ibm.openpages.api.respview.IRespView
-
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.
- setTarget(String) - Method in interface com.ibm.openpages.api.workflow.IWFTransition
-
Assigns the target activity name.
- 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.
- 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.
- 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
-
- setType(String) - Method in interface com.ibm.openpages.api.respview.IRespViewFieldRule
-
Sets the dependency type.
- 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
-
- 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.
- 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).
- 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.workflow.IWFAction
-
Sets the validator to run by the workflow action.
- 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(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
-
- 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.
- 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
- SortDirection - Enum in com.ibm.openpages.api.respview
-
Represents the sort 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
-
- startProcess(Id, Id) - Method in interface com.ibm.openpages.api.service.IWorkflowService
-
Instantiates a workflow process for the given resource id.
- 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.