ICaptureServer Interface Reference

Inheritance diagram for ICaptureServer:

Public Member Functions
void	registerDevice (ICompletionListener< Void > completionListener)
void	login (UserProfile userProfile, ICompletionListener< List< String >> completionListener)
void	loginAnonymously (ICompletionListener< List< String >> completionListener)
void	logout (ICompletionListener< Void > completionListener)
void	getDocumentType (String documentTypeName, ICompletionListener< DocumentType > completionListener)
void	startJobService (ICompletionListener< String > completionListener)
void	sendImageService (Document document, String jobID, Image image, int ImageIndex, boolean lastImage, ICompletionListener< Void > completionListener)
void	submitDocument (Document document, IProgressListener iProgressListener, ICompletionListener iCompletionListener)
ErrorInfo	cancelSubmission (String submitJobID)

Detailed Description

Specifies the interface required to satisfy KFS/KTA dependencies.

Member Function Documentation

ErrorInfo cancelSubmission

(

String

submitJobID

)

The only operation that is currently cancellable is the submitDocument method.

Parameters

submitJobID

JobID of the submission operation from progress listener results.

Returns

An ErrorInfo result indicating whether the cancel task was successfully started.

Implemented in CaptureServer.

void getDocumentType	(	String	documentTypeName,
		ICompletionListener< DocumentType >	completionListener
	)

Returns the DocumentType object which corresponds to the DocumentType name specified.

Note: The listener's object parameter will be DocumentType.

Parameters

documentTypeName	This indicates which DocumentType to download.
completionListener	A completion listener, return results as well as any Exceptions.

void login	(	UserProfile	userProfile,
		ICompletionListener< List< String >>	completionListener
	)

Login to the server using credentials from the UserProfile object.

Note: The listener's object parameter will be a list if the user logged into the server successfully

Parameters

userProfile	This contains login credentials of the user.
completionListener	A completion listener, return results as well as any Exceptions.

void loginAnonymously

(

ICompletionListener< List< String >>

completionListener

)

Fetches the device profile shortcuts from the server.

Note: The listener's object parameter will be a list if the user successfully fetches the profile shortcuts.

Parameters

completionListener

A completion listener, return results as well as any Exceptions.

void logout

(

ICompletionListener< Void >

completionListener

)

Logout from the server if previously called login(UserProfile, ICompletionListener) or loginAnonymously(ICompletionListener).

Note: The listener's exception object will be empty if the device logged out successfully.

Parameters

completionListener

A completion listener, return results as well as any Exceptions.

void registerDevice

(

ICompletionListener< Void >

completionListener

)

Register a mobile device with the server and obtain a license, if available. If device registration fails then the listener is called with KmcRuntimeException. If you receive the following ErrorInfo#KMC_LO_REGISTER_REQUIRES_AUTH in the Exception, it indicates device registration requires authentication. Hence login needs to be called before registering the device.

Note: The listener's exception object will be empty if device registered successfully.

Parameters

completionListener

A completion listener, return results as well as any Exceptions.

void sendImageService	(	Document	document,
		String	jobID,
		Image	image,
		int	ImageIndex,
		boolean	lastImage,
		ICompletionListener< Void >	completionListener
	)

SendImageService method will be used to send the single image to the server using the given JobID.

Note: The listener's exception object will be empty if the Image sent to the server without any error.

Parameters

document	This contains the document data.
jobID	The UniqueID of the document submission job.
image	The image field.
ImageIndex	The image index in the document submission job, should start with 0.
lastImage	This indicates the last image in the job submission.
completionListener	A completion listener, return results as well as any Exceptions.

void startJobService

(

ICompletionListener< String >

completionListener

)

This will start a new document submission job by calling the startJob method on the server. This will return a unique job ID that is different from any job ID used by any other input device. Documents can be submitted concurrently, by using the different job IDs. Submit the images in the document, by calling the sendImageService() after getting the job ID.

Note: The listener's object parameter will be job ID.

Parameters

completionListener

A completion listener, return results as well as any Exceptions.

void submitDocument	(	Document	document,
		IProgressListener	iProgressListener,
		ICompletionListener	iCompletionListener
	)

The submitDocument method submits a Document to KFS/KTA, including all fields and pages. Within each page, only the image indicated by the property currentImageIndex is included in the Document submission.

Parameters

document	this contains the docuement data.
iCompletionListener	A completion listener, return results as well as any Exceptions.
iProgressListener	A progress listener, return progress results and submitJobID.

---

The documentation for this interface was generated from the following file:

• ICaptureServer.java