Common QDoc Naming Convention
Each QDoc name consists of an action (verb) followed by its object (noun) that best expresses the meaning of the QDoc. The name should be as similar as possible to the corresponding API method name, if any, that implements the business logic required for the QDoc.Important: The length of the name of a QDoc can be a maximum of 32 characters.
QDoc Name Suffixes describes QDoc naming conventions.
QDoc Name Suffixes
QDoc Type | Suffix | Examples |
Request In | - | maintainSalesOrder |
Response Out | Response | maintainSalesOrderResponse |
The suffix for the Response Out type is assigned according to present WSDL message-naming conventions, where requests are customarily not suffixed and responses are customarily suffixed with the literal Response.All QDoc names are written in mixed-case or camel-case notation for Java classes, in which the first letter of each token within a name is capitalized, while all other letters are lower-case.In the case of QAD Enterprise Applications, the maintain verb is used for all create-read-update-delete (CRUD) type QDocs with the detailed action (add, modify, delete, sync, get) expressed in the body of the QDoc.