| Package | Description |
|---|---|
| com.ibm.openpages.api.application |
Provides OpenPages application specific functions
|
| com.ibm.openpages.api.audit |
Provides interfaces to work with the OpenPages audit trail.
|
| com.ibm.openpages.api.configuration |
Provides interfaces to work with the OpenPages system configuration.
|
| com.ibm.openpages.api.metadata |
This package and its components provides access to OpenPages metadata.
|
| 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 |
Utilities for working with resources.
|
| com.ibm.openpages.api.respview |
Provides interfaces to work with the OpenPages responsive views.
|
| 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 |
Provides interfaces to work with the OpenPages security data: users,
groups, and role-based security.
|
| com.ibm.openpages.api.service |
Provides the main interfaces to work with the API services.
|
| com.ibm.openpages.api.trigger.events |
All types of events supported by the GRC Trigger framework.
|
| com.ibm.openpages.api.workflow |
Provides interfaces to work with native workflow system.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<ITypeDefinition> |
CopyObjectOptions.getChildrenTypesToCopy()
Gets the children Object Types to be copied.
|
java.util.List<ITypeDefinition> |
MoveObjectOptions.getChildrenTypesToMove() |
| Modifier and Type | Method and Description |
|---|---|
void |
CopyObjectOptions.addChildrenType(ITypeDefinition objectType)
Adds a single Object Type to the explicit list of Object Types to include in the copyToParent
operation.
|
void |
MoveObjectOptions.addChildrenType(ITypeDefinition objectType)
Adds a single Object Type to the explicit list of Object Types to include in the moveGRCObject
operation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CopyObjectOptions.setChildrenTypesToCopy(java.util.List<ITypeDefinition> childrenTypesToCopy)
Explicit list of Object Types to include in the copyToParent
operation, if isIncludeChildren is true.
|
void |
MoveObjectOptions.setChildrenTypesToMove(java.util.List<ITypeDefinition> childrenTypesToMove)
Explicit list of Object Types to include in the moveGRCObject
operation.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IAssociationAuditLog.getObjectType()
Returns the TypeDefinition of the object.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IRLSTypeDefinitionRules.getTypeDefinition()
Returns the ITypeDefinition for RLS rules.
|
| Modifier and Type | Method and Description |
|---|---|
IRespView |
IConfigurationFactory.createRespView(ITypeDefinition typeDefinition,
RespViewType viewType,
java.lang.String viewName)
Creates an on-memory instance of responsive view
|
IRespViewField |
IConfigurationFactory.createRespViewField(RespViewFieldType type,
IFieldDefinition objectFieldDef,
ITypeDefinition relationObjectDef,
java.lang.String fieldName)
Creates an on-memory instance of responsive view field
|
IRespViewRuleCondition |
IConfigurationFactory.createRespViewRuleCondition(RespViewRuleConditionType type,
ITypeDefinition typeDefinition,
IFieldDefinition fieldDefinition)
Creates an on-memory instance of view identification rule condition
|
void |
IRLSTypeDefinitionRules.setTypeDefinitionId(ITypeDefinition itypedefinition)
Sets the ITypeDefinition on which the RLS rule is applied.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IAssociationDefinition.getChild()
Returns the "child" type definition of this association.
|
ITypeDefinition |
IAssociationDefinition.getParent()
Returns the "parent" type definition of this association.
|
ITypeDefinition |
IControllerFieldMap.getTypeDefinition()
Gets the TypeDefinition for this Controller field.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Iterator<ITypeDefinition> |
IPath.iterator()
Returns iterator for type definition in the navigation path.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IGRCObject.getType()
Returns the type definition for this object.
|
ITypeDefinition |
IAssociationNode.getType()
Returns the type of this node.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Set<ITypeDefinition> |
ContaineeFilter.getTypeFilters()
Returns a unique list of type definition filters.
|
java.util.Set<ITypeDefinition> |
AssociationFilter.getTypeFilters()
Returns the list of type definition used for filtering.
|
| Modifier and Type | Method and Description |
|---|---|
IGRCObject |
IResourceFactory.createAutoNamedGRCObject(ITypeDefinition typeDefinition)
Creates an automatically named instance of the IGRCObject interface to be persisted in the system.
|
IDocument |
IResourceFactory.createDocument(java.lang.String name,
ITypeDefinition typeDefinition,
IFileTypeDefinition fileTypeDefinition)
Creates a new instance of the IDocument interface to be persisted in the system.
|
IGRCObject |
IResourceFactory.createGRCObject(java.lang.String name,
ITypeDefinition typeDefinition)
Creates a new instance of the IGRCObject interface to be persisted in the system.
|
void |
ContaineeFilter.setTypeFilters(ITypeDefinition... types)
Adds a one or more type filters.
|
void |
AssociationFilter.setTypeFilters(ITypeDefinition... types)
Sets zero or more type definition to use as filters.
|
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
ResourceUtil.getFullPath(java.lang.String relativePath,
boolean isFolder,
ITypeDefinition typeDefinition)
Returns full resource path provided relative path, boolean isFolder and
the ITypeDefinition for the GRCObject.
|
static java.lang.String |
ResourceUtil.getRelativePath(java.lang.String fullPath,
ITypeDefinition typeDefinition)
Returns relative path of the IResource provided full path and
ITypedefinition.
|
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
ResourceUtil.getFullPath(java.lang.String path,
boolean isFolder,
java.util.List<ITypeDefinition> typeDefinitions)
Returns full resource path provided relative path, boolean isFolder, and
list of all ITypeDefinitions.
|
static java.lang.String |
ResourceUtil.getRelativePath(java.lang.String fullPath,
java.util.List<ITypeDefinition> typeDefinitions)
Returns relative path of the IResource provided full path and List of all
ITypeDefinitions.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IRespViewField.getParentRelationTypeDefinition()
Returns the parent type definition of the responsive view field or null.
|
ITypeDefinition |
IRespViewField.getRelationTypeDefinition()
Returns the type definition of the responsive view field or null.
|
ITypeDefinition |
IRespView.getTypeDefinition()
Returns the type definition that the responsive view belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IRespViewField.setParentRelationTypeDefinition(ITypeDefinition parentRelationTypeDefinition)
Sets the parentRelationTypeDefinition used in sibling relationship type.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
ISearchResource.getTypeDefinition()
Returns the Object Type definition for this GRC Object.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IObjectPermission.getPermissionType()
Returns the object type definition that this permission grants access to.
|
ITypeDefinition |
IRoleTemplate.getTypeDefinition()
Returns the type definition for this role template.
|
ITypeDefinition |
IObjectPermission.getTypeDefinition()
Returns the type definition associated to this ObjectPermissions Role Template type.
|
ITypeDefinition |
IRoleAssignment.getTypeDefinition()
Returns the type definition of the scope for this assignment.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IMetaDataService.getType(Id id)
Returns a type definition by id.
|
ITypeDefinition |
IMetaDataService.getType(java.lang.String systemName)
Returns the type definition with the specified system name.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<ITypeDefinition> |
IMetaDataService.getTypes()
Gives access to a list of type definitions supported by the system.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IResourceService.canCreate(ITypeDefinition intendedTypeToCreate,
Id intendedFolder,
Id intendedParent)
Checks if the current user has the permissions to create a GRC Object.
|
java.lang.String |
IResourceService.determineDefaultFolder(ITypeDefinition typeToCreate,
IGRCObject intendedParent,
boolean createFolders)
Determines the correct default folder for a new GRC Object to be created
as a child of an intended parent GRC Object.
|
Id |
IConfigurationService.getApplicableCreationView(ITypeDefinition typeDefinition,
ITypeDefinition parentTypeDefinition)
Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
|
Id |
IConfigurationService.getApplicableGridView(ITypeDefinition typeDefinition)
Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
|
IRespView |
IConfigurationService.getRespView(ITypeDefinition typeDefinition,
RespViewType viewType,
java.lang.String viewName,
RespViewState viewState)
Returns a responsive view
|
IRLSTypeDefinitionRules |
IConfigurationService.getRLSRules(ITypeDefinition ITypeDefinition)
Return a Rule for a specific contentTypeID
|
void |
IConfigurationService.reorderRespViewRules(ITypeDefinition typeDefinition,
RespViewType viewType,
java.util.Map<Id,java.lang.Integer> orders)
Reorder identification rules for responsive views.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<ITypeDefinition> |
CopyResourceEvent.getChildrenTypesToCopy()
Gets the children Object Types to be copied.
|
| Modifier and Type | Method and Description |
|---|---|
ITypeDefinition |
IEvaluationContext.getObjectType()
Returns the object type of the GRCObject in the context.
|
Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2020. All Rights Reserved.
US Government Users Restricted Rights -
Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.