Interface ExceptionRelatesToAPIObject
-
- All Known Implementing Classes:
ConstraintViolatedException
,ExportException
,FileParameterInvalidTypeException
,FileParameterMissingTypeException
,FileParameterSourceUnavailableException
public interface ExceptionRelatesToAPIObject
This interface is implemented by exceptions that are caused by a schedulerentity. This can then be used to show the user which object, and even the field if it is known, caused the exception
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getRelatedField()
If the cause of the exception is caused by a specific field then it returns the name of the fieldString
getRelatedObjectType()
What is the object type of the object that caused the exceptionLong
getRelatedUid()
What is the UniqueId of the object that caused the exception
-
-
-
Method Detail
-
getRelatedObjectType
String getRelatedObjectType()
What is the object type of the object that caused the exception- Returns:
- the object type of the object that caused the excpetion
-
getRelatedUid
Long getRelatedUid()
What is the UniqueId of the object that caused the exception- Returns:
- the UniqueId of the object that caused the exception
-
getRelatedField
String getRelatedField()
If the cause of the exception is caused by a specific field then it returns the name of the field- Returns:
- the name of the field that caused the exception, otherwise it returns null.
-
-