IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.jxfsds.wosamsd
Class JxfsServiceJob

java.lang.Object
  extended bycom.ibm.dse.jxfsds.wosamsd.JxfsServiceJob
All Implemented Interfaces:
com.jxfs.forum.support.IJxfsServiceJob

public abstract class JxfsServiceJob
extends java.lang.Object
implements com.jxfs.forum.support.IJxfsServiceJob

This class provides implementation of basic functionality for IJxfsServiceJob.

Version:
J/XFS 1.0

Field Summary
static java.lang.String JXFS_COPYRIGHT
          String containing the copyright for this class.
static java.lang.String JXFS_VERSION_CONTROL
          String containing version information for this class.
 
Constructor Summary
JxfsServiceJob(int controlId, int operationId)
          JxfsServiceJob constructor.
 
Method Summary
 int getControlId()
          Gets the Id of the Device Control this job belongs to.
 int getIdentificationID()
          Gets the identificationID of the asynchronous operation this job is performing.
protected abstract  java.lang.String getLogOrigin()
          Get the log origin String for the service using this class.
 int getOperationID()
          Gets the operationID that represents this kind of operation.
 void setIdentificationID(int id)
          Sets the identificationID which is received from the IDFactory class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.jxfs.forum.support.IJxfsServiceJob
cancel, execute
 

Field Detail

JXFS_VERSION_CONTROL

public static final java.lang.String JXFS_VERSION_CONTROL
String containing version information for this class. This String holds the following values :

See Also:
Constant Field Values

JXFS_COPYRIGHT

public static final java.lang.String JXFS_COPYRIGHT
String containing the copyright for this class.

See Also:
Constant Field Values
Constructor Detail

JxfsServiceJob

public JxfsServiceJob(int controlId,
                      int operationId)
JxfsServiceJob constructor.

Parameters:
controlId - Control id for this job.
operationId - for this kind of job.
Method Detail

getControlId

public int getControlId()
Gets the Id of the Device Control this job belongs to.

Specified by:
getControlId in interface com.jxfs.forum.support.IJxfsServiceJob
Returns:
Integer containing the controlId.

getIdentificationID

public int getIdentificationID()
Gets the identificationID of the asynchronous operation this job is performing.

Specified by:
getIdentificationID in interface com.jxfs.forum.support.IJxfsServiceJob
Returns:
Integer containing the identification ID.

getLogOrigin

protected abstract java.lang.String getLogOrigin()
Get the log origin String for the service using this class.

Returns:
String identifying the service in trace/log entries.

getOperationID

public int getOperationID()
Gets the operationID that represents this kind of operation.

Specified by:
getOperationID in interface com.jxfs.forum.support.IJxfsServiceJob
Returns:
Integer containing the operationID.

setIdentificationID

public void setIdentificationID(int id)
                         throws com.jxfs.events.JxfsException
Sets the identificationID which is received from the IDFactory class. This property can only be set once.

Specified by:
setIdentificationID in interface com.jxfs.forum.support.IJxfsServiceJob
Parameters:
id - Integer containing the identification id.
Throws:
com.jxfs.events.JxfsException - JXFS_E_PARAMETER_INVALID - invalid parameter,
JXFS_E_EXISTS - the identificationID is already set.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005