## Uses of Interface
com.ibm.openpages.api.metadata.ITypeDefinition

- Packages that use ITypeDefinition
  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.

- - ### Uses of ITypeDefinition in com.ibm.openpages.api.application

    Methods in com.ibm.openpages.api.application that return types with arguments of type ITypeDefinition
    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()`

    Methods in com.ibm.openpages.api.application with parameters of type ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | MoveObjectOptions.`addChildrenType(ITypeDefinition objectType)` Adds a single Object Type to the explicit list of Object Types to include in the moveGRCObject operation.
    `void` | CopyObjectOptions.`addChildrenType(ITypeDefinition objectType)` Adds a single Object Type to the explicit list of Object Types to include in the copyToParent operation.

    Method parameters in com.ibm.openpages.api.application with type arguments of type ITypeDefinition
    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.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.audit

    Methods in com.ibm.openpages.api.audit that return ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITypeDefinition` | IAssociationAuditLog.`getObjectType()` Returns the TypeDefinition of the object.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.configuration

    Methods in com.ibm.openpages.api.configuration that return ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITypeDefinition` | IRLSTypeDefinitionRules.`getTypeDefinition()` Returns the ITypeDefinition for RLS rules.

    Methods in com.ibm.openpages.api.configuration with parameters of type ITypeDefinition
    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.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.metadata

    Methods in com.ibm.openpages.api.metadata that return ITypeDefinition
    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.

    Methods in com.ibm.openpages.api.metadata that return types with arguments of type ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<ITypeDefinition>` | IPath.`iterator()` Returns iterator for type definition in the navigation path.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.resource

    Methods in com.ibm.openpages.api.resource that return ITypeDefinition
    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.

    Methods in com.ibm.openpages.api.resource that return types with arguments of type ITypeDefinition
    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.

    Methods in com.ibm.openpages.api.resource with parameters of type ITypeDefinition
    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.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.resource.util

    Methods in com.ibm.openpages.api.resource.util with parameters of type ITypeDefinition
    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.

    Method parameters in com.ibm.openpages.api.resource.util with type arguments of type 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.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.respview

    Methods in com.ibm.openpages.api.respview that return ITypeDefinition
    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.

    Methods in com.ibm.openpages.api.respview with parameters of type ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | IRespViewField.`setParentRelationTypeDefinition(ITypeDefinition parentRelationTypeDefinition)` Sets the parentRelationTypeDefinition used in sibling relationship type.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.search

    Methods in com.ibm.openpages.api.search that return ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `ITypeDefinition` | ISearchResource.`getTypeDefinition()` Returns the Object Type definition for this GRC Object.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.security

    Methods in com.ibm.openpages.api.security that return ITypeDefinition
    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` | IRoleAssignment.`getTypeDefinition()` Returns the type definition of the scope for this assignment.
    `ITypeDefinition` | IObjectPermission.`getTypeDefinition()` Returns the type definition associated to this ObjectPermissions Role Template type.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.service

    Methods in com.ibm.openpages.api.service that return ITypeDefinition
    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.

    Methods in com.ibm.openpages.api.service that return types with arguments of type ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ITypeDefinition>` | IMetaDataService.`getTypes()` Gives access to a list of type definitions supported by the system.

    Methods in com.ibm.openpages.api.service with parameters of type ITypeDefinition
    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.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.trigger.events

    Methods in com.ibm.openpages.api.trigger.events that return types with arguments of type ITypeDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<ITypeDefinition>` | CopyResourceEvent.`getChildrenTypesToCopy()` Gets the children Object Types to be copied.

  - ### Uses of ITypeDefinition in com.ibm.openpages.api.workflow

    Methods in com.ibm.openpages.api.workflow that return ITypeDefinition
    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, 2021. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.