BaseFileException (Common API)

Overview - Common API - Client API - Admin API - Runtime API

BaseFileException

Exception throws when a composer file is semantically invalid

Details

  • Extends BaseException

  • Module common

See also

  • See (see {@link baseexception)

Method Summary

Name Returns Description
constructor void Create an IllegalModelException
getFileLocation string Returns the file location associated with the exception or null
getShortMessage string Returns the error message without the location of the error

Method Details

new BaseFileException()

Create an IllegalModelException

Parameters

Name Type Optional Description
message string false the message for the exception
fileLocation string false the optional file location associated with the exception
fullMessage string false the optional full message text

getFileLocation

string getFileLocation( )

Returns the file location associated with the exception or null

Returns

string - the optional location associated with the exception

Parameters

No parameters

getShortMessage

string getShortMessage( )

Returns the error message without the location of the error

Returns

string - the error message

Parameters

No parameters