Model Module is responsible for handling of CRUD operations of documents in the backend.

In addition, it handles the operations associated with documents such as tagging documents & assign users to documents.

Things to know

.getDoc() ☆

To get a single document using its type and name (identifier).

Input

Output

RequestResponse<T>

Example

RequestResponse<Item> response = await getFrappeModelController()
  .getDoc(RenovationReview,"RE-00002");
​
  if (response.isSuccess) {
    // If the document was successfully retrieved
    print(response.data);
  } else {
    // If the document was not retrieved
    print(response.error);
  }

Possible Errors

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

Wrong input

HTTP code: 412

type: DataFormatError

cause: The input arguments are in the wrong type/format

suggestion: Use the correct parameters types/formats referencing the functions signature

.getList() ☆

To get a list of documents using the doctype, and other optional filters.

Input

Output

RequestResponse<List<T>>

Example

RequestResponse<List<Item>> response = await getFrappeModelController()
  .getList(User(),{
    fields: ["*"]
  });
  if (response.isSuccess) {
    // If the document was successfully retrieved
    print(response.data);
  } else {
    // If the document was not retrieved
    print(response.error);
  }

.getValue()

To get a single value from DB.

Input

Output

RequestResponse<Map<String,dynamic>>

Example

RequestResponse<Map<String,dynamic>> response = await getFrappeModelController().getValue(
  "User",// doctype
  "[email protected]",// docname
  "email"//docfield
);
if (response.isSuccess) {
    // Item Name: {"item_name":"Item A"}
    print(response.data);
  } else {
    // If the document was not retrieved
    print(response.error);
  }

Possible Errors

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

Wrong input

HTTP code: 412

type: DataFormatError

cause: The input arguments are in the wrong type/format

suggestion: Use the correct parameters types/formats referencing the functions signature

.setValue()

To set a single value from DB.

Input

Output

RequestResponse<T>

Example

RequestResponse<RenovationReview> response =
      await getFrappeModelController().setValue(
          RenovationReview(), // doctype
          "RenovationReview A", // docname
          "reviewed_by", // docfield,
          "[email protected]" // docValue
          );
if (response.isSuccess) {
    // RenovationReview Name: [email protected]
    print("RenovationReview Name: ${response.data}");
} else {
    print(response.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Docname Does Not Exist

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.newDoc()

To create a new document with default added properties. Also saves the created document in the local cache.

 Default fields:
 docstatus: 0 // means draft
 __islocal: 1
 __unsaved: 1

Input

Output*

T

Example

User user = getFrappeModelController().newDoc(
    User()
  );// no need to await
​
// true
print(user.unsaved);

.saveDoc() ☆

To save the document in the backend.

Input

Output

T

Example

RequestResponse<RenovationReview> savedDoc = 
    await getFrappeModelController().saveDoc(
      getFrappeModelController().newDoc(RenovationReview())
    );
​
if (savedDoc.isSuccess) {
  // Renovation Review Name: Renovation Review
  print(savedDoc.data.name);
} else {
  print(savedDoc.error);
}

Possible Errors

Duplicate document found

HTTP code: 409

type: DuplicateEntryError

cause: Duplicate doc found while saving

suggestion: Change the 'name' field or delete the existing document

.submitDoc()

To submit the document in the backend.

Input

Output

RequestResponse<T>

Example

RequestResponse<RenovationReview> submitedDoc = 
    await getFrappeModelController().submitDoc(
      getFrappeModelController().newDoc(RenovationReview())
    );
​
if (submitedDoc.isSuccess) {
  // RenovationReview Name: RenovationReview
  print(submitedDoc.data.name);
} else {
  print(submitedDoc.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.saveSubmitDoc() ★

To save the document first, then submit, in a single db transaction.

Input

Output

RequestResponse<T>

Example

RequestResponse<RenovationReview> savedSubmittedDoc = await getFrappeModelController().saveSubmitDoc(
    getFrappeModelController().newDoc(RenovationReview())
  );
​
if (savedSubmittedDoc.isSuccess) {
  // Item Name: Test Item
  print(savedSubmittedDoc.data.name);
} else {
  print(savedSubmittedDoc.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.copyDoc()

To create a cloned document, with a new local name.

Input

Output

T

Example

User clonedDoc = getFrappeModelController().copyDoc(
    getFrappeModelController().newDoc(RenovationReview())
  );
​
if (clonedDoc.isSuccess) {
  print(clonedDoc.data.name);
} else {
  print(clonedDoc.error);
}

.amendDoc()

To clone a document then set amended_from property to the original doc.

Input

Output

T

Example

RenovationReview amendedDoc = getFrappeModelController().amendDoc(
    getFrappeModelController().newDoc(RenovationReview())
  );
​
if (amendedDoc.isSuccess) {
  print(amendedDoc.data.amendedFrom);
} else {
  print(amendedDoc.error);
}

.deleteDoc()

To delete a document from the backend.

Input

Output

RequestResponse<String>

Example

RequestResponse<String> deletedDoc = await getFrappeModelController().deleteDoc("Renovation Review","RE-00001");
​
if (deletedDoc.isSuccess) {
  print(deletedDoc.data);
} else {
  print(deletedDoc.error);
}

Possible Errors

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.cancelDoc()

To cancel a submitted document in the backend.

Input

Output

RequestResponse<T>

Example

RequestResponse<String> deletedDoc = await getFrappeModelController()
      .deleteDoc("Renovation Review", "RE-00001");
​
if (cancelledDoc.success) {
  print(cancelledDoc.data.name);
} else {
  print(cancelledDoc.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.assignDoc()

To assign a document to a user.

Input

Output

Requestresponse<bool>

Example

RequestResponse<bool> assignResponse = await getFrappeModelController().assignDoc(
    assignTo: "[email protected]",
    doctype: "Renovation Review"
  );
​
if (assignResponse.isSuccess) {
  // true
  print(assignResponse.data);
} else {
  print(assignResponse.error);
}

.completeDocAssignment()

To set the assignment as completed.

Input

Output

RequestResponse<bool>

Example

RequestResponse<bool> completedAssignment = await getFrappeModelController().completeDocAssignment(
    assignTo: "[email protected]",
    doctype: "Renovation Review",
    docname: "RE-00001"
  );
​
if (completedAssignment.isSuccess) {
  // true
  print(completedAssignment.data);
} else {
  print(completedAssignment.error);
}

.unAssignDoc()

To unassign a user from an assignment.

Input

Output

RequestResponse<bool>

Example

RequestResponse<bool> unassigned = await getFrappeModelController().unAssignDoc(
  unAssignFrom: "[email protected]",
  doctype: "Renovation Review",
  docname: "RE-00001"
});
​
if (unassigned.isSuccess) {
  // true
  print(unassigned.data);
} else {
  print(unassigned.error);
}

.getDocsAssignedToUser() ★

To get the documents that are assigned to a user.

Input

Output

RequestResponse<List<GetDocsAssignedToUserResponse>>

Example

RequestResponse<List<GetDocsAssignedToUserResponse>> docsAssigned =
      await getFrappeModelController()
          .getDocsAssignedToUser(assignedTo: "[email protected]");
​
if (docsAssigned.isSuccess) {
  // Number of docs: 3
  print(docsAssigned.data.length);
  // Doctype: Renovation Review
  print(docsAssigned.data[0].doctype);
} else {
  print(docsAssigned.error);
}

.getUsersAssignedToDoc()

To get the users assigned to a document.

Input

Output

RequestResponse<List<ToDo>>

Example

RequestResponse<List<ToDo>> usersAssigned = await getFrappeModelController()
        .getUsersAssignedToDoc(
          doctype: "Renovation Review",
          docname: "RE-00001"
        );
​
if (usersAssigned.isSuccess) {
  // Number of users: 2
  print("Number of users: ${usersAssigned.data.length}");
} else {
  print(usersAssigned.error);
}

.addTag()

To add a tag to a document.

Input

Output

RequestResponse<String>

Example

RequestResponse<String> addedTag = await getFrappeModelController().addTag( 
  doctype: "Renovation Review",
  docname: "RE-00001",
  tag: "test-tag"
);
​
if (addedTag.isSuccess) {
  // Tag added: test-tag
  print("Tag added: ${addedTag.data}");
} else {
  print(addedTag.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.removeTag()

To remove a tag from a document.

Input

Output

RequestResponse<String>

Example

RequestResponse<String> removedTag = await getFrappeModelController().removeTag( 
  doctype: "Renovation Review",
  docname: "RE-00001",
  tag: "test-tag"
);
​
if (removedTag.isSuccess) {
  // Tag removed
  print("Tag removed");
} else {
  print(removedTag.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document

.getTaggedDocs()

To get all the tagged documents of a certain doctype.

Input

Output

RequestResponse<List<String>>

Example

RequestResponse<List<String>> taggedDocs = await getFrappeModelController().getTaggedDocs( 
  doctype: "Renovation Review",
  tag: "test-tag"
);
​
if (taggedDocs.isSuccess) {
  // Number of documents: 3
  print("Number of documents: ${taggedDocs.data.length");
} else {
  print(taggedDocs.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

.getTags()

To get all the tags of a doctype.

Input

Output

RequestResponse<List<String>>

Example

RequestResponse<List<String>> tags = await getFrappeModelController().getTags(
  doctype: "Renovation Review",
  likeTag: "test-"
);
​
if (tags.isSuccess) {
  // Number of documents: 3
  print("Number of tags: ${tags.data.length}");
} else {
  print(tags.error);
}

Possible Errors

Doctype Does Not Exist

HTTP code: 404

type: NotFoundError

cause: DocType does not exist

suggestion: Make sure the queried DocType is input correctly or create the required DocType

.getReport() ★

To get report values of type Renovation Report

Input

Output

RequestResponse<FrappeReport>

Example

RequestResponse<FrappeReport> report = await getFrappeModelController().getReport(
  report: "Test Report",
  filters: {},
  user: null
);
​
if (report.isSuccess) {
  // Display the report's data as required in the UI, for instance.
  // report.result
  // report.columns
} else {
  print(report.error);
}

Possible Errors

Non-existing document

HTTP code: 404

type: NotFoundError

cause: Docname does not exist

suggestion: Make sure the queried document name is correct or create the required document