com.sap.scheduler.runtime

Class JobDefinitionID

java.lang.Object
  com.sap.scheduler.runtime.AbstractIdentifier
      com.sap.scheduler.runtime.JobDefinitionID

All Implemented Interfaces:

Serializable, Cloneable

public final class JobDefinitionID
extends AbstractIdentifier

Uniquely identifies a Job instance. This class is XML Serializable and can be used for a web service parameter. The public constructor of this class is intended to be used only by serialization deserialization framework. This is basically a XML-serializable equivalent of the GUID class, however it has the semantics of identifying a given job instance.

See Also:

GUID, AbstractIdentifier, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sap.scheduler.runtime.AbstractIdentifier

AbstractIdentifier.ConcreteInstanceFactory

Field Summary

Fields inherited from class com.sap.scheduler.runtime.AbstractIdentifier

serialVersionUID

Constructor Summary

JobDefinitionID()
Deprecated. This constructor is intended to be used only by XML serialization/deserializtion. In order to create new instances of this class use one of the static methods

Method Summary

static JobDefinitionID	newID() Creates a new JobDefinitionID instance that represent a new guid.
static JobDefinitionID	parseID(byte[] byteGUID) Reconstructs a JobDefinitionID instance from a byte[] representation of a guid.
static JobDefinitionID	parseID(String stringGUID) Reconstructs a JobDefinitionID instance from a string representation.

Methods inherited from class com.sap.scheduler.runtime.AbstractIdentifier

clone, equals, getBytes, hashCode, parseID, parseID, setBytes, setBytesNoCloneAndCheck, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobDefinitionID

public JobDefinitionID()

Deprecated. This constructor is intended to be used only by XML serialization/deserializtion. In order to create new instances of this class use one of the static methods

This constructor is intended only for XML serialization/deserialization. Do not use it for creating instances of JobDefinitionID use one of the newID static methods. When created with this constructor this identity object identifies no job. In order to give it identity the method setBytes() must be called.

Method Detail

newID

public static JobDefinitionID newID()

Creates a new JobDefinitionID instance that represent a new guid.

Returns:

a new JobDefinitionID instance

See Also:

GUID

parseID

public static JobDefinitionID parseID(String stringGUID)
                               throws IllegalArgumentException

Reconstructs a JobDefinitionID instance from a string representation. The supplied a String must be in a valid GUID hex-string format.

Parameters:

stringGUID - - a hex representation of a GUID. If this paramter is null then this method returns null.

Returns:

a JobDefinitionID holding the identity specified by the given string representation of GUID. Null if stringGUID is null.

Throws:

IllegalArgumentException - - if the string is not a valid hex-string representation of a GUID.

See Also:

GUID.toHexString()

parseID

public static JobDefinitionID parseID(byte[] byteGUID)
                               throws IllegalArgumentException

Reconstructs a JobDefinitionID instance from a byte[] representation of a guid. The supplied byte[] must be in a valid GUID format.

Parameters:

byteGUID - - a byte[] representation of a guid. If this parameter is null then this method returns null.

Returns:

a JobDefinitionID holding the identity specified by the given byte array representation of a GUID. Null if byteGUID is null.

Throws:

IllegalArgumentException - - thrown if the byteGUID argument is not a valid GUID byte representation

See Also:

GUID.toBytes()