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

- Packages that use IFieldDefinition
  Package | Description
  --- | ---
  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.respview | Provides interfaces to work with the OpenPages responsive views.
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.

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

    Methods in com.ibm.openpages.api.audit that return types with arguments of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<IFieldDefinition>` | AuditLogFilter.`getFieldFilters()` Returns a unique list of field definition used as filters.

    Methods in com.ibm.openpages.api.audit with parameters of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuditLogFilter.`setFieldFilters(IFieldDefinition... fieldDefinitions)` Sets the list of field filters to include.

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

    Subinterfaces of IFieldDefinition in com.ibm.openpages.api.configuration
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IProfileFieldDefinition` Interface that gives access to profile field information used by an OpenPages system.

    Methods in com.ibm.openpages.api.configuration that return IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IFieldDefinition` | IFLSPropertyAccess.`getFieldDefinition()` Returns the Field Definition for IFLSRule.

    Methods in com.ibm.openpages.api.configuration with parameters of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `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` | IFLSPropertyAccess.`setFieldDefinition(IFieldDefinition fielddefinition)` Sets FieldDefinition for IFLSRule.

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

    Methods in com.ibm.openpages.api.metadata that return IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IFieldDefinition` | IControllerFieldMap.`getControllerField()` Gets the Field Definition for this Controller field.
    `IFieldDefinition` | ITypeDefinition.`getField(Id id)` Returns the field definition with the specified Id.
    `IFieldDefinition` | ITypeDefinition.`getField(java.lang.String systemName)` Returns the field definition with the specified system name.

    Methods in com.ibm.openpages.api.metadata that return types with arguments of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<IFieldDefinition>` | ITypeDefinition.`getFieldsDefinition()` Returns all field definitions part of this type definition.

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

    Methods in com.ibm.openpages.api.resource that return IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IFieldDefinition` | IField.`getFieldDefinition()` Returns the field definition.

    Methods in com.ibm.openpages.api.resource that return types with arguments of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<IFieldDefinition>` | GRCObjectFilter.`getFieldFilters()` Returns a unique list of field definition used as filters.
    `java.util.Set<IFieldDefinition>` | ContaineeFilter.`getFieldFilters()` Returns a unique list of field definition filters.

    Methods in com.ibm.openpages.api.resource with parameters of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | GRCObjectFilter.`setFieldFilters(IFieldDefinition... fieldDefinitions)` Sets the list field filters to include.
    `void` | ContaineeFilter.`setFieldFilters(IFieldDefinition... fieldDefinitions)` Sets one or more field definition filters.

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

    Methods in com.ibm.openpages.api.respview that return IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IFieldDefinition` | IRespViewRuleCondition.`getFieldDefinition()` Returns the field definition to evaluate when the type is field conditions `RespViewRuleConditionType.isFieldCondition()`
    `IFieldDefinition` | IRespViewField.`getFieldDefinition()` Returns the field definition of the responsive view field or null.
    `IFieldDefinition` | IRespViewField.`getSortField()` Returns the field definition that is used for sorting of relationship rows.

    Methods in com.ibm.openpages.api.respview with parameters of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `void` | IRespViewField.`setSortField(IFieldDefinition sortFields)` Sets the field definition that is used for sorting of relationship rows.

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

    Methods in com.ibm.openpages.api.service that return IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `IFieldDefinition` | IMetaDataService.`getField(Id id)` Returns a Field Definition by propertyid.
    `IFieldDefinition` | IMetaDataService.`getField(java.lang.String systemName)` Returns the field definition with the specified system name.

    Methods in com.ibm.openpages.api.service with parameters of type IFieldDefinition
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | IApplicationService.`invokeReportFragment(Id id, IFieldDefinition field)` Invoke report fragment on a given object and return the report fragment as a String

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.