Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove entityName, entityDisplayName #837

Closed
foundrytom opened this issue Mar 17, 2023 · 0 comments · Fixed by #868
Closed

Remove entityName, entityDisplayName #837

foundrytom opened this issue Mar 17, 2023 · 0 comments · Fixed by #868
Assignees
Labels

Comments

@foundrytom
Copy link
Collaborator

foundrytom commented Mar 17, 2023

What

Remove ManagerInterface.entityDisplayName, and replace with a DisplayName trait in MediaCreation.

Why

Now we have a composable traits system, that allows a host to express the entity data they need, in a concise (and reflectable form, via managementPolicy), making the entity name a first-class concept has several flaws:

  • It requires an additional API call to service, which can add non-trivial work.
  • In many situations where it would be called, a resolve call would also be made to provide other information.
  • It prohibits the addition of additional fields, eg, providing a shot name and a long name (maybe for UI + tooltip).
  • Fewer API methods to maintain.

By making it a trait, we can hopefully reduce the total number of API calls, and add more flexibility as to how this may need to evolve over time (It's also one less method to maintain).

Potential downsides:

  • Another trait to consider in resolve adds to implementation complexity.
  • Less discoverable.
  • The implementation of entityDisplayName could be individually optimized.
@foundrytom foundrytom changed the title Remove entityDisplayName Remove entityName, entityDisplayName Mar 23, 2023
@foundrytom foundrytom self-assigned this Mar 29, 2023
@foundrytom foundrytom added this to the Core stable milestone Mar 29, 2023
foundrytom added a commit to foundrytom/OpenAssetIO that referenced this issue Mar 31, 2023
This is better served by a resolvable trait to reduce API calls and
allow industry specific flexiblity.

Closes OpenAssetIO#837

Signed-off-by: Tom Cowland <tom@foundry.com>
foundrytom added a commit to foundrytom/OpenAssetIO that referenced this issue Apr 4, 2023
This is better served by a resolvable trait to reduce API calls and
allow industry specific flexiblity.

Closes OpenAssetIO#837

Signed-off-by: Tom Cowland <tom@foundry.com>
foundrytom added a commit to foundrytom/OpenAssetIO that referenced this issue Apr 4, 2023
This is better served by a resolvable trait to reduce API calls and
allow industry specific flexiblity.

Closes OpenAssetIO#837

Signed-off-by: Tom Cowland <tom@foundry.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant