com.qoppa.pdfPreflight.results

Interface ResultRecord

public interface ResultRecord

This object holds information about an issue found in the document. The information includes a header or short name, a detail string and the page number where the issue happened.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
Rectangle2D	getBounds() Returns the bounds for which the result record was created.
String	getDetail() Returns detail information about this result.
String	getHeader() Returns a short string about the result.
int	getPageNumber() Returns the page number for which the result record was created.
boolean	isFixable() If the result can be fixed by running the applicable conversion profile will return true
String	toString() Returns a string representation of the result that includes the page number and the detail message.
boolean	willFix() If the applicable conversion profile can fix this result (i.e.

Method Detail

getHeader

String getHeader()

Returns a short string about the result. The intent is to use this in a list.

Returns:

The result header.

getDetail

String getDetail()

Returns detail information about this result.

Returns:

The result detail.

getPageNumber

int getPageNumber()

Returns the page number for which the result record was created.

Returns:

The page number.

getBounds

Rectangle2D getBounds()

Returns the bounds for which the result record was created.

Returns:

The bounds.

toString

String toString()

Returns a string representation of the result that includes the page number and the detail message.

Overrides:

toString in class Object

willFix

boolean willFix()

If the applicable conversion profile can fix this result (i.e. isFixable() == true) and conversion settings are consistent with fixing this result then willFix() will return true.

Returns:

true If this result will be fixed by the conversion profile

isFixable

boolean isFixable()

If the result can be fixed by running the applicable conversion profile will return true

Returns:

true if the result can be fixed by running the applicable conversion profile