com.groupdocs.signature.domain

Class SearchResult

java.lang.Object

com.groupdocs.signature.domain.SearchResult

All Implemented Interfaces:

Iterable<BaseSignature>

public class SearchResult
extends Object
implements Iterable<BaseSignature>

Result of searching for signatures in specified document.

Method Summary

Modifier and Type	Method and Description
long	getDestinDocumentSize() Returns destination document size.
List<BaseSignature>	getFailed() List of signatures BaseSignature that failed Search process by search criteria.
long	getProcessingTime() Returns the execution time of the search process in milliseconds.
List<BaseSignature>	getSignatures() List of detected signatures BaseSignature.
long	getSourceDocumentSize() Returns source document size
List<BaseSignature>	getSucceeded() List of found signatures BaseSignature.
int	getTotalSignatures() Returns the total processed signatures by the search process
<T extends BaseSignature> List<T>	toList(Class<T> typeOfT) Provides conversion to strongly typed list of signatures.
void	updateContextData(com.groupdocs.signature.provider.SearchContext context, int documentType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getDestinDocumentSize

public final long getDestinDocumentSize()

Returns destination document size. For Search method it always returns 0.

getFailed

public final List<BaseSignature> getFailed()

List of signatures BaseSignature that failed Search process by search criteria. Not supported in current version.

getProcessingTime

public final long getProcessingTime()

Returns the execution time of the search process in milliseconds.

getSignatures

public final List<BaseSignature> getSignatures()

List of detected signatures BaseSignature.

getSourceDocumentSize

public final long getSourceDocumentSize()

Returns source document size

getSucceeded

public final List<BaseSignature> getSucceeded()

List of found signatures BaseSignature. This list will be always equal to Signatures(getSignatures()/#setSignatures(List)) property.

getTotalSignatures

public final int getTotalSignatures()

Returns the total processed signatures by the search process

toList

public final <T extends BaseSignature> List<T> toList(Class<T> typeOfT)

Provides conversion to strongly typed list of signatures.

Returns:

Returns list of given signature type.

T: The type of signatures in the list.

updateContextData

public final void updateContextData(com.groupdocs.signature.provider.SearchContext context,
                                    int documentType)