Skip to content

[BUG] - isComponent description is not very clear #718

Open
@rhiaro

Description

@rhiaro

Summary of the bug or issue

The description of isComponent is hard to follow, and I think it still contains some text/concepts from earlier version of BODS.

Whether this entity is a component in an indirect relationship. Where isComponent is 'true': (1) the recordId of this entity MUST be an element in the componentRecords array of that primary Relationship Statement, (2) this Entity Statement MUST come before that primary Relationship Statement in a BODS package or stream, (3) the replacement of this Entity Statement SHOULD be considered when replacing the primary Relationship Statement. The primary Relationship statement MUST have a isComponent value of 'false'.

In (1) the componentRecords property is on the Relationship Record object, so referring to "Relationship Statement" here threw me off.

(3) makes more sense with replacesStatement, which has been deprecated. I think it should be removed, or replaced with clearer non-normative guidance about updating records / making new statements, because "be considered" is a vague normative requirement in any case.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions