iText 8.0.5 API
iText.Signatures.Validation.V1.Report.ReportItem Class Reference

Report item to be used for single failure or log message. More...

Inheritance diagram for iText.Signatures.Validation.V1.Report.ReportItem:
iText.Signatures.Validation.V1.Report.CertificateReportItem

Public Types

enum   ReportItemStatus { ReportItemStatus.INFO, ReportItemStatus.INVALID, ReportItemStatus.INDETERMINATE }
  Enum representing possible report item statuses that determine validation result. More...
 

Public Member Functions

  ReportItem (String checkName, String message, ReportItem.ReportItemStatus status)
  Create ReportItem instance. More...
 
  ReportItem (String checkName, String message, Exception cause, ReportItem.ReportItemStatus status)
  Create ReportItem instance. More...
 
virtual String  GetCheckName ()
  Get the check name related to this report item. More...
 
virtual String  GetMessage ()
  Get the message related to this report item. More...
 
virtual Exception  GetExceptionCause ()
  Get the exception, which caused this report item. More...
 
virtual ReportItem.ReportItemStatus  GetStatus ()
  Get report item status that determines validation result this report item corresponds to. More...
 
virtual iText.Signatures.Validation.V1.Report.ReportItem  SetStatus (ReportItem.ReportItemStatus status)
  Set report item status that determines validation result this report item corresponds to. More...
 
override String  ToString ()
 

Detailed Description

Report item to be used for single failure or log message.

Member Enumeration Documentation

◆ ReportItemStatus

Enum representing possible report item statuses that determine validation result.

Enumerator
INFO 

Report item status for info messages.

INVALID 

Report item status that leads to invalid validation result.

INDETERMINATE 

Report item status that leads to indeterminate validation result.

Constructor & Destructor Documentation

◆ ReportItem() [1/2]

iText.Signatures.Validation.V1.Report.ReportItem.ReportItem ( String  checkName,
String  message,
ReportItem.ReportItemStatus  status 
)
inline

Create ReportItem instance.

Parameters
checkName

System.String , which represents a check name during which report item occurred

Parameters
message

System.String with the exact report item message

Parameters
status

ReportItemStatus report item status that determines validation result

◆ ReportItem() [2/2]

iText.Signatures.Validation.V1.Report.ReportItem.ReportItem ( String  checkName,
String  message,
Exception  cause,
ReportItem.ReportItemStatus  status 
)
inline

Create ReportItem instance.

Parameters
checkName

System.String , which represents a check name during which report item occurred

Parameters
message

System.String with the exact report item message

Parameters
cause

System.Exception , which caused this report item

Parameters
status

ReportItemStatus report item status that determines validation result

Member Function Documentation

◆ GetCheckName()

virtual String iText.Signatures.Validation.V1.Report.ReportItem.GetCheckName ( )
inlinevirtual

Get the check name related to this report item.

Returns

System.String check name related to this report item.

◆ GetExceptionCause()

virtual Exception iText.Signatures.Validation.V1.Report.ReportItem.GetExceptionCause ( )
inlinevirtual

Get the exception, which caused this report item.

Returns

System.Exception , which cause this report item.

◆ GetMessage()

virtual String iText.Signatures.Validation.V1.Report.ReportItem.GetMessage ( )
inlinevirtual

Get the message related to this report item.

Returns

System.String message related to this report item.

◆ GetStatus()

virtual ReportItem.ReportItemStatus iText.Signatures.Validation.V1.Report.ReportItem.GetStatus ( )
inlinevirtual

Get report item status that determines validation result this report item corresponds to.

Returns

ReportItemStatus report item status that determines validation result.

◆ SetStatus()

virtual iText.Signatures.Validation.V1.Report.ReportItem iText.Signatures.Validation.V1.Report.ReportItem.SetStatus ( ReportItem.ReportItemStatus  status )
inlinevirtual

Set report item status that determines validation result this report item corresponds to.

Parameters
status

ReportItemStatus report item status that determines validation result

Returns
this ReportItem instance.

◆ ToString()

override String iText.Signatures.Validation.V1.Report.ReportItem.ToString ( )
inline

Returns