com.primavera.integration.common

Class JobId

java.lang.Object

com.primavera.common.value.ObjectId

com.primavera.integration.common.JobId

All Implemented Interfaces:

Externalizable, Serializable, Comparable<ObjectId>

public class JobId
extends ObjectId

ID of a server-side asynchronous job (such as a scheduling job). This ID can be used to retrieve the status of the job from the Job Manager

See Also:

Serialized Form

Field Summary

Fields inherited from class com.primavera.common.value.ObjectId

SECURITY_OVERRIDE_WBSCONTEXT_ID, USESSION_OVERRIDE_ID

Constructor Summary

Constructors

Constructor and Description
JobId() Constructs an empty JobId object.
JobId(ObjectId objId, int iJobType) Class constructor specifying object ID of the job and the job type

Method Summary

Modifier and Type	Method and Description
int	getJobType() Gets the type of job associated with this ID
void	readExternal(ObjectInput ois) Implementation of the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	writeExternal(ObjectOutput oos) Implementation of the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class com.primavera.common.value.ObjectId

addPrimaryKeyObject, compareTo, equals, fromString, getPrimaryKeyDate, getPrimaryKeyObject, getPrimaryKeyObjects, getPrimaryKeyValue, hashCode, isMultiPartKey, toInteger, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobId

public JobId()

Constructs an empty JobId object. Must use the addPrimaryKeyObject() method to populate

JobId

public JobId(ObjectId objId,
             int iJobType)

Class constructor specifying object ID of the job and the job type

Parameters:

objId - object id of job

iJobType - the type of job

Method Detail

getJobType

public int getJobType()

Gets the type of job associated with this ID

Returns:

int the type of job. See JobProperties for possible values

writeExternal

public void writeExternal(ObjectOutput oos)
                   throws IOException

Implementation of the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ObjectId

Parameters:

oos - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur

readExternal

public void readExternal(ObjectInput ois)
                  throws ClassNotFoundException,
                         IOException

Implementation of the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ObjectId

Parameters:

ois - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.