Package adalid.core.interfaces

Interface Property

    • Method Detail

      • getPropertyAtRoot

        Property getPropertyAtRoot()
        Returns:
        the corresponding property at the declaring entity's root instance

      • isBaseField

        boolean isBaseField()
        Returns:
        the base field indicator

      • isKeyField

        boolean isKeyField()
        Returns:
        the key field indicator

      • getPropertyAccess

        PropertyAccess getPropertyAccess()
        Returns:
        the property access

      • isAuditable

        boolean isAuditable()
        Returns:
        the auditable indicator

      • isPassword

        boolean isPassword()
        Returns:
        the password indicator

      • isReadOnly

        boolean isReadOnly()
        Returns:
        the required indicator

      • isRequiredProperty

        boolean isRequiredProperty()
        Returns:
        the required indicator

      • isHiddenField

        boolean isHiddenField()
        Returns:
        the hidden field indicator

      • isHiddenEntityReferenceField

        boolean isHiddenEntityReferenceField()
        Returns:
        the hidden entity reference field indicator

      • isCreateField

        boolean isCreateField()
        Returns:
        the create field indicator

      • isUpdateField

        boolean isUpdateField()
        Returns:
        the update field indicator

      • isSearchField

        boolean isSearchField()
        Returns:
        the search field indicator

      • isFilterField

        boolean isFilterField()
        Returns:
        the filter field indicator

      • isSortField

        boolean isSortField()
        Returns:
        the sort field indicator

      • isTableField

        boolean isTableField()
        Returns:
        the table field indicator

      • isDetailField

        boolean isDetailField()
        Returns:
        the detail field indicator

      • isColumnField

        boolean isColumnField()
        Returns:
        the column field indicator

      • isReportField

        boolean isReportField()
        Returns:
        the report field indicator

      • isExportField

        boolean isExportField()
        Returns:
        the export field indicator

      • isHeadertextlessField

        boolean isHeadertextlessField()
        Returns:
        the headertextless field indicator

      • isHeadingField

        boolean isHeadingField()
        Returns:
        the heading field indicator

      • isOverlayField

        boolean isOverlayField()
        Returns:
        the overlay field indicator

      • isImmutableField

        boolean isImmutableField()
        Returns:
        the immutable field indicator

      • isSerializableField

        boolean isSerializableField()
        Returns:
        the serializable field indicator

      • isTransientField

        boolean isTransientField()
        Returns:
        the transient field indicator

      • isSerializableIUID

        boolean isSerializableIUID()
        Returns:
        the serialize IUID indicator

      • isSequencePropertyDataGenDisabled

        boolean isSequencePropertyDataGenDisabled()
        Returns:
        the sequence data generation disabled indicator

      • getDefaultCondition

        DefaultCondition getDefaultCondition()
        Returns:
        the default condition

      • getDefaultCheckpoint

        Checkpoint getDefaultCheckpoint()
        Returns:
        the default checkpoint

      • getDefaultFunction

        java.lang.String getDefaultFunction()
        Returns:
        the default function

      • getAnchorFieldName

        java.lang.String getAnchorFieldName()
        Returns:
        the anchor field name

      • getAnchorField

        java.lang.reflect.Field getAnchorField()
        Returns:
        the anchor field

      • getAnchorProperty

        Property getAnchorProperty()
        Returns:
        the anchor property

      • getAnchorType

        AnchorType getAnchorType()
        Returns:
        the anchor type

      • isAnchoringLinkedDetailFields

        boolean isAnchoringLinkedDetailFields()
        Returns:
        the anchoring linked detail fields indicator

      • setAnchoringLinkedDetailFields

        void setAnchoringLinkedDetailFields​(boolean b)
        Sets the anchoring linked detail fields indicator
        Parameters:
        b - the anchoring detail fields indicator to set

      • getDefaultAnchorLabel

        java.lang.String getDefaultAnchorLabel()
        Returns:
        the default anchor label

      • setDefaultAnchorLabel

        void setDefaultAnchorLabel​(java.lang.String defaultAnchorLabel)
        El método setDefaultAnchorLabel se utiliza para establecer la etiqueta del grupo de propiedades ancladas a la propiedad que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultAnchorLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del grupo de propiedades ancladas

      • getLocalizedAnchorLabel

        java.lang.String getLocalizedAnchorLabel​(java.util.Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized anchor label

      • setLocalizedAnchorLabel

        void setLocalizedAnchorLabel​(java.util.Locale locale,
                             java.lang.String localizedAnchorLabel)
        El método setLocalizedAnchorLabel se utiliza para establecer la etiqueta del grupo de propiedades ancladas a la propiedad que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedAnchorLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta del grupo de propiedades ancladas

      • getDefaultAnchoredLabel

        java.lang.String getDefaultAnchoredLabel()
        Returns:
        the default anchoring label

      • setDefaultAnchoredLabel

        void setDefaultAnchoredLabel​(java.lang.String defaultAnchoredLabel)
        El método setDefaultAnchoredLabel se utiliza para establecer la etiqueta de la propiedad dentro del grupo de propiedades ancladas que se almacena en el archivo de recursos por defecto. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        defaultAnchoredLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta dentro del grupo de propiedades ancladas

      • getLocalizedAnchoredLabel

        java.lang.String getLocalizedAnchoredLabel​(java.util.Locale locale)
        Parameters:
        locale - locale
        Returns:
        the localized anchoring label

      • setLocalizedAnchoredLabel

        void setLocalizedAnchoredLabel​(java.util.Locale locale,
                               java.lang.String localizedAnchoredLabel)
        El método setLocalizedAnchoredLabel se utiliza para establecer la etiqueta de la propiedad dentro del grupo de propiedades ancladas que se almacena en el archivo de recursos de configuración regional. En caso de que el archivo de recursos para el idioma seleccionado por el usuario no esté disponible, la interfaz de la aplicación utiliza el archivo de recursos por defecto para obtener el valor de la etiqueta.
        Parameters:
        locale - configuración regional
        localizedAnchoredLabel - sustantivo singular, preferiblemente sin complementos, que se usa como etiqueta dentro del grupo de propiedades ancladas

      • getSequenceNumber

        int getSequenceNumber()
        Returns:
        the sequence number

      • getDisplaySortKey

        java.lang.String getDisplaySortKey()
        Returns:
        the display sort key

      • setDisplaySortKey

        void setDisplaySortKey​(java.lang.String key)
        Sets the display sort key
        Parameters:
        key - the display sort key to set

      • getAggregateFunction

        AggregateFunction getAggregateFunction()
        Returns:
        the aggregate function

      • getAggregateTitle

        java.lang.String getAggregateTitle()
        Returns:
        the aggregate title

      • isCalculable

        boolean isCalculable()
        Returns:
        the calculable indicator

      • isCalculatedProperty

        boolean isCalculatedProperty()
        Returns:
        true if it is a calculated artifact; otherwise false

      • isNullable

        boolean isNullable()
        Returns:
        the nullable indicator

      • isInsertable

        boolean isInsertable()
        Returns:
        the insertable indicator

      • isUpdateable

        boolean isUpdateable()
        Returns:
        the updateable indicator

      • isMandatoryForInsert

        boolean isMandatoryForInsert()
        Returns:
        the mandatory-for-insert indicator

      • isOptionalForInsert

        boolean isOptionalForInsert()
        Returns:
        the optional-for-insert indicator

      • isUnique

        boolean isUnique()
        Returns:
        the unique indicator

      • isIndexed

        boolean isIndexed()
        Returns:
        the indexed indicator

      • isRenderingFilterReadOnly

        boolean isRenderingFilterReadOnly()
        Returns:
        the rendering filter's read-only indicator

      • getRenderingFilter

        BooleanExpression getRenderingFilter()
        Returns:
        the rendering filter

      • setRenderingFilter

        void setRenderingFilter​(BooleanExpression renderingFilter)
        El método setRenderingFilter se utiliza para establecer el filtro de presentación de propiedades en vistas (páginas) de consulta y/o registro. Solo si se cumplen los criterios del filtro, el valor de la propiedad o el parámetro será visible en las vistas (páginas) de registro o ejecución de operaciones de negocio.
        Parameters:
        renderingFilter - expresión booleana que se utiliza como filtro

      • setRenderingFilter

        void setRenderingFilter​(BooleanExpression renderingFilter,
                        boolean readOnly)
        El método setRenderingFilter se utiliza para establecer el filtro de presentación de propiedades en vistas (páginas) de consulta y/o registro. Solo si se cumplen los criterios del filtro, el valor de la propiedad o el parámetro será visible en las vistas (páginas) de registro o ejecución de operaciones de negocio.
        Parameters:
        renderingFilter - expresión booleana que se utiliza como filtro
        readOnly - true, si el filtro solo aplica para la lectura; de lo contrario false.

      • getRequiringFilter

        BooleanExpression getRequiringFilter()
        Returns:
        the requiring filter

      • setRequiringFilter

        void setRequiringFilter​(BooleanExpression requiringFilter)
        El método setRequiringFilter se utiliza para establecer el filtro de obligatoriedad de propiedades en vistas (páginas) de registro. Solo si se cumplen los criterios del filtro, el valor de la propiedad o el parámetro será obligatoriamente requerido en las vistas (páginas) de registro o ejecución de operaciones de negocio.
        Parameters:
        requiringFilter - expresión booleana que se utiliza como filtro

      • getModifyingFilter

        BooleanExpression getModifyingFilter()
        Returns:
        the modifying filter

      • setModifyingFilter

        void setModifyingFilter​(BooleanExpression modifyingFilter)
        El método setModifyingFilter se utiliza para establecer el filtro de modificación de propiedades en vistas (páginas) de registro. Solo si se cumplen los criterios del filtro, el valor de la propiedad o el parámetro podrá ser modificado en las vistas (páginas) de registro o ejecución de operaciones de negocio.
        Parameters:
        modifyingFilter - expresión booleana que se utiliza como filtro

      • getNullifyingFilter

        BooleanExpression getNullifyingFilter()
        Returns:
        the nullifying filter

      • setNullifyingFilter

        void setNullifyingFilter​(BooleanExpression nullifyingFilter)
        El método setNullifyingFilter se utiliza para establecer el filtro de anulación de propiedades en vistas (páginas) de registro. Solo si se cumplen los criterios del filtro, el valor de la propiedad o el parámetro será anulado en las vistas (páginas) de registro o ejecución de operaciones de negocio.
        Parameters:
        nullifyingFilter - expresión booleana que se utiliza como filtro

      • setNullValueGraphicImageExpression

        void setNullValueGraphicImageExpression()
        El método setNullValueGraphicImageExpression se utiliza para establecer la expresión que determina el nombre de la imagen de valores nulos asociada a la propiedad. El nombre de la imagen debe ser establecido previamente mediante el método setNullValueGraphicImageName. La imagen de la propiedad se utiliza para resaltar sua valores nulos en las vistas (páginas) de consulta y/o registro.

      • getEnclosingSteps

        java.util.List<Step> getEnclosingSteps()
        Returns:
        the enclosing steps list

      • getEnclosingTabs

        java.util.List<Tab> getEnclosingTabs()
        Returns:
        the enclosing tabs list

      • isEmbeddedDocumentField

        boolean isEmbeddedDocumentField()
        Returns:
        the embedded document indicator

      • isFileReferenceField

        boolean isFileReferenceField()
        Returns:
        the file reference indicator

      • isGraphicImageField

        boolean isGraphicImageField()
        Returns:
        the graphic image indicator

      • isMasterSequenceField

        boolean isMasterSequenceField()
        Returns:
        the master sequence indicator

      • isUniformResourceLocatorField

        boolean isUniformResourceLocatorField()
        Returns:
        the URL indicator

      • isVariantStringField

        boolean isVariantStringField()
        Returns:
        the variant string indicator

      • isPrimaryKeyProperty

        boolean isPrimaryKeyProperty()
        Returns:
        true if it is the Primary Key property; otherwise false

      • isSequenceProperty

        boolean isSequenceProperty()
        Returns:
        true if it is the Sequence property; otherwise false

      • isVersionProperty

        boolean isVersionProperty()
        Returns:
        true if it is the Version property; otherwise false

      • isNumericKeyProperty

        boolean isNumericKeyProperty()
        Returns:
        true if it is the Numeric Key property; otherwise false

      • isCharacterKeyProperty

        boolean isCharacterKeyProperty()
        Returns:
        true if it is the Character Key property; otherwise false

      • isNameProperty

        boolean isNameProperty()
        Returns:
        true if it is the Name property; otherwise false

      • isDescriptionProperty

        boolean isDescriptionProperty()
        Returns:
        true if it is the Description property; otherwise false

      • isImageProperty

        boolean isImageProperty()
        Returns:
        true if it is the Image property; otherwise false

      • isInactiveIndicatorProperty

        boolean isInactiveIndicatorProperty()
        Returns:
        true if it is the Inactive Indicator property; otherwise false

      • isUrlProperty

        boolean isUrlProperty()
        Returns:
        true if it is the URL property; otherwise false

      • isParentProperty

        boolean isParentProperty()
        Returns:
        true if it is the Parent property; otherwise false

      • isOwnerProperty

        boolean isOwnerProperty()
        Returns:
        true if it is the Owner property; otherwise false

      • isUserProperty

        boolean isUserProperty()
        Returns:
        true if it is the User property; otherwise false

      • isSegmentProperty

        boolean isSegmentProperty()
        Returns:
        true if it is the segment property; otherwise false

      • isUniqueKeyProperty

        boolean isUniqueKeyProperty()
        Returns:
        true if it is a Unique Key property; otherwise false

      • isBusinessKeyProperty

        boolean isBusinessKeyProperty()
        Returns:
        true if it is the Business Key property; otherwise false

      • isDiscriminatorProperty

        boolean isDiscriminatorProperty()
        Returns:
        true if it is the Discriminator property; otherwise false

      • isStateProperty

        boolean isStateProperty()
        Returns:
        true if it is the State property; otherwise false

      • isPrimitive

        boolean isPrimitive()
        Returns:
        true if it is a Primitive; otherwise false

      • isBinaryPrimitive

        boolean isBinaryPrimitive()
        Returns:
        true if it is a BinaryPrimitive; otherwise false

      • isBooleanPrimitive

        boolean isBooleanPrimitive()
        Returns:
        true if it is a BooleanPrimitive; otherwise false

      • isCharacterPrimitive

        boolean isCharacterPrimitive()
        Returns:
        true if it is a CharacterPrimitive; otherwise false

      • isNumericPrimitive

        boolean isNumericPrimitive()
        Returns:
        true if it is a NumericPrimitive; otherwise false

      • isTemporalPrimitive

        boolean isTemporalPrimitive()
        Returns:
        true if it is a TemporalPrimitive; otherwise false

      • isBigDecimalData

        boolean isBigDecimalData()
        Returns:
        true if it is a BigDecimalData; otherwise false

      • isBigIntegerData

        boolean isBigIntegerData()
        Returns:
        true if it is a BigIntegerData; otherwise false

      • isBinaryData

        boolean isBinaryData()
        Returns:
        true if it is a BinaryData; otherwise false

      • isBooleanData

        boolean isBooleanData()
        Returns:
        true if it is a BooleanData; otherwise false

      • isByteData

        boolean isByteData()
        Returns:
        true if it is a ByteData; otherwise false

      • isCharacterData

        boolean isCharacterData()
        Returns:
        true if it is a CharacterData; otherwise false

      • isDateData

        boolean isDateData()
        Returns:
        true if it is a DateData; otherwise false

      • isDoubleData

        boolean isDoubleData()
        Returns:
        true if it is a DoubleData; otherwise false

      • isFloatData

        boolean isFloatData()
        Returns:
        true if it is a FloatData; otherwise false

      • isIntegerData

        boolean isIntegerData()
        Returns:
        true if it is a IntegerData; otherwise false

      • isLongData

        boolean isLongData()
        Returns:
        true if it is a LongData; otherwise false

      • isShortData

        boolean isShortData()
        Returns:
        true if it is a ShortData; otherwise false

      • isStringData

        boolean isStringData()
        Returns:
        true if it is a StringData; otherwise false

      • isTimeData

        boolean isTimeData()
        Returns:
        true if it is a TimeData; otherwise false

      • isTimestampData

        boolean isTimestampData()
        Returns:
        true if it is a TimestampData; otherwise false

      • isEntity

        boolean isEntity()
        Returns:
        true if it is an entity; otherwise false

      • isContextualEntity

        boolean isContextualEntity()
        Returns:
        true if it is a contextual entity; otherwise false

      • isEnumerationEntity

        boolean isEnumerationEntity()
        Returns:
        true if it is a enumeration entity; otherwise false

      • isNonEnumerationEntity

        boolean isNonEnumerationEntity()
        Returns:
        true if it is a non-enumeration entity; otherwise false

      • isDatabaseEntity

        boolean isDatabaseEntity()
        Returns:
        true if it is a database entity; otherwise false

      • isPersistentEntity

        boolean isPersistentEntity()
        Returns:
        true if it is a persistent entity; otherwise false

      • isPersistentEnumerationEntity

        boolean isPersistentEnumerationEntity()
        Returns:
        true if it is a persistent enumeration entity; otherwise false

      • isPersistentNonEnumerationEntity

        boolean isPersistentNonEnumerationEntity()
        Returns:
        true if it is a persistent non-enumeration entity; otherwise false

      • isOverlayableEntityReference

        boolean isOverlayableEntityReference()
        Returns:
        true if is a overlayable entity reference; otherwise false

      • getGraphicImageNameExpression

        CharacterExpression getGraphicImageNameExpression()
        Returns:
        the graphic image name expression of a property

      • getPropertyPathList

        java.util.List<Artifact> getPropertyPathList()
        Returns:
        the property path list

      • getInitialValueReferencingPropertiesList

        java.util.List<Property> getInitialValueReferencingPropertiesList()
        Returns:
        the initial value referencing properties list

      • getPropertyParameterPathList

        java.util.List<Artifact> getPropertyParameterPathList()
        Returns:
        the property-parameter path list

      • getInitialValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getInitialValueReferencingProperties()
        Returns:
        the list of properties referencing this property in their initial value

      • getInitialValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getInitialValueReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their initial value

      • getMaxValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getMaxValueReferencingProperties()
        Returns:
        the list of properties referencing this property in their max value

      • getMaxValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getMaxValueReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their max value

      • getMinValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getMinValueReferencingProperties()
        Returns:
        the list of properties referencing this property in their min value

      • getMinValueReferencingProperties

        java.util.Map<java.lang.String,​Property> getMinValueReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their min value

      • getModifyingFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getModifyingFilterReferencingProperties()
        Returns:
        the list of properties referencing this property in their modifying filter

      • getModifyingFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getModifyingFilterReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their modifying filter

      • getRenderingFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getRenderingFilterReferencingProperties()
        Returns:
        the list of properties referencing this property in their rendering filter

      • getRenderingFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getRenderingFilterReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their rendering filter

      • getRenderingFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getRenderingFilterReferencingProperties​(boolean recursively,
                                                                                       java.lang.Boolean readOnly)
        Parameters:
        recursively - recursively
        readOnly - true, to process read-only filters; false, to process read-write filters; null, to process all filters
        Returns:
        the list of properties referencing this property in their rendering filter

      • getRequiringFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getRequiringFilterReferencingProperties()
        Returns:
        the list of properties referencing this property in their requiring filter

      • getRequiringFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getRequiringFilterReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their requiring filter

      • getSearchQueryFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getSearchQueryFilterReferencingProperties()
        Returns:
        the list of properties referencing this property in their search query filter

      • getSearchQueryFilterReferencingProperties

        java.util.Map<java.lang.String,​Property> getSearchQueryFilterReferencingProperties​(boolean recursively)
        Parameters:
        recursively - recursively
        Returns:
        the list of properties referencing this property in their search query filter

      • getTableColumnEntityName

        java.lang.String getTableColumnEntityName()
        Returns:
        the table column's entity name

      • getPixels

        int getPixels()
        Returns:
        the property size in pixels

      • getColumnPixels

        int getColumnPixels()
        Returns:
        the column size in pixels