HSMOD.REST.Utils

abstract class HSMOD.REST.Utils

Method Inventory

Methods

classmethod ValidateAPIMethodSignature(pAPIClassName As %Dictionary.Classname, pAPIMethodName As %String, Output pExpectedRequestClassName As %Dictionary.Classname, Output pExpectedResponseClassName As %Dictionary.Classname)
helper method for HSMOD.REST.Base. Throws exceptions for any validation problem; caller will handle the exception.
classmethod ValidateRESTRequestObject(pAPIClassName As %Dictionary.Classname, pAPIMethodName As %String, pRequestObject As %RegisteredObject, pSpecifiedClassName As %Dictionary.Classname, pExpectedClassName As %Dictionary.Classname)
non-API utility to support HSMOD.REST.Base. Throws a status error if validation failed.
The class & method used in the API call are used to construct error statuses if something went wrong, to help locate the problem.
The "specified" class name is what the calling code specified as the request object class when calling the SimpleRESTRequestResponse method; the "expected" class name is what we found in the method signature. These must be compatible.
classmethod ValidateRESTResponseObject(pAPIClassName As %Dictionary.Classname, pAPIMethodName As %String, pResponseObject As %RegisteredObject, pSpecifiedClassName As %Dictionary.Classname, pExpectedClassName As %Dictionary.Classname)
non-API utility to support HSMOD.REST.Base. Throws a status error if validation failed.
The class & method used in the API call are used to construct error statuses if something went wrong, to help locate the problem.
The "specified" class name is what the calling code specified as the response object class when calling the SimpleRESTRequestResponse method; the "expected" class name is what we found in the method signature. These must be compatible.
Feedback