- get(String) - Method in class com.ibm.openpages.api.Context
-
Returns the value to which the specified key is mapped, or null if this context contains no mapping for the key.
- getAcceptance() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getAccess() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
-
Returns the List for this rule.
- getAccess() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the List for this rule.
- getAccessFor(int) - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the IRLSAccess for this rule.
- getAccessibleGroups() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves all groups accessible by current user.
- getAction() - Method in class com.ibm.openpages.api.search.DateFacetParam
-
Get the date facet action: On Date, Range Date, Previous Days, Next Days
- getAction() - Method in class com.ibm.openpages.api.search.UserFacetParam
-
Get the user facet action: Me, and Others
- getActorImpersonates(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Find all actors, users or groups, that the given actor impersonates.
- getAdditionalMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
-
Returns the OpenPages message of this exception if there is any,
otherwise returns the message of the exception.
- getAdministrator() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns
ISecurityPrincipal of the administrator to whom this
administrative permission applies.
- getAdminLevel() - Method in class com.ibm.openpages.api.security.GroupInfo
-
Gets the administration level for the user group.
- getAdminLevel() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns the OpenPages administration level associated with the security group.
- getAdminLevel() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the administration level associated to this user.
- getAdminPermissions() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Retrieves the administrative permissions for a security principal.
- getAdminPermissions(List<Id>, List<Id>) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Finds administrator permissions for provided list of group ids and
list of administrator ids.
- getAllMembers() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns all members of a security group.
- getAllParameterNames() - Method in interface com.ibm.openpages.api.application.IReportParameters
-
Gets all the report parameter names.
- getAllQuestionsMatched() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
If all questions in the program template are matched.
- getAllRLSRules() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns list of All the rules
- getAnswer() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns answer of the question.
- getAnswerCount() - Method in interface com.ibm.openpages.api.questionnaire.ISection
-
- getAnsweredBy() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns the user who last answered
- getAnsweredOnDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns the timestamp when the answer was persisted
- getAnswerType() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns answer type
- getApplicationPermission(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves application permission by Id.
- getApplicationPermission(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves application permission by name.
- getApplicationPermissions() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves all the application permissions
- getArgumentCount() - Method in interface com.ibm.openpages.api.configuration.ITextFormatter
-
Returns the number of arguments that can be bound to this message template.
- getAssetContentTypeId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
- getAssignee() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns the assignee (user) of this questionnaire.
- getAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getAssociationAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a List of AssociationAuditLogs for a given GRCObject Id.
- getAssociationAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a list of AssociationAuditLogs for a given GRCObject Id.
- getAssociationDefinition(Id) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the association based on the Id.
- getAssociationDefinition() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
-
Returns the association definition for this node.
- getAssociationFilter() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
-
Returns the association filter.
- getAssociationFilter() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
-
Returns the association filter.
- getAttachments() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a list of attachments of the assessment.
- getAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
-
Returns a Map containing the event handler's attributes and their values.
- getAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractRule
-
Returns HashMap containing rule attributes and their values.
- getAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog)
for a given GRCObject Id.
- getAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a list of all AuditLogs (IFieldAuditLog, IAssociationAuditLog)
for a given GRCObject Id and AuditLogFilter.
- getAuthor() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getAuthor() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getAvailableTransitions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns available transitions to set, which is determined by the lifecycle.
- getBaseAmount() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
-
Returns the currency base amount.
- getBaseCurrency() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
-
Returns the base currency.
- getBaseCurrency() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the base currency.
- getBody() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the body of the email
- getBodyParams() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets parameters that will be formated into body text
- getBodyTextKey() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the key that is used to locate the application string for body
- getBooleanValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as a Boolean
- getBundleName(String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Gets the name of the Bundle from the bundleFieldPath.
- getCanAddGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the add group permission of the administrator on the security domain.
- getCanAssignRole() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the role assignment permission of the administrator on the security domain.
- getCanAssociate() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
Returns associate permission.
- getCanAssociate() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns associate permission.
- getCanBrowse() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the browse user or group permission of the administrator on the security domain.
- getCanCreate() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the create user or group permission of the administrator on the security domain.
- getCanDelete() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
Returns delete permission.
- getCanDelete() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns delete permission.
- getCanDisable() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the disable user or group permission of the administrator on the security domain.
- getCanEnable() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the enable user or group permission of the administrator on the security domain.
- getCanLock() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the lock permission of the administrator on the security domain.
- getCanManage() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the manage user or group permission of the administrator on the security domain.
- getCanModify() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the modify user or group permission of the administrator on the security domain.
- getCanRead() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
Returns read permission.
- getCanRead() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns read permission.
- getCanRemove() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the remove user or group permission of the administrator on the security domain.
- getCanRemoveGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the remove group permission of the administrator on the security domain.
- getCanResetPassword() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the password reset permission of the administrator on the security domain.
- getCanRevokeRole() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the role revoke permission of the administrator on the security domain.
- getCanUnLock() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the unlock permission of the administrator on the security domain.
- getCanWrite() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
Returns write permission.
- getCanWrite() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns write permission.
- getCaseInsensitive() - Method in interface com.ibm.openpages.api.query.IQuery
-
Returns true when case insensitive comparison is done; otherwise, false is returned.
- getCategory() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
-
Returns the category of an application text
- getChild() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
-
Returns the "child" type definition of this association.
- getChild() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
-
Returns the single child Id for the child object of this event.
- getChild() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
-
Returns the single child Id for the child object of this event.
- getChildProcesses() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the children processes of the process.
- getChildren() - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
- getChildren() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
-
Returns the list of Ids of the children objects of this event.
- getChildren() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
-
Returns the list of Ids of the children objects of this event.
- getChildrenAssociations() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns all children associations for this type (i.e., all other type definitions
for which this type has a direct navigation path).
- getChildrenTypesToCopy() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
-
Gets the children Object Types to be copied.
- getChildrenTypesToCopy() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
Gets the children Object Types to be copied.
- getChildrenTypesToMove() - Method in class com.ibm.openpages.api.application.MoveObjectOptions
-
- getCode() - Method in class com.ibm.openpages.api.ErrorCode
-
The numeric error code Id for this error.
- getCode() - Method in exception com.ibm.openpages.api.OpenPagesException
-
- getColumnName() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
-
Gets the name of the column.
- getColumnValue(int) - Method in interface com.ibm.openpages.api.application.ICognosReportRow
-
Returns the column value for the specified column.
- getColumnValueByName(String) - Method in interface com.ibm.openpages.api.application.ICognosReportRow
-
Returns the column value for the specified column name.
- getComments() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a list of comments of the assessment.
- getCommentType() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getCompletionRequired() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
- getConditions() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
-
Returns the condition of FLSRule.
- getConditions() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the condition of RLSRule.
- getConfigProperties() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve configuration properties.
- getConfigurationFactory() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Get an instance of IConfigurationFactory.
- getConflictBehavior() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
-
Gets the conflict resolution behavior for this copy operation.
- getConflictBehavior() - Method in class com.ibm.openpages.api.application.MoveObjectOptions
-
- getConflictBehavior() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
Gets the conflict resolution behavior for this copy operation.
- getContainees(ContaineeFilter) - Method in interface com.ibm.openpages.api.resource.IFolder
-
Returns contained object based on the supplied filter.
- getContainees() - Method in interface com.ibm.openpages.api.resource.IFolder
-
Returns contained objects including both folders and GRCObjects with all fields, and for all types, based on the reporting period of the folder.
- getContent() - Method in interface com.ibm.openpages.api.resource.IDocument
-
Returns the file content for this document.
- getContentLength() - Method in interface com.ibm.openpages.api.resource.IDocument
-
Returns the length of the content associated with this document.
- getContext() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the API context
- getContext() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
-
Provides access to the API context object.
- getControllerField() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
-
Gets the Field Definition for this Controller field.
- getControllerPath() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
-
Returns path of the controlling object.
- getControllers() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
-
Returns the fields and their values that control the state of the current
IFieldDefinition for this dependency type.
- getControllers() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency
-
Returns the fields and their values that control the state of the current
IQuestion.
- getControllerType() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
-
- getControllerValues() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
-
Gets all Controlling values.
- getControllerValues() - Method in interface com.ibm.openpages.api.questionnaire.IControllerQuestionMap
-
Gets all the Controlling values.
- getCopiedObjectId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
Returns the Id of the copied object in this event.
- getCopyFromProgramId() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
- getCopyFromTemplateId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The Id of the copy from Questionnaire Template object used by the Program.
- getCreatedBy() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the creator (user) of the process.
- getCreatedById() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The creator (user) id of querying processes.
- getCreatedOn() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the created time of the process.
- getCreatedOn() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns creation date.
- getCreatedOnBegin() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The begin of the created time of querying processes.
- getCreatedOnEnd() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The end of the created time of querying processes.
- getCreatedResource() - Method in class com.ibm.openpages.api.trigger.events.CreateResourceEvent
-
If available, as in a POST event, Returns the created resource object that was
the result of this create event i.e.
- getCreationDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getCreationDate() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the creation date of this resource.
- getCreationDate() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the creation date of this resource.
- getCreator() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the creator (user) of this resource.
- getCurrencies(boolean) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieves a list of ICurrency objects that are available in the configuration.
- getCurrency() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
-
Returns the currency for which the exchange rate applies.
- getCurrency(ISOCurrencyCode) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve currency information for the specified currency code.
- getCurrencyCode() - Method in interface com.ibm.openpages.api.configuration.ICurrency
-
Returns the ISO 4217 currency code.
- getCurrencyValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as a Double
- getCurrentExchangeRate(ICurrency) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the current exchange rate for the currency.
- getCurrentPasswordPolicy() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves current OpenPages password policy.
- getCurrentReportingPeriod() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the "current" reporting period.
- getCurrentUser() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Returns the currently logged in user.
- getDataType() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
-
Gets the data type of the column.
- getDataType() - Method in interface com.ibm.openpages.api.application.IParameter
-
Gets the data type of the parameter.
- getDataType() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the data type part of the property definition.
- getDataType() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the
DataType for this input parameter
- getDataType() - Method in interface com.ibm.openpages.api.resource.IField
-
Returns the data type for this field.
- getDate() - Method in class com.ibm.openpages.api.search.DateFacetParam
-
Get the date facet data formated for Solr usage.
- getDateChanged() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the role assignment changed date.
- getDateChanged() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns role template changed date.
- getDateCreated() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the role assignment creation date.
- getDateCreated() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns the role template creation date.
- getDates() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Get the facet value(s) for date(s).
- getDateValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as a Date
- getDefaultMaxRows() - Method in interface com.ibm.openpages.api.service.IQueryService
-
Returns the default maximum number of rows to return.
- getDefaultOptions() - Static method in class com.ibm.openpages.api.application.CopyObjectOptions
-
Constructs a new instance of CopyObjectOptions with default parameters:
- includeChildren = true
- ChildrenTypesToCopy = ALL
- conflictBehavior = CopyConflictBehavior.CREATECOPYOF
- getDefaultOptions() - Static method in class com.ibm.openpages.api.application.MoveObjectOptions
-
Constructs a new instance of MoveObjectOptions with default parameters.
- getDefaultProfile() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the system's default profile.
- getDefaultTimeSeconds() - Method in interface com.ibm.openpages.api.process.IProcessType
-
Returns the default time seconds of the process type.
- getDefaultValue() - Method in interface com.ibm.openpages.api.application.IParameter
-
Gets the default value set for this parameter in the report.
- getDefaultValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the default value for this field when specified in the model.
- getDefinition() - Method in interface com.ibm.openpages.api.configuration.IProfile
-
Returns the profile definition in XML format.
- getDependencies() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the list of all dependencies for this field.
- getDependencyType() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
-
Returns the dependency type (PICKLIST, VISIBILITY, EDITABILITY,
REQUIREDNESS).
- getDependentValues(String) - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
-
For FieldDependencyType: PICKLIST, the Controller Field's value will be
mapped to a List of EnumValues that are from the Dependent Field.
- getDescription() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
-
Returns the description of FLSRule.
- getDescription() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getDescription() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the description of RLSRule.
- getDescription() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the system level description of the property.
- getDescription() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the system type description part of the model.
- getDescription() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the description of the process.
- getDescription() - Method in interface com.ibm.openpages.api.process.IProcessType
-
Returns the description of the process type.
- getDescription() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the description of this questionnaire resource.
- getDescription() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
-
- getDescription() - Method in interface com.ibm.openpages.api.resource.IEnumAnswer
-
Returns description of this enumerated answer.
- getDescription() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the description of this resource.
- getDescription() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the description of this resource.
- getDescription() - Method in class com.ibm.openpages.api.security.GroupInfo
-
Gets the description for the user group.
- getDescription() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
-
Returns descriptive text for an application permission.
- getDescription() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns descriptive information about the security group.
- getDescription() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns descriptive text for this role template.
- getDescription() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns description information about the account.
- getDescription() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
-
Get Description
- getDestinationName() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
Returns the destination name for the copied resource for this event.
- getDisableAllTriggers() - Method in class com.ibm.openpages.api.Context
-
Returns whether all triggers are disabled or not.
- getDisplayName() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the display name according to application text information com.display.name.format
- getDisplayType() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
-
Retrieves the displayType information for this field.
- getDueDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
- getEffectivePermissions(Id, Id) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Retrieves the effective resource permissions, read, write, delete, and
associate that a user has for a specific OpenPages resource.
- getEmail() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
-
Get Email
- getEmailAddress() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns the email address associated with a security group.
- getEmailAddress() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the email address associated with a user.
- getEmailOption() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
- getEndDate() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
-
- getEndDate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
-
Returns the end date of the applicability period of an exchange rate.
- getEndTime() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the end time of the process log.
- getEnumAnswers() - Method in interface com.ibm.openpages.api.resource.IEnumAnswersField
-
Returns the ordered values of an enumerated answers field.
- getEnumValue(String) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the IEnumValue by its system name.
- getEnumValue() - Method in interface com.ibm.openpages.api.resource.IEnumField
-
Returns the field value as an element of an enumeration.
- getEnumValueById(Id) - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the IEnumValue by its Id.
- getEnumValues() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the list of
IEnumValue for all the elements that are part of an enumeration.
- getEnumValues() - Method in interface com.ibm.openpages.api.resource.IMultiEnumField
-
Returns the value of a multi-selectable enumerated field.
- getErrorMessageId() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the id of the error code of the process log.
- getEstimatedTotalResults() - Method in interface com.ibm.openpages.api.search.ISearchResults
-
Gets the estimated total number of results matching the provided search terms.
- getEvaluateComputedFields() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
-
Returns whether computed fields are evaluated
- getEventForName(String) - Static method in enum com.ibm.openpages.api.trigger.events.TriggerEventType
-
Returns the supported trigger event type, provided the standard name.
- getExchangeRate() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
-
Returns the exchange rate.
- getExchangeRate(ICurrency, Date) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the exchange rate for the currency on a particular date.
- getExchangeRateHistory(ICurrency) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the exchange rate history for the currency.
- getExchangeRates(boolean) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the exchange rates for all currencies based on the parameter.
- getFacetOption() - Method in class com.ibm.openpages.api.search.SearchOptions
-
The list of types, identified by their Id, to scope the search.
- getFactory() - Static method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory
-
Returns new instance of GRCTriggerEventFactory
- getField(String) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the field definition with the specified system name.
- getField(Id) - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the field definition with the specified Id.
- getField(int) - Method in interface com.ibm.openpages.api.query.IResultSetRow
-
Directly access the value of the designated column in this IResultSetRow object as an IField object.
- getField(String) - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
Returns a field based on its system name, if it exists.
- getField(Id) - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
Returns a field based on its field definition Id.
- getField(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Returns a Field Definition by propertyid.
- getField(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Returns the field definition with the specified system name.
- getFieldAuditLog(Id) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a list of FieldAuditLogs for a given GRCObject Id.
- getFieldAuditLog(Id, AuditLogFilter) - Method in interface com.ibm.openpages.api.service.IAuditService
-
Retrieves a list of FieldAuditLogs for a given GRCObject Id.
- getFieldDefinition() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
-
Returns the Field Definition for IFLSRule.
- getFieldDefinition() - Method in interface com.ibm.openpages.api.resource.IField
-
Returns the field definition.
- getFieldFilters() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
-
Returns a unique list of field definition used as filters.
- getFieldFilters() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
-
Returns a unique list of field definition filters.
- getFieldFilters() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
-
Returns a unique list of field definition used as filters.
- getFieldGroup() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getFieldGroup() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getFieldName(String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Gets the name of the Field from the bundleFieldPath.
- getFields() - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
Returns the list of fields that compose this object.
- getFieldsDefinition() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns all field definitions part of this type definition.
- getFileExtension() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
-
Returns file extension.
- getFilename() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getFileSize() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getFileType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Return a supported file type based on the file extension.
- getFileType(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Return a supported file type based on it's Id.
- getFileType(String, String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Gets a file type from the set of all
possible file types defined in the OpenPages instance for a given mime type and extension combination.
- getFileTypeByMimeType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Return a supported file type based on mime type.
- getFileTypeDefinition() - Method in interface com.ibm.openpages.api.resource.IDocument
-
Returns the file type definition.
- getFileTypes() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns all the valid combinations of file extensions and MIME types defined for
this type.
- getFinalizedDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getFirstName() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the first name of the user.
- getFirstName() - Method in class com.ibm.openpages.api.security.UserInfo
-
Gets first name.
- getFloatValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as a Double
- getFlsRules() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
-
Returns the list of IFLRule applied to a specific TypeDefinition.
- getFolder() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the folder that is the scope of the object permissions assignment.
- getFolder(String, FolderFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a Folder object by path.
- getFolder(String) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a Folder object by path for the current period.
- getFolder(Id, FolderFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a Folder object by Id.
- getFolder(Id) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a Folder object by Id for the current period.
- getFolderPath() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Get the facet value for folder path.
- getFrom() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the from email address
- getFullName() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
-
Returns a full path name associated with an application permission.
- getFullPath(String, boolean, List<ITypeDefinition>) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns full resource path provided relative path, boolean isFolder, and
list of all ITypeDefinitions.
- getFullPath(ContentType, String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
- getFullPath(String, boolean, ITypeDefinition) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns full resource path provided relative path, boolean isFolder and
the ITypeDefinition for the GRCObject.
- getGRCObject(String, GRCObjectFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a GRC object by path with specified filter for fields and associations.
- getGRCObject(String) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a GRC object by path for the current period including all fields and no associations.
- getGRCObject(Id, GRCObjectFilter) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a GRC object by ID with specified filter for fields and associations.
- getGRCObject(Id) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Get a GRC object by Id for the the current period including all fields and no associations.
- getGroup() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns
IGroup of the security domain on which this
administrative permission applies.
- getGroup(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves group by Id.
- getGroup(Id, GroupOptions) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves group by Id.
- getGroup(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves group by name.
- getGroup(String, GroupOptions) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves group by name.
- getGroupIds() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns a list of group Ids that the user belongs to.
- getGroups() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns all the groups the user belongs to.
- getGroups(boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves groups from the OpenPages security system.
- getHonorPrimary() - Method in interface com.ibm.openpages.api.query.IQuery
-
Returns true to honor primary association; otherwise, false is returned.
- getId() - Method in interface com.ibm.openpages.api.audit.IAuditLog
-
Gets the Id of the object.
- getId() - Method in interface com.ibm.openpages.api.configuration.ICurrency
-
Returns id associated to a currency.
- getId() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
-
Returns the id associated to an exchange rate.
- getId() - Method in interface com.ibm.openpages.api.configuration.IProfile
-
Returns the profile unique Id.
- getId() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getId() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
-
Returns the Id of the association.
- getId() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
-
Returns
Id - unique identifier of the enum value.
- getId() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the unique id associated with the field definition.
- getId() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
-
Return the unique Id associated with the file type definition.
- getId() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the unique identifier for this type.
- getId() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getId() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getId() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the Id of this questionnaire resource.
- getId() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
-
Returns the id of this node.
- getId() - Method in interface com.ibm.openpages.api.resource.IField
-
Returns the id for this field.
- getId() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the Id of this resource.
- getId() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the Resource Id of this resource.
- getId() - Method in interface com.ibm.openpages.api.security.IAdminPermission
-
Returns the Id for this administrative permission.
- getId() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
-
Returns the Id associated with an application permission.
- getId() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns the Id for this object-level permission.
- getId() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the Id of the assignment.
- getId() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns the Id for this role template.
- getId() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns the Id for a security principal.
- getId() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns OpenPages system Id of the user.
- getIdForPath(String) - Method in interface com.ibm.openpages.api.service.IResourceService
-
Retrieves just the Id for a GRC Object or Folder given a full path
without retrieving the entire object.
- getIgnoreError() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets whether to continue sending out emails when an error occurred
- getInclAssociationForReturnObjs() - Method in class com.ibm.openpages.api.application.CopyObjectOptions
-
Gets the association filter value for returned GRCObjects.
- getIncludeAssociations() - Method in class com.ibm.openpages.api.resource.AssociationFilter
-
Returns the include associations type.
- getIncludeContainees() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
-
Returns the type of containees included.
- getIncludeOrphanField() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
-
Returns whether orphan fields are included
- getIndex() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
-
Returns the index of the enum value.
- getIntegerValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as an Integer
- getJspPath() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the path for a JSP resource associated to this type definition.
- getLabel() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getLabel() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
-
- getLabel() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionTableColumn
-
- getLastModifiedBy() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the user who last modified this resource.
- getLastModifiedDate() - Method in interface com.ibm.openpages.api.configuration.IReportingPeriod
-
- getLastModifiedDate() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
- getLastName() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the last name of the user.
- getLastName() - Method in class com.ibm.openpages.api.security.UserInfo
-
Gets last name.
- getLatestProcess(Id) - Method in interface com.ibm.openpages.api.service.IProcessService
-
Get latest process information of a specific process type.
- getLevel() - Method in class com.ibm.openpages.api.security.GroupInfo
-
Gets the level for the user group.
- getLifecycleAssigneeField(IGRCObject) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getLifecycleNameFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleStageFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleStatusFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleTransitionFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLifecycleUpdateAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getLinkBuffer() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the string buffer for a URL that points to the object in OpenPages
- getLocalAmount() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
-
Returns the local amount.
- getLocalCurrency() - Method in interface com.ibm.openpages.api.resource.ICurrencyField
-
Returns the local currency.
- getLocale() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the locale to get translated application texts for subject and body
- getLocale() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns locale information associated with the security principal.
- getLocale() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
-
Get Locale
- getLocalizedApplicationText(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the translated string associated with the key.
- getLocalizedApplicationText(Id) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the translated string associated with the key id.
- getLocalizedApplicationText(String, Locale) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the translated string associated with the key and the locale.
- getLocalizedApplicationTexts(Set<String>) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve list of application text for the given categories, or for every category if given categoryFilters is empty.
- getLocalizedApplicationTexts(Set<String>, Locale) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve list of application text for given locale and for the given categories, or for every category if given categoryFilters is empty.
- getLocalizedErrorText(int) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve the translated error message associated with the error code.
- getLocalizedGuidance() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the field guidance in the user locale.
- getLocalizedGuidances() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the map of the field guidance in every locale
- getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
-
Returns the localized name of the enum value.
- getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the field definition name in the user locale.
- getLocalizedLabel() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the type definition singular name in the user locale.
- getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
-
Returns the map of the field definition name in every locale
- getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the map of the field definition name in every locale
- getLocalizedLabels() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the map of the type definition singular name in every locale
- getLocalizedMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
-
Returns the localized message of this exception.
- getLocalizedPluralLabel() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the type definition plural name in the user locale.
- getLocalizedPluralLabels() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the map of the type definition plural name in every locale
- getLogger(Class<?>) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns Logger instance.
- getLogger(String) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns Logger instance.
- getLogger() - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns Logger instance.
- getLoggerFactory() - Static method in class com.ibm.openpages.api.logging.LoggerFactory
-
- getLogicalOperator() - Method in interface com.ibm.openpages.api.metadata.IFieldDependency
-
Returns the logical operator used to group conditions from controllers
(AND, OR).
- getLogicalOperator() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency
-
Returns the logical operator used to group conditions from controllers
(AND, OR).
- getLogicalOperatorType() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the security rules logical operator.
- getMax() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
-
Upper bound of the cardinality associated with this association definition.
- getMaxLength() - Method in interface com.ibm.openpages.api.security.IPasswordPolicy
-
Returns the maximum length for a password.
- getMaxRiskScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns maximum risk score of the question.
- getMaxRiskScore() - Method in interface com.ibm.openpages.api.questionnaire.ISection
-
- getMaxRows() - Method in interface com.ibm.openpages.api.query.IQuery
-
- getMaxValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the maximum allowable value for this field when specified in the model.
- getMembers(boolean) - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns all members of a security group.
- getMessage() - Method in exception com.ibm.openpages.api.OpenPagesException
-
Returns the message of this exception.
- getMiddleName() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns the middle name of the user.
- getMiddleName() - Method in class com.ibm.openpages.api.security.UserInfo
-
Gets middle name.
- getMimeType() - Method in interface com.ibm.openpages.api.metadata.IFileTypeDefinition
-
Returns the MIME type of the file.
- getMimeTypeIDs() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Get the facet value for MIME type.
- getMin() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
-
Lower bound of the cardinality associated with this association definition.
- getMinLength() - Method in interface com.ibm.openpages.api.security.IPasswordPolicy
-
Returns the minimum length for a valid password.The default value is 6.
- getMinValue() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the minimum allowable value for this field when specified in the model.
- getMode() - Method in class com.ibm.openpages.api.search.SearchOptions
-
The search mode either BASIC or ADVANCED.
- getModifiedDate() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the last modified date of this resource.
- getModifiedDate() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the last modified date of this resource.
- getModifiedFields(IGRCObject) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Gets a list of Fields that have been modified on the GRCObject before it is saved (committed).
- getName() - Method in interface com.ibm.openpages.api.application.IParameter
-
Gets the name of the parameter as defined in a Cognos report specification.
- getName() - Method in interface com.ibm.openpages.api.audit.IAuditLog
-
Gets the name of the object.
- getName() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
-
Returns the name of an application text
- getName() - Method in interface com.ibm.openpages.api.configuration.ICurrency
-
Returns the descriptive name of a currency.
- getName() - Method in interface com.ibm.openpages.api.configuration.IDisplayType
-
Retrieves the display type name.
- getName() - Method in interface com.ibm.openpages.api.configuration.IFLSRule
-
Returns the name of FLSRule.
- getName() - Method in interface com.ibm.openpages.api.configuration.IProfile
-
Returns the profile system name.
- getName() - Method in interface com.ibm.openpages.api.configuration.IRLSRule
-
Returns the name of RLSRule.
- getName() - Method in interface com.ibm.openpages.api.metadata.IEnumValue
-
Returns the system name of the enum value.
- getName() - Method in interface com.ibm.openpages.api.metadata.IFieldDefinition
-
Returns the system name associated with the field definition.
- getName() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the system name of the type definition.
- getName() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the name of the process.
- getName() - Method in interface com.ibm.openpages.api.process.IProcessType
-
Returns the name of the process type.
- getName() - Method in interface com.ibm.openpages.api.resource.IField
-
Returns the system name for this field.
- getName() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the name of this resource.
- getName() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the name of this resource.
- getName() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
-
Returns the name for this application permission.
- getName() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns the name of this role template.
- getName() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns the security principal name.
- getName() - Method in class com.ibm.openpages.api.security.SecurityPrincipalInfo
-
Get Name
- getName() - Method in enum com.ibm.openpages.api.trigger.events.TriggerEventType
-
Returns the event name for the enum
- getObjectOrder() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
-
Retrieves this profile field's order number.
- getObjectPermissions() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Retrieves all object permissions for this role template.
- getObjectType() - Method in interface com.ibm.openpages.api.audit.IAssociationAuditLog
-
Returns the TypeDefinition of the object.
- getObjectType() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getObjectTypeIDs() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Get the facet value for object-types.
- getOldValue() - Method in interface com.ibm.openpages.api.audit.IFieldAuditLog
-
Returns the old value of the field.
- getOptions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
- getOrder() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the order integer of this questionnaire resource.
- getOriginalValueForField(String, IGRCObject) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Gets the original value of an IField object by using bundleFieldPath.
- getOutputMetaData() - Method in interface com.ibm.openpages.api.application.ICognosReportRowReader
-
Gets the metadata that describes the column values in the report output as provided by the
report output format.
- getPages() - Method in interface com.ibm.openpages.api.query.ITabularResultSet
-
Returns pages of rows.
- getPageSize() - Method in interface com.ibm.openpages.api.query.IQuery
-
Returns the page size.
- getParameter(String) - Method in interface com.ibm.openpages.api.application.IReportParameters
-
Gets the parameter information which has name,
data type, default values, and values.
- getParameters() - Method in interface com.ibm.openpages.api.configuration.IDisplayType
-
Retrieves the parameters for the display type.
- getParameters() - Method in exception com.ibm.openpages.api.OpenPagesException
-
- getParametersForReport(String) - Method in interface com.ibm.openpages.api.service.IApplicationService
-
Retrieve IReportParameters that contains all parameters a report expects
for inputs.
- getParameterValue(String) - Method in interface com.ibm.openpages.api.application.IReportParameters
-
Gets the value for a specified parameter.
- getParams() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The parameters of the warning message.
- getParent() - Method in interface com.ibm.openpages.api.metadata.IAssociationDefinition
-
Returns the "parent" type definition of this association.
- getParent() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
-
Returns the single parent Id for the parent object of this event.
- getParent() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
-
Returns the single parent Id for the parent object of this event.
- getParentAssociations() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns all parent associations for this type definition (i.e., all other type
definitions from which a direct navigation path to this type has been specified).
- getParentFolder() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the parent folder for this resource, if it exists; otherwise null.
- getParentFolderId() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the parent folder for this resource, if it exists; otherwise null.
- getParentGroups() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns this group membership to other groups.
- getParentId() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the Id of the parent resource for sub-sections and questions.
- getParentProcessId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the creator (user) of the process.
- getParentProcessId() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The parent process id of querying processes.
- getParents() - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
- getParents() - Method in class com.ibm.openpages.api.trigger.events.AssociateResourceEvent
-
Returns the list of Ids of the parent objects of this event.
- getParents() - Method in class com.ibm.openpages.api.trigger.events.DisassociateResourceEvent
-
Returns the list of Ids of the parent objects of this event.
- getPassword() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the password for authenticating into the SMTP server.
- getPassword() - Method in class com.ibm.openpages.api.security.UserInfo
-
Gets password.
- getPasswordCreationDate() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns creation date for user password.
- getPasswordExpiresInDays() - Method in class com.ibm.openpages.api.security.UserInfo
-
Gets password expires in days.
- getPath() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
-
Returns the path of this node.
- getPath() - Method in interface com.ibm.openpages.api.resource.IResource
-
Returns the full path of this resource.
- getPath() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the full path of this resource.
- getPercentComplete() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the completed percent of the process.
- getPermission() - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
-
Returns the Permissions(read, write, delete, associate, create) applied on IRLSRule.
- getPermissionIds() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns a list of Id for application permissions.
- getPermissions() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Retrieves all application-level permissions for this role template.
- getPermissions() - Method in interface com.ibm.openpages.api.security.ISecurityPrincipal
-
Returns an iterator on application permissions.
- getPermissionType() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns the object type definition that this permission grants access to.
- getPort() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the port number that identifies the SMTP server port.
- getPosition() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
-
Returns type of the trigger position.
- getPosition() - Method in enum com.ibm.openpages.api.trigger.TriggerPositionType
-
Returns the trigger position type as a String
- getPrecision() - Method in interface com.ibm.openpages.api.configuration.ICurrency
-
Returns the decimal precision for this currency.
- getPreferredProfile() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the preferred profile for the current user.
- getPreferredProfile(IUser) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the preferred profile for the specified user.
- getPrimaryParent() - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
Returns the primary parent GRCObject Id.
- getProcess(Id) - Method in interface com.ibm.openpages.api.service.IProcessService
-
Get the process information of a specific process.
- getProcessId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the id of the process.
- getProcessId() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the id of the process.
- getProcessId() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The process id to query.
- getProcessList(ProcessQueryOptions) - Method in interface com.ibm.openpages.api.service.IProcessService
-
Query a list of processes.
- getProcessLogId() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the id of the process log.
- getProcessLogs(Id, ProcessLogQueryOptions) - Method in interface com.ibm.openpages.api.service.IProcessService
-
Get process logs of a specific process.
- getProcessTypeId() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the process type id of the process.
- getProcessTypeId() - Method in interface com.ibm.openpages.api.process.IProcessType
-
Returns the id of the process type.
- getProcessTypes() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The process types of querying processes.
- getProcessTypes() - Method in interface com.ibm.openpages.api.service.IProcessService
-
Get process types.
- getProfile(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the profile associated with the specified profile name.
- getProfileFieldId() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
-
Returns the unique Profile Field Id for this Field Definition in the requested Profile.
- getProfileFields(String, String, String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns a list of profile field definitions for a specific view
in a profile.
- getProfiles() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the list of profiles available in the system.
- getProfiles(IUser) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns the list of profiles associated with the specified user.
- getProfileTypeDefinitionId() - Method in interface com.ibm.openpages.api.configuration.IProfileFieldDefinition
-
Returns the Profile Object Type Definition Id for the Type that this Field Definition belongs
to on the requested Type and Profile.
- getProperty(String) - Method in interface com.ibm.openpages.api.configuration.IConfigProperties
-
Retrieves configuration setting specified by propertyName.
- getProperty(String, String) - Method in interface com.ibm.openpages.api.configuration.IConfigProperties
-
Returns value of configuration setting.
- getProperty() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
The property of this resource item used to hold the information about
the additional fields values the UI will display which are: field-label,
display-type and the value of the field.
- getQueryOptions() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
-
Returns the query options for this event.
- getQuestionBy(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a question that has the specified id.
- getQuestionId() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getQuestionId() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getQuestionnaire(Id) - Method in interface com.ibm.openpages.api.service.IQuestionnaireService
-
Get a questionnaire object by Id for the the current period including all sections and questions
- getQuestionnaireAssessmentTypeName() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
- getQuestionnaireFactory() - Method in interface com.ibm.openpages.api.service.IQuestionnaireService
-
Returns the factory for creating in memory instances of objects.
- getQuestionnaireTemplateTypeName() - Method in class com.ibm.openpages.api.questionnaire.LaunchProgramOptions
-
- getQuestions() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a list of questions, sorted by the order configured on the child objects.
- getRangeEnd() - Method in class com.ibm.openpages.api.search.SearchOptions
-
Ending index of range to return in search results.
- getRangeStart() - Method in class com.ibm.openpages.api.search.SearchOptions
-
Starting index of range to return in search results.
- getRank() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
The order in the original search results as returned from the search
server.
- getRate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
-
Returns actual exchange rate calculated relative to a system wide base currency.
- getRationale() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the rationale of this questionnaire resource.
- getReadSelected() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
-
Returns the Boolean value if read-only is applied on field definition.
- getRecipients() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the recipients email addresses
- getReference() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the reference of this questionnaire resource.
- getRejection() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getRelativePath(String, List<ITypeDefinition>) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns relative path of the IResource provided full path and List of all
ITypeDefinitions.
- getRelativePath(String, ITypeDefinition) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns relative path of the IResource provided full path and
ITypedefinition.
- getRelativePath(String, String) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns relative path of the IResource provided full path, and root
folder path.
- getRelativePath(String, String, boolean) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Returns relative path of the IResource provided full path, and root
folder path.
- getReportID() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the report UUID of this questionnaire resource.
- getReportingPeriod() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
-
Returns the reporting period label.
- getReportingPeriod() - Method in interface com.ibm.openpages.api.query.IQuery
-
- getReportingPeriod() - Method in class com.ibm.openpages.api.resource.FolderFilter
-
Returns the reporting period label.
- getReportingPeriod() - Method in class com.ibm.openpages.api.resource.GRCObjectFilter
-
Returns the reporting period label.
- getReportingPeriod(String) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Returns a specific reporting period.
- getReportingPeriods() - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Retrieve Reporting Periods
- getRequires() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns the list of evidence types required by this question for the
question to be considered complete.
- getRequires() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
-
Returns the list of evidence types required by this answer for this
question to be considered complete.
- getRequires() - Method in interface com.ibm.openpages.api.resource.IEnumAnswer
-
Returns the list of evidence types required by this answer.
- getResource() - Method in class com.ibm.openpages.api.trigger.events.AbstractResourceEvent
-
Return the resource object that is the focus of the event.
- getResourceFactory() - Method in interface com.ibm.openpages.api.service.IResourceService
-
Returns the factory for creating in memory instances of objects.
- getResourceId() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
The Resource Permissions are describing the access to a particular
OpenPages resource.
- getResourceId() - Method in class com.ibm.openpages.api.trigger.events.DeleteResourceEvent
-
Returns the single Id for the resource being deleted for this event.
- getResourceIds() - Method in class com.ibm.openpages.api.trigger.events.DeleteResourceEvent
-
Returns list of resource Ids being deleted.
- getResourceLevel(ContentType, Resource) - Static method in class com.ibm.openpages.api.resource.util.ResourceUtil
-
Global Financial Services / Corporate / HR --> 3
Global Financial Services / Corporate --> 2
-> 0
Note: this seems like a hack to calculate the level based on the
path rather than doing a proper lookup.
- getResultList() - Method in interface com.ibm.openpages.api.search.ISearchResults
-
Gets the results that have been returned from search, processed for the
end-user's security access, for the current range.
- getResultRangeEnd() - Method in interface com.ibm.openpages.api.search.ISearchResults
-
Gets the ending index of the results this SearchResults represented.
- getResultRangeStart() - Method in interface com.ibm.openpages.api.search.ISearchResults
-
Gets the starting index of the results this SearchResults represented.
- getRetryTimes() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the retry times to send email.
- getRLSRules(ITypeDefinition) - Method in interface com.ibm.openpages.api.service.IConfigurationService
-
Return a Rule for a specific contentTypeID
- getRoleAssignment(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Returns the role assignment corresponding to the specified Id.
- getRoleAssignmentIds() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns a list of Id for role assignments.
- getRoleAssignments() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns an iterator over role assignments.
- getRoleAssignments() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns all role assignments for a user.
- getRoleAssignments() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Returns an iterator over all role assignments effective in the system.
- getRoleAssignments(ISecurityPrincipal, IRoleTemplate, IFolder) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Returns an iterator over all role assignments effective in the user or group
- getRoleTemplate() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the role template which permissions get assigned.
- getRoleTemplate(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves role template by Id.
- getRoleTemplate(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves role template by name.
- getRoleTemplateName() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the name of an assignment.
- getRoleTemplates() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns an iterator over all roles assigned with this group.
- getRoleTemplates() - Method in interface com.ibm.openpages.api.security.IUser
-
Returns all roles for a user.
- getRoleTemplates(boolean, boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves role templates based on the specified criteria.
- getRoleTemplateType() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the type of an assignment.
- getRootFolder() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns root folder associated to permission.
- getRootFolderId() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the unique identifier for this type root folder.
- getRootFolderId() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns Id of root folder associated to permission.
- getRootFolderPath() - Method in interface com.ibm.openpages.api.metadata.ITypeDefinition
-
Returns the root folder for instances of this type.
- getRuleAttributes() - Method in class com.ibm.openpages.api.trigger.AbstractEventHandler
-
Returns a Map containing rule attributes and their values.
- getRules() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
-
Returns the list of IRLSRule applied to a specific TypeDefinition.
- getScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns score of the question.
- getScore() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
-
- getScore() - Method in interface com.ibm.openpages.api.questionnaire.ISection
-
- getScore() - Method in interface com.ibm.openpages.api.resource.IEnumAnswer
-
Returns score of this enumerated answer.
- getScore() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
The score is a decimal value that is an indicator of how relevant the
result is to the search terms.
- getSdkArgs() - Method in class com.ibm.openpages.api.trigger.events.SearchEvent
-
Returns the raw arguments used to invoke the SDK search method in the OpenPages
platform for this event.
- getSearchId() - Method in class com.ibm.openpages.api.search.SearchOptions
-
Not used.
- getSectionBy(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a section or sub-section that has the specified id.
- getSections() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns a list of sections and sub-sections, sorted by the order configured on the child objects.
- getSecureType() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the security type of the SMTP server.
- getSecurityPrincipal() - Method in interface com.ibm.openpages.api.resource.IResourcePermission
-
The Resource Permission belong to a User or a Group.
- getSecurityPrincipal() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the user or group that is assigned the object permissions specified by the role template.
- getServer() - Static method in class com.ibm.openpages.api.application.EmailUtil
-
- getServiceFactory(Context) - Static method in class com.ibm.openpages.api.service.ServiceFactory
-
Instantiates a service factory based on the factory class name specified by the
com.ibm.openpages.sdk.service.factory key in the context.
- getServiceFactory(HttpServletRequest) - Static method in class com.ibm.openpages.api.service.ServiceFactory
-
Instantiates a service factory based on the http request.
- getSet() - Method in interface com.ibm.openpages.api.configuration.IRLSAccess
-
Returns the List(Permissions) for this field.
- getSimpleLogger(Class<?>) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns slf4j Logger instance.
- getSimpleLogger(String) - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns slf4j Logger instance.
- getSimpleLogger() - Method in interface com.ibm.openpages.api.logging.ILoggerFactory
-
Returns slf4j Logger instance.
- getSmtpServer() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the SMTP server host or IP address.
- getSourceResouceId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
Returns the source Id for the object to be copied in this event.
- getSqlQuery() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
-
Returns query syntax SQL query for this event as produced
by the user.
- getStartDate() - Method in class com.ibm.openpages.api.audit.AuditLogFilter
-
Gets the start date for logs retrieval.
- getStartDate() - Method in interface com.ibm.openpages.api.configuration.IExchangeRate
-
Returns the start date of the applicability period of an exchange rate.
- getStartIndex() - Method in class com.ibm.openpages.api.trigger.events.QueryEvent
-
Returns the starting row index for this event.
- getStartTime() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the start time of the process log.
- getStatus() - Method in interface com.ibm.openpages.api.audit.IAssociationAuditLog
-
Returns the status of the association.
- getStatus() - Method in interface com.ibm.openpages.api.process.IProcessInfo
-
Returns the status of the process.
- getStatus() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the status of the process log.
- getStatus() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns the status of the question
- getStatus() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
Returns the status of the questionnaire, which is determined by lifecycle.
- getStatusList() - Method in class com.ibm.openpages.api.process.ProcessQueryOptions
-
The process status of querying processes.
- getStatusMessage() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the message of the process log.
- getStatusTranslationParams() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the parameters of the message of the process log.
- getStatusTranslationStringId() - Method in interface com.ibm.openpages.api.process.IProcessLog
-
Returns the id of the message of the process log.
- getStringValue() - Method in class com.ibm.openpages.api.query.ParameterValue
-
Returns the value of this input parameter as a String
- getSubGroups() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns all groups that are members of a security group.
- getSubject() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the subject of the email
- getSubjectParams() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets parameters that will be formated into subject text
- getSubjectTextKey() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the key that is used to locate the application string for a subject
- getSubPermissions() - Method in interface com.ibm.openpages.api.security.IApplicationPermission
-
Gets the sub-permissions associated with this application permission.
- getSymbol() - Method in interface com.ibm.openpages.api.configuration.ICurrency
-
Returns the currency symbol as specified by ISO 4217.
- getTableColumns() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
- getTargetResourceId() - Method in class com.ibm.openpages.api.trigger.events.CopyResourceEvent
-
The target Id for the destination of where the source is to be copied to in this event.
- getTemplateId() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The Id of the Questionnaire Template object used by the Program.
- getText() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getText() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getTimeout() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the time out (in seconds) to send email.
- getTimestamp() - Method in interface com.ibm.openpages.api.questionnaire.IAttachment
-
- getTimestamp() - Method in interface com.ibm.openpages.api.questionnaire.IComment
-
- getTitle() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireBase
-
Returns the title of this questionnaire resource.
- getTopLevelGroups() - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves top level security groups from the OpenPages security model.
- getTotalAssessments() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The number of assessments associated to the program.
- getTotalAssets() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The number of assets associated to the Program.
- getTotalCount() - Method in interface com.ibm.openpages.api.questionnaire.ISection
-
- getTotalMatchingQuestions() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The number of matching questions between the program template and the copy from program template.
- getTransitionAttribute(IGRCObject, String) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getTransitionAttribute(IGRCObject, String, boolean) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getTransitionComment() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaire
-
- getTransitionFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getTransitionsAttributes() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleEventHandler
-
- getTriggerEventType() - Method in class com.ibm.openpages.api.trigger.events.AbstractEvent
-
Returns type of the trigger event.
- getType() - Method in interface com.ibm.openpages.api.resource.IAssociationNode
-
Returns the type of this node.
- getType() - Method in interface com.ibm.openpages.api.resource.IGRCObject
-
Returns the type definition for this object.
- getType() - Method in class com.ibm.openpages.api.search.DateFacetParam
-
Get the date facet type: Creation Date, Last Modified Date, Other Dates
- getType() - Method in class com.ibm.openpages.api.search.UserFacetParam
-
Get the user facet type: Created By, Last Modified By, and Name On Object
- getType(Id) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Returns a type definition by id.
- getType(String) - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Returns the type definition with the specified system name.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.configuration.IRLSTypeDefinitionRules
-
Returns the ITypeDefinition for RLS rules.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.metadata.IControllerFieldMap
-
Gets the TypeDefinition for this Controller field.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.search.ISearchResource
-
Returns the Object Type definition for this GRC Object.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IObjectPermission
-
Returns the type definition associated to this ObjectPermissions Role Template type.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IRoleAssignment
-
Returns the type definition of the scope for this assignment.
- getTypeDefinition() - Method in interface com.ibm.openpages.api.security.IRoleTemplate
-
Returns the type definition for this role template.
- getTypeFilters() - Method in class com.ibm.openpages.api.resource.AssociationFilter
-
Returns the list of type definition used for filtering.
- getTypeFilters() - Method in class com.ibm.openpages.api.resource.ContaineeFilter
-
Returns a unique list of type definition filters.
- getTypes() - Method in interface com.ibm.openpages.api.service.IMetaDataService
-
Gives access to a list of type definitions supported by the system.
- getUpdateAssigneeFieldName() - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule
-
- getUpdatedResource() - Method in class com.ibm.openpages.api.trigger.events.UpdateResourceEvent
-
If available, as in during a POST event, it returns the updated resource object that
resulted from this update event.
- getUpdateSelected() - Method in interface com.ibm.openpages.api.configuration.IFLSPropertyAccess
-
Returns the Boolean value if 'read-and-update' is applied on field definition.
- getUser() - Method in class com.ibm.openpages.api.search.UserFacetParam
-
Get the user facet data formated for Solr usage.
- getUser(Id) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves user by Id.
- getUser(String) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves user information by name.
- getUserIds() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns all user Ids directly associated with a security group.
- getUsername() - Method in class com.ibm.openpages.api.application.EmailOptions
-
Gets the user name for authenticating into the SMTP server.
- getUsers() - Method in class com.ibm.openpages.api.search.SearchFacetOptions
-
Get the facet value(s) for user(s).
- getUsers() - Method in interface com.ibm.openpages.api.security.IGroup
-
Returns all users of a security group.
- getUsers(boolean) - Method in interface com.ibm.openpages.api.service.ISecurityService
-
Retrieves users from the OpenPages security system.
- getValue() - Method in interface com.ibm.openpages.api.application.ICognosReportColumnValue
-
Gets the value of the column in the report row.
- getValue() - Method in interface com.ibm.openpages.api.application.IParameter
-
Gets the current value set for this parameter.
- getValue() - Method in interface com.ibm.openpages.api.configuration.IApplicationText
-
Returns the localized value of an application text
- getValue() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionOption
-
- getValue() - Method in interface com.ibm.openpages.api.resource.IBooleanField
-
Returns the field value as a boolean.
- getValue() - Method in interface com.ibm.openpages.api.resource.IDateField
-
Returns the field value as a date.
- getValue() - Method in interface com.ibm.openpages.api.resource.IFloatField
-
Returns the field value as a double if it exists.
- getValue() - Method in interface com.ibm.openpages.api.resource.IIdField
-
Returns the value as an Id.
- getValue() - Method in interface com.ibm.openpages.api.resource.IIntegerField
-
Returns the field value as an integer.
- getValue() - Method in interface com.ibm.openpages.api.resource.IReferenceField
-
Returns the field value as a reference Id.
- getValue() - Method in interface com.ibm.openpages.api.resource.IStringField
-
Returns the field value as a string.
- getVisibilityDependency() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns a question dependency object that represents visibility dependency.
- getWarningMessage() - Method in class com.ibm.openpages.api.questionnaire.ProgramValidationResult
-
The application string key of the warning message.
- getWeight() - Method in interface com.ibm.openpages.api.questionnaire.IQuestion
-
Returns weight of the question.
- getWeight() - Method in interface com.ibm.openpages.api.questionnaire.ISection
-
- GRCObjectFilter - Class in com.ibm.openpages.api.resource
-
Filtering class for GRCObject.
- GRCObjectFilter(IReportingPeriod) - Constructor for class com.ibm.openpages.api.resource.GRCObjectFilter
-
Constructor- Creates the GRCObjectFilter with the reporting period.
- GRCTriggerEventFactory - Class in com.ibm.openpages.api.trigger.events
-
Utility class which creates instances of Events based on the
TriggerEventType, Position and other method/operation specific parameters.
- GRCTriggerException - Class in com.ibm.openpages.api.trigger
-
Exception thrown for all GRC trigger related errors.
- GRCTriggerException(ErrorMessage, List<Object>, Throwable) - Constructor for class com.ibm.openpages.api.trigger.GRCTriggerException
-
Constructs a new GRCTriggerException with the specified error message,
list of parameters and cause of the exception.
- GROUP_SELECTOR - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes
-
Group Selector
- GroupInfo - Class in com.ibm.openpages.api.security
-
Class for the specification of a user group.
- GroupInfo(String) - Constructor for class com.ibm.openpages.api.security.GroupInfo
-
Constructor for group information.
- GroupInfo(String, Locale) - Constructor for class com.ibm.openpages.api.security.GroupInfo
-
Constructor for group information.
- GroupOptions - Class in com.ibm.openpages.api.security
-
Options for retrieving Group.
- GroupOptions() - Constructor for class com.ibm.openpages.api.security.GroupOptions
-
Default constructor.
- GroupOptions(boolean) - Constructor for class com.ibm.openpages.api.security.GroupOptions
-
Constructor with parameter