worldia / textmaster-api

Simple PHP client for the Textmaster API
1 stars 5 forks source link

Mutable properties #5

Closed cdaguerre closed 8 years ago

cdaguerre commented 8 years ago

@aponsin Alexandre. Could you please help us out on which properties are mutable and which are not, ie. Which properties may be changed after a project was created. We need to understand which setters make sense in our model objects on update:

Project
Property Mutable Comment
id no
name no
ctype no
status yes will change with the workflow progress of the project
languageFrom no
languageTo no
category no
briefing no can be change after project launch upon request, but by the TM team only
options no can be change after project launch upon request, but by the TM team only
Document
Property Mutable Comment
id no
title no
status yes will change with the workflow progress of the document
originalContent no
translatedContent yes will get updated once the author submits its work
projectId no
aponsin commented 8 years ago

Most properties can change as long as a project is no launched. However most of them will become immutable once the project has been launched. I will update the table with that consideration.

cdaguerre commented 8 years ago

@aponsin Just to make sure we're perfectly clear:

aponsin commented 8 years ago
cdaguerre commented 8 years ago

How do you launch a document? When does it move from in_creation to waiting_assignment? Does it depend on the project's status?

aponsin commented 8 years ago

You don't launch a document. You launch a project that contains many documents. All the documents will be considered launched when the project is launched.

cdaguerre commented 8 years ago

Ok, this raises another question: can you add new documents to a launched project? To a paused project?

Envoyé de mon iPhone

Le 12 avr. 2016 à 20:36, Alexandre Ponsin notifications@github.com a écrit :

You don't launch a document. You launch a project that contains many documents. All the documents will be considered launched when the project is launched.

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub

aponsin commented 8 years ago

No, you cannot. Once a project has been launched, you cannot add any document to it.

Pitoune commented 8 years ago

Partially answered by commit 505fb3f83e041cfc6ac9fa0763f015085fe9e449 Missing immutable protection on Model\Document