SCM API Developer Reference

scmc.ErrorLog

global with sharing class ErrorLog

this class is used to insert log records into the scm error log object.

Author

Financial Force, Inc.

Methods

log

global static void log(String className, String message)

Inserts a record into the scmc.ErrorLog object and sends an email to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.

Exceptions Thrown

Value Description
noException This method does not throw an exception.

Return Value

Does not return a value.

log

global static void log(String className, String message, String trace)

Inserts a record into the scmc.ErrorLog object and sends an email to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.
trace String Trace information for the error.

Exceptions Thrown

Value Description
noException This method does not throw an exception.

Return Value

Does not return a value.

log

global static void log(String className, String message, String trace, boolean flushErrorList)

Adds a new scmc.ErrorLog object to a list. If flushErrorList is true, the entire error list is inserted. Otherwise, only the newly created scmc.ErrorLog object is inserted and an email is sent to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.
trace String Trace information for the error.
flushErrorList boolean Whether to insert the entire list of errors (true) or only insert the current error (false).

Exceptions Thrown

Value Description
Exception If flushErrorList is true and there is an error inserting the error list.

Return Value

Does not return a value.

log

global static void log(String className, String message, Exception e)

Inserts a record into the scmc.ErrorLog object and sends an email to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.
e Exception The Salesforce Exception object to log.

Exceptions Thrown

Value Description
noException This method does not throw an exception.

Return Value

Does not return a value.

log

global static void log(String className, String message, boolean flushErrorList)

Adds a new scmc.ErrorLog object to a list. If flushErrorList is true, the entire error list is inserted. Otherwise, only the newly created scmc.ErrorLog object is inserted and an email is sent to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.
flushErrorList boolean Whether to insert the entire list of errors (true) or only insert the current error (false).

Exceptions Thrown

Value Description
Exception If flushErrorList is true and there is an error inserting the error list.

Return Value

Does not return a value.

log

global static void log(String className, String message, Exception e, String additionalInfo)

Inserts a record into the scmc.ErrorLog object and sends an email to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.

Exceptions Thrown

Value Description
noException This method does not throw an exception.

Return Value

Does not return a value.

log

global static void log(String className, String message, Exception e, String additionalInfo, boolean flushErrorList)

Adds a new scmc.ErrorLog object to a list. If flushErrorList is true, the entire error list is inserted. Otherwise, only the newly created scmc.ErrorLog object is inserted and an email is sent to the address specified in the custom setting Organization Settings Notification Email.

Input Parameters

Name Type Description
className String Name of the method where logging is being done.
message String A description of the error.
flushErrorList boolean Whether to insert the entire list of errors (true) or only insert the current error (false).

Exceptions Thrown

Value Description
Exception If flushErrorList is true and there is an error inserting the error list.

Return Value

Does not return a value.

flush

global static void flush()

Inserts the entire list of errors.

Exceptions Thrown

Value Description
Exception If there is an error inserting the error list.

Return Value

Does not return a value.

© Copyright 2009–2022 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.