Class CodegenGenericDataRelationshipType

    • Method Detail

      • relatedModelName

        public final String relatedModelName()

        The name of the related model in the data relationship.

        Returns:
        The name of the related model in the data relationship.
      • hasRelatedModelFields

        public final boolean hasRelatedModelFields()
        For responses, this returns true if the service returned a value for the RelatedModelFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • relatedModelFields

        public final List<String> relatedModelFields()

        The related model fields in the data relationship.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRelatedModelFields() method.

        Returns:
        The related model fields in the data relationship.
      • canUnlinkAssociatedModel

        public final Boolean canUnlinkAssociatedModel()

        Specifies whether the relationship can unlink the associated model.

        Returns:
        Specifies whether the relationship can unlink the associated model.
      • relatedJoinFieldName

        public final String relatedJoinFieldName()

        The name of the related join field in the data relationship.

        Returns:
        The name of the related join field in the data relationship.
      • relatedJoinTableName

        public final String relatedJoinTableName()

        The name of the related join table in the data relationship.

        Returns:
        The name of the related join table in the data relationship.
      • belongsToFieldOnRelatedModel

        public final String belongsToFieldOnRelatedModel()

        The value of the belongsTo field on the related data model.

        Returns:
        The value of the belongsTo field on the related data model.
      • hasAssociatedFields

        public final boolean hasAssociatedFields()
        For responses, this returns true if the service returned a value for the AssociatedFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • associatedFields

        public final List<String> associatedFields()

        The associated fields of the data relationship.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedFields() method.

        Returns:
        The associated fields of the data relationship.
      • isHasManyIndex

        public final Boolean isHasManyIndex()

        Specifies whether the @index directive is supported for a hasMany data relationship.

        Returns:
        Specifies whether the @index directive is supported for a hasMany data relationship.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)