org.kde.koala
Class Job

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.qt.QObject
          extended by org.kde.koala.Job
All Implemented Interfaces:
org.kde.qt.QtSupport
Direct Known Subclasses:
CopyJob, DeleteJob, FileCopyJob, KDirSize, MetaInfoJob, PreviewJob, SimpleJob

public class Job
extends org.kde.qt.QObject

The base class for all jobs. For all jobs created in an application, the code looks like

   KIO.Job  job = KIO.someoperation( some parameters );
   connect( job, SIGNAL("result( KIO.Job  )"),
            this, SLOT("slotResult( KIO.Job  )") );
 
(other connects, specific to the job) And slotResult is usually at least:
  if ( job.error() )
      job.showErrorDialog( this or null  );
 
See JobSignals for signals emitted by Job

See Also:
Scheduler, Slave

Field Summary
 
Fields inherited from class org.kde.qt.Qt
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP
 
Constructor Summary
  Job(boolean showProgressInfo)
           
protected Job(java.lang.Class dummy)
           
 
Method Summary
 void addMetaData(java.lang.String key, java.lang.String value)
          Add key/value pair to the meta data that is sent to the slave.
protected  void addSubjob(Job job)
           
protected  void addSubjob(Job job, boolean inheritMetaData)
          Add a job that has to be finished before a result is emitted.
 java.lang.String className()
           
 java.util.ArrayList detailedErrorStrings()
           
 java.util.ArrayList detailedErrorStrings(KURL reqUrl)
           
 java.util.ArrayList detailedErrorStrings(KURL reqUrl, int method)
          Converts an error code and a non-i18n error message into i18n strings suitable for presentation in a detailed error message box.
protected  void emitPercent(long processedSize, long totalSize)
          Utility function for inherited jobs.
protected  void emitResult()
          Utility function to emit the result signal, and suicide this job.
protected  void emitSpeed(long speed)
          Utility function for inherited jobs.
 int error()
          Returns the error code, if there has been an error.
 java.lang.String errorString()
          Converts an error code and a non-i18n error message into an error message in the current language.
 java.lang.String errorText()
          Returns the error text if there has been an error.
protected  int extraFlags()
           
 long getProcessedSize()
          Returns the processed size for this job.
 boolean isAutoErrorHandlingEnabled()
          Returns whether automatic error handling is enabled or disabled.
 boolean isAutoWarningHandlingEnabled()
          Returns whether automatic warning handling is enabled or disabled.
 boolean isInteractive()
          Returns whether message display is enabled or disabled.
 void kill()
           
 void kill(boolean quietly)
          Abort this job.
 org.kde.qt.QMetaObject metaObject()
           
 Job parentJob()
          Returns the parent job, if there is one.
 int progressId()
          Returns the progress id for this job.
 java.lang.String queryMetaData(java.lang.String key)
          Query meta data received from the slave.
protected  void removeSubjob(Job job)
          Mark a sub job as being done.
protected  void removeSubjob(Job job, boolean mergeMetaData, boolean emitResultIfLast)
          Overloaded version of removeSubjob
 void setAutoErrorHandlingEnabled(boolean enable)
           
 void setAutoErrorHandlingEnabled(boolean enable, org.kde.qt.QWidget parentWidget)
          Enable or disable the automatic error handling.
 void setAutoWarningHandlingEnabled(boolean enable)
          Enable or disable the automatic warning handling.
 void setInteractive(boolean enable)
          Enable or disable the message display from the job.
 void setParentJob(Job parentJob)
          Set the parent Job.
protected  void setProcessedSize(long size)
          Set the processed size, does not emit processedSize
 void setWindow(org.kde.qt.QWidget window)
          Associate this job with a window given by window.
 void showErrorDialog()
           
 void showErrorDialog(org.kde.qt.QWidget parent)
          Display a dialog box to inform the user of the error given by this job.
protected  void slotInfoMessage(Job job, java.lang.String msg)
          Forward signal from subjob.
protected  void slotResult(Job job)
          Called whenever a subjob finishes.
protected  void slotSpeed(Job job, long speed)
          Forward signal from subjob.
protected  void slotSpeedTimeout()
          Remove speed information.
 org.kde.qt.QWidget window()
          Returns the window this job is associated with.
 
Methods inherited from class org.kde.qt.QObject
activate_filters, activate_signal_bool, activate_signal, activate_signal, activate_signal, activate_signal, blockSignals, checkConnectArgs, child, child, child, childEvent, children, connect, connect, connectInternal, connectNotify, customEvent, deleteLater, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnectInternal, disconnectNotify, dispose, dumpObjectInfo, dumpObjectTree, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, emit, event, eventFilter, finalize, highPriority, i18n, inherits, insertChild, installEventFilter, isA, isDisposed, isWidgetType, killTimer, killTimers, name, name, normalizeSignalSlot, objectTrees, parent, property, queryList, queryList, queryList, queryList, queryList, registerUserData, removeChild, removeEventFilter, sender, setName, setProperty, signalsBlocked, startTimer, timerEvent, tr, tr
 
Methods inherited from class org.kde.qt.Qt
arrowCursor, bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blankCursor, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, crossCursor, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, ibeamCursor, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, sizeAllCursor, sizeBDiagCursor, sizeFDiagCursor, sizeHorCursor, sizeVerCursor, SLOT, splitHCursor, splitVCursor, upArrowCursor, waitCursor, whatsThisCursor, white, ws, yellow
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Job

protected Job(java.lang.Class dummy)

Job

public Job(boolean showProgressInfo)
Method Detail

metaObject

public org.kde.qt.QMetaObject metaObject()
Overrides:
metaObject in class org.kde.qt.QObject

className

public java.lang.String className()
Overrides:
className in class org.kde.qt.QObject

kill

public void kill(boolean quietly)
Abort this job. This kills all subjobs and deletes the job.

Parameters:
quietly - if false, Job will emit signal result and ask kio_uiserver to close the progress window. quietly is set to true for subjobs. Whether applications should call with true or false depends on whether they rely on result being emitted or not.

kill

public void kill()

error

public int error()
Returns the error code, if there has been an error. Only call this method from the slot connected to result().

Returns:
the error code for this job, 0 if no error. Error codes are defined in KIO.Error.

progressId

public int progressId()
Returns the progress id for this job.

Returns:
the progress id for this job, as returned by uiserver

errorText

public java.lang.String errorText()
Returns the error text if there has been an error. Only call if error is not 0. This is really internal, better use errorString() or errorDialog().

Returns:
a string to help understand the error, usually the url related to the error. Only valid if error() is not 0.

errorString

public java.lang.String errorString()
Converts an error code and a non-i18n error message into an error message in the current language. The low level (non-i18n) error message (usually a url) is put into the translated error message using %1. Example for errid == ERR_CANNOT_OPEN_FOR_READING:
                   i18n( "Could not read\n%1" ).arg( errortext );
                 
Use this to display the error yourself, but for a dialog box use Job.showErrorDialog. Do not call it if error() is not 0.

Returns:
the error message and if there is no error, a message telling the user that the app is broken, so check with error() whether there is an error

detailedErrorStrings

public java.util.ArrayList detailedErrorStrings(KURL reqUrl,
                                                int method)
Converts an error code and a non-i18n error message into i18n strings suitable for presentation in a detailed error message box.

Parameters:
reqUrl - the request URL that generated this error message
method - the method that generated this error message (unimplemented)
Returns:
the following strings: caption, error + description, causes+solutions

detailedErrorStrings

public java.util.ArrayList detailedErrorStrings(KURL reqUrl)

detailedErrorStrings

public java.util.ArrayList detailedErrorStrings()

showErrorDialog

public void showErrorDialog(org.kde.qt.QWidget parent)
Display a dialog box to inform the user of the error given by this job. Only call if error is not 0, and only in the slot connected to result.

Parameters:
parent - the parent widget for the dialog box, can be 0 for top-level

showErrorDialog

public void showErrorDialog()

setAutoErrorHandlingEnabled

public void setAutoErrorHandlingEnabled(boolean enable,
                                        org.kde.qt.QWidget parentWidget)
Enable or disable the automatic error handling. When automatic error handling is enabled and an error occurs, then showErrorDialog() is called with the specified parentWidget (if supplied) , right before the emission of the result signal. The default is false.

Parameters:
enable - enable or disable automatic error handling
parentWidget - the parent widget, passed to showErrorDialog. Can be 0 for top-level
See Also:
isAutoErrorHandlingEnabled(), showErrorDialog(org.kde.qt.QWidget)

setAutoErrorHandlingEnabled

public void setAutoErrorHandlingEnabled(boolean enable)

isAutoErrorHandlingEnabled

public boolean isAutoErrorHandlingEnabled()
Returns whether automatic error handling is enabled or disabled.

Returns:
true if automatic error handling is enabled
See Also:
setAutoErrorHandlingEnabled(boolean, org.kde.qt.QWidget)

setAutoWarningHandlingEnabled

public void setAutoWarningHandlingEnabled(boolean enable)
Enable or disable the automatic warning handling. When automatic warning handling is enabled and an error occurs, then a message box is displayed with the warning message The default is true. See also isAutoWarningHandlingEnabled , showErrorDialog

Parameters:
enable - enable or disable automatic warning handling
See Also:
isAutoWarningHandlingEnabled()

isAutoWarningHandlingEnabled

public boolean isAutoWarningHandlingEnabled()
Returns whether automatic warning handling is enabled or disabled. See also setAutoWarningHandlingEnabled .

Returns:
true if automatic warning handling is enabled
See Also:
setAutoWarningHandlingEnabled(boolean)

setInteractive

public void setInteractive(boolean enable)
Enable or disable the message display from the job. The default is true.

Parameters:
enable - enable or disable message display

isInteractive

public boolean isInteractive()
Returns whether message display is enabled or disabled.

Returns:
true if message display is enabled
See Also:
setInteractive(boolean)

setWindow

public void setWindow(org.kde.qt.QWidget window)
Associate this job with a window given by window.

Parameters:
window - the window to associate to
See Also:
window()

window

public org.kde.qt.QWidget window()
Returns the window this job is associated with.

Returns:
the associated window
See Also:
setWindow(org.kde.qt.QWidget)

setParentJob

public void setParentJob(Job parentJob)
Set the parent Job. One example use of this is when FileCopyJob calls open_RenameDlg, it must pass the correct progress ID of the parent CopyJob (to hide the progress dialog). You can set the parent job only once. By default a job does not have a parent job.

Parameters:
parentJob - the new parent job

parentJob

public Job parentJob()
Returns the parent job, if there is one.

Returns:
the parent job, or 0 if there is none
See Also:
setParentJob(org.kde.koala.Job)

addMetaData

public void addMetaData(java.lang.String key,
                        java.lang.String value)
Add key/value pair to the meta data that is sent to the slave.

Parameters:
key - the key of the meta data
value - the value of the meta data
See Also:
#setMetaData, #mergeMetaData

queryMetaData

public java.lang.String queryMetaData(java.lang.String key)
Query meta data received from the slave. (Valid when first data is received and/or slave is finished)

Parameters:
key - the key of the meta data to retrieve
Returns:
the value of the meta data, or null if the key does not exist

getProcessedSize

public long getProcessedSize()
Returns the processed size for this job.

See Also:
#processedSize

addSubjob

protected void addSubjob(Job job,
                         boolean inheritMetaData)
Add a job that has to be finished before a result is emitted. This has obviously to be called before the finish signal is emitted by the slave.

Parameters:
job - the subjob to add
inheritMetaData - if true, the subjob will inherit the meta data from this job.

addSubjob

protected void addSubjob(Job job)

removeSubjob

protected void removeSubjob(Job job)
Mark a sub job as being done. If it's the last to wait on the job will emit a result - jobs with two steps might want to override slotResult in order to avoid calling this method.

Parameters:
job - the subjob to add

removeSubjob

protected void removeSubjob(Job job,
                            boolean mergeMetaData,
                            boolean emitResultIfLast)
Overloaded version of removeSubjob

Parameters:
job - the subjob to remove
mergeMetaData - if set, the metadata received by the subjob is merged into this job.
emitResultIfLast - if this was the last subjob, emit result, i.e. terminate this job.

emitPercent

protected void emitPercent(long processedSize,
                           long totalSize)
Utility function for inherited jobs. Emits the percent signal if bigger than m_percent, after calculating it from the parameters.

Parameters:
processedSize - the processed size in bytes
totalSize - the total size in bytes

emitSpeed

protected void emitSpeed(long speed)
Utility function for inherited jobs. Emits the speed signal and starts the timer for removing that info

Parameters:
speed - the speed in bytes/s

emitResult

protected void emitResult()
Utility function to emit the result signal, and suicide this job. It first tells the observer to hide the progress dialog for this job.


setProcessedSize

protected void setProcessedSize(long size)
Set the processed size, does not emit processedSize


extraFlags

protected int extraFlags()

slotResult

protected void slotResult(Job job)
Called whenever a subjob finishes. Default implementation checks for errors and propagates to parent job, then calls removeSubjob. Override if you don't want subjobs errors to be propagated.

Parameters:
job - the subjob
See Also:
#result

slotSpeed

protected void slotSpeed(Job job,
                         long speed)
Forward signal from subjob.

Parameters:
job - the subjob
speed - the speed in bytes/s
See Also:
#speed

slotInfoMessage

protected void slotInfoMessage(Job job,
                               java.lang.String msg)
Forward signal from subjob.

Parameters:
job - the subjob
msg - the info message
See Also:
#infoMessage

slotSpeedTimeout

protected void slotSpeedTimeout()
Remove speed information.