| java.lang.Object
 org.ofbiz.service.ServiceUtil
| ServiceUtil | | public class ServiceUtil (Code) | | Generic Service Utility Class
|
| Method Summary | |
| public static void | addErrors(List targetList, Map targetMap, Map callResult)
Takes the result of an invocation and extracts any error messages
and adds them to the targetList or targetMap. | | public static Map | cancelJob(DispatchContext dctx, Map context)
| | public static Map | cancelJobRetries(DispatchContext dctx, Map context)
| | public static String | getErrorMessage(Map result)
| | public static void | getMessages(HttpServletRequest request, Map result, String defaultMessage)
| | public static void | getMessages(HttpServletRequest request, Map result, String defaultMessage, String msgPrefix, String msgSuffix, String errorPrefix, String errorSuffix, String successPrefix, String successSuffix)
| | public static String | getPartyIdCheckSecurity(GenericValue userLogin, Security security, Map context, Map result, String secEntity, String secOperation)
| | public static GenericValue | getUserLogin(DispatchContext dctx, Map context, String runAsUser)
| | public static boolean | isError(Map results)
| | public static boolean | isFailure(Map results)
| | public static String | makeErrorMessage(Map result, String msgPrefix, String msgSuffix, String errorPrefix, String errorSuffix)
| | public static String | makeMessageList(List msgList, String msgPrefix, String msgSuffix)
| | public static String | makeSuccessMessage(Map result, String msgPrefix, String msgSuffix, String successPrefix, String successSuffix)
| | public static Map | purgeOldJobs(DispatchContext dctx, Map context)
| | public static Map | returnError(String errorMessage)
| | public static Map | returnError(String errorMessage, List errorMessageList)
| | public static Map | returnError(List errorMessageList)
| | public static Map | returnError(String errorMessage, List errorMessageList, Map errorMessageMap, Map nestedResult)
| | public static Map | returnFailure(String errorMessage)
| | public static Map | returnFailure(List errorMessageList)
| | public static Map | returnFailure()
| | public static Map | returnMessage(String code, String message)
| | public static Map | returnProblem(String returnType, String errorMessage, List errorMessageList, Map errorMessageMap, Map nestedResult)
| | public static Map | returnSuccess(String successMessage)
| | public static Map | returnSuccess()
| | public static void | setMessages(HttpServletRequest request, String errorMessage, String eventMessage, String defaultMessage)
|
| addErrors | | public static void addErrors(List targetList, Map targetMap, Map callResult)(Code) | | Takes the result of an invocation and extracts any error messages
and adds them to the targetList or targetMap. This will handle both List and String
error messags.
Parameters:
targetList - The List to add the error messages to
Parameters:
targetMap - The Map to add any Map error messages to
Parameters:
callResult - The result from an invocation |
| getPartyIdCheckSecurity | | public static String getPartyIdCheckSecurity(GenericValue userLogin, Security security, Map context, Map result, String secEntity, String secOperation)(Code) | | A small routine used all over to improve code efficiency, get the partyId and does a security check
security check: userLogin partyId must equal partyId, or must have [secEntity][secOperation] permission
|
| isError | | public static boolean isError(Map results)(Code) | | A little short-cut method to check to see if a service returned an error
|
| isFailure | | public static boolean isFailure(Map results)(Code) | | |
| returnError | | public static Map returnError(String errorMessage)(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the error response code
|
| returnError | | public static Map returnError(String errorMessage, List errorMessageList)(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the error response code
|
| returnError | | public static Map returnError(List errorMessageList)(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the error response code
|
| returnError | | public static Map returnError(String errorMessage, List errorMessageList, Map errorMessageMap, Map nestedResult)(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the error response code, also forwards any error messages from the nestedResult
|
| returnFailure | | public static Map returnFailure(List errorMessageList)(Code) | | |
| returnFailure | | public static Map returnFailure()(Code) | | |
| returnMessage | | public static Map returnMessage(String code, String message)(Code) | | A small routine to make a result map with the message and the response code
NOTE: This brings out some bad points to our message convention: we should be using a single message or message list
and what type of message that is should be determined by the RESPONSE_MESSAGE (and there's another annoyance, it should be RESPONSE_CODE)
|
| returnSuccess | | public static Map returnSuccess(String successMessage)(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the success response code
|
| returnSuccess | | public static Map returnSuccess()(Code) | | A small routine used all over to improve code efficiency, make a result map with the message and the success response code
|
|
|