SearchResult Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Iterable
public class SearchResult implements Iterable<BaseSignature>
Result of searching for signatures in specified document.
| Method | Description |
|---|---|
| getProcessingTime() | Returns the execution time of the search process in milliseconds. |
| getTotalSignatures() | Returns the total processed signatures by the search process |
| getSourceDocumentSize() | Returns source document size |
| getDestinDocumentSize() | Returns destination document size. |
| getSucceeded() | List of found signatures BaseSignature. |
| getFailed() | List of signatures BaseSignature that failed Search process by search criteria. |
| getSignatures() | List of detected signatures BaseSignature. |
| Provides conversion to strongly typed list of signatures. | |
| updateContextData(SearchContext context, int documentType) |
public final long getProcessingTime()
Returns the execution time of the search process in milliseconds.
Returns: long
public final int getTotalSignatures()
Returns the total processed signatures by the search process
Returns: int
public final long getSourceDocumentSize()
Returns source document size
Returns: long
public final long getDestinDocumentSize()
Returns destination document size. For Search method it always returns 0.
Returns: long
public final List<BaseSignature> getSucceeded()
List of found signatures BaseSignature. This list will be always equal to Signatures (#getSignatures.getSignatures/#setSignatures(List).setSignatures(List)) property.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
public final List<BaseSignature> getFailed()
List of signatures BaseSignature that failed Search process by search criteria. Not supported in current version.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
public final List<BaseSignature> getSignatures()
List of detected signatures BaseSignature.
Returns: java.util.List<com.groupdocs.signature.domain.signatures.BaseSignature>
public final List<T> <T>toList(Class<T> typeOfT)
Provides conversion to strongly typed list of signatures.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| typeOfT | java.lang.Class |
Returns:
java.util.List
- T
- The type of signatures in the list.
public final void updateContextData(SearchContext context, int documentType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| context | SearchContext | |
| documentType | int |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.