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

C

canChangePassword() - Method in interface com.ibm.openpages.api.security.IUser

Verifies if password can be changed.

canCreate(ITypeDefinition, Id, Id) - Method in interface com.ibm.openpages.api.service.IResourceService

Checks if the current user has the permissions to create a GRC Object.

canCreateObjectsForTypes(Id, List<Id>) - Method in interface com.ibm.openpages.api.service.IResourceService

Considers Folder based security, Role based security and Rule based security globally to check for a list of potential object types which ones the user may have access to create.

canCreateObjectsForTypes(List<Id>, Id) - Method in interface com.ibm.openpages.api.service.IResourceService

Considers Folder based security, Role based security and Rule based security to check for a list of potential object types which ones the current user may have access to create for a specific intended parent GRC Object.

canRead() - Method in interface com.ibm.openpages.api.resource.IField

For this field instance, evaluates any Field Level Security Rules that apply to the current user's Context and returns true if the user has permission to read the field value.

canWrite() - Method in interface com.ibm.openpages.api.resource.IField

For this field instance, evaluates any Field Level Security Rules that apply to the current user's Context and returns true if the user has permission to write to the field value during an update.

changePassword(String) - Method in interface com.ibm.openpages.api.security.IUser

Changes the user password to the one specified as an argument.

Check - Class in com.ibm.openpages.api

Utility methods for common argument validations

CHECK_ALL - Static variable in class com.ibm.openpages.api.trigger.oob.DetectPropertyChangeTrigger

Deprecated.

CHECK_ANY - Static variable in class com.ibm.openpages.api.trigger.oob.DetectPropertyChangeTrigger

Deprecated.

checkArgument(boolean, Object) - Static method in class com.ibm.openpages.api.Check

Ensures the truth of an expression involving one or more parameters to the calling method.

checkContentsForRange(Iterable<Integer>, Integer, Integer, Object) - Static method in class com.ibm.openpages.api.Check

Ensures that an Iterable object passed as a parameter to the calling method is not null and does not contain values that are out of range.

checkContentsNotNull(T, Object) - Static method in class com.ibm.openpages.api.Check

Ensures that an Iterable object passed as a parameter to the calling method is not null and contains no null elements.

checkForRange(Integer, Integer, Integer, Object) - Static method in class com.ibm.openpages.api.Check

Ensures that a value passed as a parameter to the calling method is in range; otherwise, throws OpenPagesException.

checkNotEmpty(Collection<?>, Object) - Static method in class com.ibm.openpages.api.Check

Ensure that an Collection object passed as a parameter to the calling method is not empty.

checkNotNull(T, Object) - Static method in class com.ibm.openpages.api.Check

Ensures that an object reference passed as a parameter to the calling method is not null, throwing a OpenPagesException if it is.

checkNotNull(T) - Static method in class com.ibm.openpages.api.Check

Ensures that an object reference passed as a parameter to the calling method is not null, throwing a OpenPagesException if it is.

checkObjectType(IGRCObject) - Method in class com.ibm.openpages.api.trigger.oob.lifecycle.DefaultLifecycleRule

clear() - Method in class com.ibm.openpages.api.Context

Removes all of the mappings from this context.

clearControllers() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionDependency

Clears all the controllers from the dependency.

clearEnumAnswers() - Method in interface com.ibm.openpages.api.resource.IEnumAnswersField

Removes all the enum answer entries.

close() - Method in interface com.ibm.openpages.api.IDisposable

Closes a resource safely.

CognosOutputFormat - Enum in com.ibm.openpages.api.application

Defines the supported output formats when invoking Cognos reports from the OpenPages Risk API.

COLUMNS_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes

com.ibm.openpages.api - package com.ibm.openpages.api

OpenPages GRC Risk API

com.ibm.openpages.api.application - package com.ibm.openpages.api.application

Provides OpenPages application specific functions

com.ibm.openpages.api.audit - package com.ibm.openpages.api.audit

Provides interfaces to work with the OpenPages audit trail.

com.ibm.openpages.api.configuration - package com.ibm.openpages.api.configuration

Provides interfaces to work with the OpenPages system configuration.

com.ibm.openpages.api.logging - package com.ibm.openpages.api.logging

Provides an interface for the OpenPages logging system.

com.ibm.openpages.api.metadata - package com.ibm.openpages.api.metadata

This package and its components provides access to OpenPages metadata.

com.ibm.openpages.api.process - package com.ibm.openpages.api.process

This package and its components provides access to long running process objects.

com.ibm.openpages.api.query - package com.ibm.openpages.api.query

OpenPages Query Service API

com.ibm.openpages.api.questionnaire - package com.ibm.openpages.api.questionnaire

This package and its components provides access to questionnaire objects.

com.ibm.openpages.api.resource - package com.ibm.openpages.api.resource

Provides interfaces to work with the OpenPages content data: folders, GRC objects and document attachments.

com.ibm.openpages.api.resource.util - package com.ibm.openpages.api.resource.util

Utilities for working with resources.

com.ibm.openpages.api.search - package com.ibm.openpages.api.search

Provides interfaces to work with the OpenPages Global Search, allowing for cross-object search against all data configured by administrators to be indexed for search.

com.ibm.openpages.api.security - package com.ibm.openpages.api.security

Provides interfaces to work with the OpenPages security data: users, groups, and role-based security.

com.ibm.openpages.api.service - package com.ibm.openpages.api.service

Provides the main interfaces to work with the API services.

com.ibm.openpages.api.trigger - package com.ibm.openpages.api.trigger

The GRC Trigger framework for extending OpenPages with custom business rules.

com.ibm.openpages.api.trigger.events - package com.ibm.openpages.api.trigger.events

All types of events supported by the GRC Trigger framework.

com.ibm.openpages.api.trigger.ext - package com.ibm.openpages.api.trigger.ext

Provides default implementations of trigger rules and event handlers.

com.ibm.openpages.api.trigger.oob - package com.ibm.openpages.api.trigger.oob

'Out of the box' implementations of common Rules and Event Handlers.

com.ibm.openpages.api.trigger.oob.lifecycle - package com.ibm.openpages.api.trigger.oob.lifecycle

Implementations of the default Rules and Event Handlers for Lifecycle triggers.

COMMENT - Static variable in interface com.ibm.openpages.api.resource.IEnumAnswer

Required evidence type for comment

CommentType - Enum in com.ibm.openpages.api.questionnaire

Enum for various IComment comment types supported by the API.

connect(EmailOptions) - Static method in class com.ibm.openpages.api.application.EmailUtil

ContaineeFilter - Class in com.ibm.openpages.api.resource

Filtering class for Folder containees.

ContaineeFilter() - Constructor for class com.ibm.openpages.api.resource.ContaineeFilter

Constructor- Creates the ContaineeFilter with default setting to include both FOLDER and GRCOBJECT.

ContentTypeMatchRule - Class in com.ibm.openpages.api.trigger.oob

This GRC trigger rule checks if the object type of the operating object matches the specific value.

ContentTypeMatchRule() - Constructor for class com.ibm.openpages.api.trigger.oob.ContentTypeMatchRule

Context - Class in com.ibm.openpages.api

Application context used to encapsulate system data to allow it to be shared with other parts of the application.

Context() - Constructor for class com.ibm.openpages.api.Context

Class constructor.

CopyConflictBehavior - Enum in com.ibm.openpages.api.application

Specifies the desired behavior when a GRCObject with the same name already exists in the target location of a copy.

CopyObjectOptions - Class in com.ibm.openpages.api.application

Allows you to configure options in IApplicationService.copyToParent(com.ibm.openpages.api.metadata.Id, List, CopyObjectOptions) operations.

CopyObjectOptions() - Constructor for class com.ibm.openpages.api.application.CopyObjectOptions

Creates the CopyObjectOptions with default settings: includeChildren = true
- The children types are not explicitly defined and all primary children are copied.
- If conflicts exist, it will use Copy Of prefix behavior to rename the copies.

CopyResourceEvent - Class in com.ibm.openpages.api.trigger.events

Represents the event type to copy resource objects.

CopyResourceEvent(TriggerPositionType, Context) - Constructor for class com.ibm.openpages.api.trigger.events.CopyResourceEvent

CopyResourceEvent(Id, Id, TriggerPositionType, Context) - Constructor for class com.ibm.openpages.api.trigger.events.CopyResourceEvent

CopyResourceEvent(Id, Id, String, TriggerPositionType, Context) - Constructor for class com.ibm.openpages.api.trigger.events.CopyResourceEvent

copyToParent(Id, List<Id>, CopyObjectOptions) - Method in interface com.ibm.openpages.api.service.IApplicationService

Copies one or more GRCObjects to a parent GRCObject based on the CopyObjectOptions and returns the copies made for each of the childrenToCopy that are specified.

createApplicationService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IApplicationService and creates an instance if it isn't already instantiated.

createAttachment(Id, Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates an attachment object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestionnaire by IQuestionnaire.addAttachment(IAttachment).

createAuditService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

createAutoNamedGRCObject(ITypeDefinition) - Method in interface com.ibm.openpages.api.resource.IResourceFactory

Creates an automatically named instance of the IGRCObject interface to be persisted in the system.

createComment(Id, String, boolean) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Deprecated.

This method is deprecated as of release 7.3.0.1, use method IQuestionnaireFactory.createComment(Id, String, CommentType) instead.

createComment(Id, String, boolean, boolean) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Deprecated.

This method is deprecated as of release 7.3.0.1, use method IQuestionnaireFactory.createComment(Id, String, CommentType) instead.

createComment(Id, String, CommentType) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a comment object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestionnaire by IQuestionnaire.addComment(IComment) .

createConfigurationService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IConfigurationService and creates an instance if it isn't already instantiated.

createDocument(String, ITypeDefinition, IFileTypeDefinition) - Method in interface com.ibm.openpages.api.resource.IResourceFactory

Creates a new instance of the IDocument interface to be persisted in the system.

createEvent(TriggerEventType, IResource, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, resource, position and context.

createEvent(TriggerEventType, Id, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, Resource Id, position and context.

createEvent(TriggerEventType, List<Id>, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, Resource Ids, position and context.

createEvent(TriggerEventType, List<Id>, Id, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, Resource Ids, position and context.

createEvent(TriggerEventType, Id, Id, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, Resource Ids, position and context.

createEvent(TriggerEventType, Id, Id, String, CopyOptions, TriggerPositionType, Context, Object) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, Resource Ids, destination name, position and context.

createEvent(TriggerEventType, String, int, QueryOptions, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, query string, query options, position and context.

createEvent(TriggerEventType, TriggerPositionType, Context, Object[]) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, position and context.

createEvent(TriggerEventType, IResource, IResource, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, resource(s), position and context.

createEvent(TriggerEventType, Id, List<Id>, TriggerPositionType, Context) - Method in class com.ibm.openpages.api.trigger.events.GRCTriggerEventFactory

Creates a new event for the event type, resource(s), position and context.

createExchangeRate(IConfigurationService, String, double, Date) - Method in interface com.ibm.openpages.api.configuration.IConfigurationFactory

Creates an instance of IExchangeRate.

createExchangeRate(IConfigurationService, ISOCurrencyCode, double, Date) - Method in interface com.ibm.openpages.api.configuration.IConfigurationFactory

Creates an instance of IExchangeRate.

createExchangeRate(ICurrency, double, Date) - Method in interface com.ibm.openpages.api.configuration.IConfigurationFactory

Creates an instance of IExchangeRate.

createFolder(String, IFolder) - Method in interface com.ibm.openpages.api.resource.IResourceFactory

Creates a new instance of the IFolder interface to be persisted in the system.

createGRCObject(String, ITypeDefinition) - Method in interface com.ibm.openpages.api.resource.IResourceFactory

Creates a new instance of the IGRCObject interface to be persisted in the system.

createGroup(GroupInfo) - Method in interface com.ibm.openpages.api.service.ISecurityService

Creates new security group based on provided group specification.

createGroup(GroupInfo, IGroup) - Method in interface com.ibm.openpages.api.service.ISecurityService

Creates new security group based on provided group specification and parent group.

createMetaDataService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IMetaDataService and creates an instance if it isn't already instantiated.

createProcessService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IProcessService and creates an instance if it isn't already instantiated.

createQueryService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IQueryService and creates an instance if it isn't already instantiated.

createQuestion(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a question object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestionnaire by IQuestionnaire.addQuestion(IQuestion).

createQuestionDependency() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a question dependency object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestion by IQuestion.setVisibilityDependency(IQuestionDependency) .

createQuestionnaireService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IQuestionnaireService and creates an instance if it isn't already instantiated.

createQuestionOption(String, int, String, Integer, List<String>) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a question option object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestion by IQuestion.setOptions(List) .

createQuestionTableColumn(String) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a question table column object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestion by IQuestion.setTableColumns(List) .

CreateResourceEvent - Class in com.ibm.openpages.api.trigger.events

Represents the event type for creating a resource object.

CreateResourceEvent(TriggerPositionType, Context) - Constructor for class com.ibm.openpages.api.trigger.events.CreateResourceEvent

Default constructor.

CreateResourceEvent(IResource, TriggerPositionType, Context) - Constructor for class com.ibm.openpages.api.trigger.events.CreateResourceEvent

Constructor with the resource to be created.

createResourceService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of IResourceService and creates an instance if it isn't already instantiated.

createSearchService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of ISearchService and creates an instance if it isn't already instantiated.

createSection() - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a section object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestionnaire by IQuestionnaire.addSection(ISection).

createSecurityService() - Method in interface com.ibm.openpages.api.service.IServiceFactory

Returns an instance of ISecurityService and creates an instance if it isn't already instantiated.

createSubSection(Id) - Method in interface com.ibm.openpages.api.questionnaire.IQuestionnaireFactory

Creates a subsection object in memory, which is persisted via IQuestionnaireService.saveQuestionnaire(IQuestionnaire) after being added to IQuestionnaire by IQuestionnaire.addSection(ISection).

createUser(UserInfo, List<IGroup>) - Method in interface com.ibm.openpages.api.service.ISecurityService

Creates user based on provided specification and a list of groups for membership assignment.

CURRENCY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes

Currency

CURRENCY_EXCHANGERATE_READONLY_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes

CURRENCY_SHOW_CONVERSION_KEY - Static variable in interface com.ibm.openpages.api.configuration.DisplayTypes

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