Fovia's .NET Client/Server API
Public Member Functions | Public Attributes | List of all members
com.fovia.hdrc.hdrcJobInfo Class Reference

Public Member Functions

int getErrorCode ()
 
int getProgress ()
 
 hdrcJobInfo (int prog, int err)
 

Public Attributes

int m_err
 
int m_prog
 

Detailed Description

Container that holds information about a job in progress.

Constructor & Destructor Documentation

com.fovia.hdrc.hdrcJobInfo.hdrcJobInfo ( int  prog,
int  err 
)

Constructor for hdrcJobInfo, generally called by framework.

Parameters
prog- The progress of the job, values in the range of 0 to 100.
Returns
err - The return code from the job when it completes.
Exceptions
IOException

References com.fovia.hdrc.hdrcJobInfo.m_err, and com.fovia.hdrc.hdrcJobInfo.m_prog.

Member Function Documentation

int com.fovia.hdrc.hdrcJobInfo.getErrorCode ( )

Gets the return code of the current job when it compeltes.

Returns
The return code from the operation when it completes.
Exceptions
IOException
int com.fovia.hdrc.hdrcJobInfo.getProgress ( )

Gets the progress of the current job in progress.

Returns
The progress of the job, values in the range of 0 to 100.
Exceptions
IOException

Member Data Documentation

int com.fovia.hdrc.hdrcJobInfo.m_err

This will hold the error code if something goes wrong. As always, values less than zero indicate errors.

Referenced by com.fovia.hdrc.hdrcJobInfo.hdrcJobInfo(), and com.fovia.hdrc.interact.hdrcConnectivityAdaptor.isCompleted().

int com.fovia.hdrc.hdrcJobInfo.m_prog