Description Miles Parker 2012-09-13 13:32:55 EDT

The Mylyn approach to managing task (Review) state change is significantly different from the way that R4E manages such changes. Briefly, Mylyn changes are course-grained (Task Level) and essentially optimistic, while R4E model changes are fine-grained (to attribute level) and support pessimistic locking/check-out.
Definitions:

TaskRespository: R4E ReviewGroup
TaskRepositoryURL: Represents the location of a unique ReviewGroup. In the initial case, an EMF URI shared file system location.
Task: R4E Review
TaskID: A unique identifier for a Review within a specific ReviewGroup/Repository. This could be a UUID, user assigned or other appropriate value, but ideally it would be a simple human readable sequential ID.

For example:

TaskRepositoryURL: file:/Z:/R4EReviews//some_reviews.xrer
TaskRepositoryID: 123

On the Mylyn side, these are combined to form a unique task URL, e.g.: file:/Z:/R4EReviews//some_reviews.xrer/123, but we could use a different separator if desired. This would of course be different from the actual R4EReview EObject URI.

In order to support Mylyn Tasks, we need R4E API that accomplishes something like the following. Some of this API may already be in place in which case we just need to identify the appropriate calls. Ideally we'd access all of these calls from a single class API, e.g. R4EModelManager or whatever.. This is the basic functionality we need:

1. Pull/Update: Return an EObject for a given review based on a supplied TaskRepositoryURL and TaskID.
2. Push (New): Accept a complete new Review EObject, with a supplied TaskRepositoryURL and add it to the appropriate ReviewGroup. This method then must return or provide a new unique Task ID.
3. Submit/Update: Accepts a complete Review EObject, with a supplied TaskRepositoryURL and TaskID and merges it into the existing review group. The method returns an updated EObject and Status for result:
	If object could be merged, returns Status OK new (merged) object from shared store.
	If object could not be merged returns Status ERROR and (non-merged) object from shared store. 
	[optional] If object partially merged, returns Status WARNING and (partially-merged) object from shared store, perhaps with a multi-status indicating references/attributes that could not be merged.