Task #4264
Story #3755: Structural changes to D1 APIs for 2.0 release
Add hide() and display() to CN and MN APIs
0%
Description
The functionality of hide() is the same as archive() but with a better nomenclature considering DataONE is an archive and we essentially archive all content as our core mission.
We also need to reverse the hide() operation which could be named display().
These two terms are not set. Other combinations should be used such as
conceal() and expose()
or
veil() and unveil()
or some other permutation that makes sense: hide & expose/conceal & unveil, etc.
The main issue is coming up with good terms that helps clarify the intent of making an item not discoverable by search but still listable, resolvable, navigable and retrievable.
Related issues
History
#1 Updated by Ben Leinfelder over 10 years ago
When was this decided?
Hiding and showing should probably be accomplished through access control updates. No one can read it? Hidden!
Archive is an "almost delete" action, least that's how it has been in v1.
#2 Updated by Chris Jones over 10 years ago
I don't recall a decision to add hide() and display() API methods. I think this needs review.
#3 Updated by Matthew Jones over 10 years ago
I don't think this was decided -- it was just a proposal. In general, I'm not supportive of renaming methods -- it causes dissonance for people who have already implemented, and extra work. And these names are not necessarily any clearer than the original names for the methods. I don't see this change as being beneficial on net.
#4 Updated by Robert Waltz over 10 years ago
All of the tasks in Story #3755: Structural changes to D1 APIs for 2.0 release were proposals.
We are deciding their fate now.
There has been much disagreement in this group about what archive means, what it does, and if it is necessary. We have had numerous discussions (and IMO much time wasted) about 'archive'. This task is a result of one of the most recent discussions on the topic.
This proposal was added in order to clarify what 'archive' really does. This task is not a proposal to decrement or change the behavior of archive, although it allows us in the future to redefine 'archive' or remove the method, if desired. This task is a proposal to add clarification to a procedure to better reveal its intention. This task also proposes that we add a mechanism to reverse setting archive to true.
I trust that others (more than those who have commented on this as of now) will be able comment before a decision is arrived at.
#5 Updated by Robert Waltz about 10 years ago
- Target version set to CCI-2.0.0
#6 Updated by Robert Waltz almost 10 years ago
- Status changed from New to Rejected
- translation missing: en.field_remaining_hours set to 0.0
