log

Log

getCachingEnabled

boolean log.getCachingEnabled ( ) (professional and enterprise editions only)

Description

Returns whether or not the cache is enabled for the scrape. When enabled, it simply means that each ScrapeableFile will save the content it downloads from the server to the file system so it can be viewed later, generally for debugging purposes.

Parameters

This method takes no parameters

endCaching

void log.endCaching ( ) (professional and enterprise editions only)

Description

Ends the caching for the scrape. This method will be called once all the scripts and files are run/scraped. It can be called in a script to end the caching early (thereby only caching a portion of the scrape). This only deals with saving downloaded content to the file system, not with reading it back in during a scrape.

enableCaching

void log.enableCaching ( String description, boolean saveLogs, boolean zipCachedFiles ) (professional and enterprise editions only)

Description

getProgressBar

ProgressBar log.getProgressBar ( int index ) (enterprise edition only)
ProgressBar log.getProgressBar ( String title ) (enterprise edition only)

Description

removeProgressBar

void log.removeProgressBar ( ProgressBar progressBar ) (enterprise edition only)
void log.removeProgressBarIfNotStopped ( ProgressBar progressBar ) (enterprise edition only)

Description

addProgressBar

ProgressBar log.addProgressBar ( String title ) (enterprise edition only)
ProgressBar log.addProgressBar ( String title, String total ) (enterprise edition only)

logScreenScraperInformation

void log.logScreenScraperInformation ( )

Description

Logs useful information about the current instance of Screen-Scraper, as well as the Java VM and the General Utility version being used. Information will be logged as an info message in the web interface (when running in server mode) and the log.

Parameters

This method takes no parameters

Return Value

This method returns void.

webClose

void log.webClose ( Object object ) (professional and enterprise editions only)

Description

Logs closing values to indicate the scrape is complete and what values were when everything finished. It will log at whatever the highest level logged to was. For instance, if a webWarn had been logged during the scrape, this will log at the warning level. When running in Professional edition, this simply outputs to the log.

webError

void log.webError ( Object object ) (professional and enterprise editions only)
void log.webError ( Object object, boolean saveMessage ) (professional and enterprise editions only)

webWarn

void log.webWarn ( Object object ) (professional and enterprise editions only)
void log.webWarn ( Object object, boolean saveMessage ) (professional and enterprise editions only)