JmgTermJob_illegal Class [AX 2012]

The T:JmgTermJob_illegal class checks whether the input job ID is valid.

Syntax

class JmgTermJob_illegal extends JmgTermJob

Run On

Called

Methods

	Method	Description
	actOprId	This method retrieves the operation or activity ID associated with the job. (Inherited from JmgTermJob.)
	allow	Determines whether employees can register on the job. (Inherited from JmgTermJob.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	estimatedHours	Retrieves the estimated job time. (Inherited from JmgTermJob.)
	function	Retrieves the function that is associated with the job. (Inherited from JmgTermJob.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	init	Part of the initialization procedure of an instance. The method is called by the JmgTermJob::construct Method and JmgTermJob::constructJobTable Method. (Inherited from JmgTermJob.)
	initCommon	This method initializes the common fields in a JmgTermReg record, which is created when a registration is made. (Inherited from JmgTermJob.)
	initSourceData	Loads the job-based source data into memory. For illegal jobs, no data record is loaded. This method is part of the initialization procedure of an instance. (Overrides the initSourceData Method.)
	isValidJobId	Checks whether this instance is based on a valid job ID. (Overrides the isValidJobId Method.)
	jmgJobTable	Retrieves the JmgJobTable record, which is associated to the job. (Inherited from JmgTermJob.)
	jobDescription	This method returns a description of the job. (Inherited from JmgTermJob.)
	jobId	This method returns the job ID which identifies this job. (Inherited from JmgTermJob.)
	jobRef	Returns the job reference of the job. (Inherited from JmgTermJob.)
	jobStatus	Retrieves the status of a job. (Inherited from JmgTermJob.)
	jourRegType	Retrieves the journal registration type that this type of job corresponds to. (Overrides the jourRegType Method.)
	makeFeedback	Creates feedback on a job that was started. (Overrides the makeFeedback Method.)
	makeRegistration	Creates a start job registration or a stop job registration. (Overrides the makeRegistration Method.)
	module	Retrieves the module from where the job originated. (Overrides the module Method.)
	new	Initializes a new instance of the JmgTermJob class. (Inherited from JmgTermJob.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pmfCanHaveCoProducts	Indicates whether the job can have co-product outputs. (Inherited from JmgTermJob.)
	pmfIsBatchOrderJob	Indicates whether the term job belongs to the batch order. (Inherited from JmgTermJob.)
	registrationError	This method is invoked if an error occurs when a registration on the job is created. It throws an error that has the specified error message. If special handling of registration errors is necessary for a specific type of job, this method should be overridden. (Inherited from JmgTermJob.)
	reportedFinish	This method returns whether the job is reported as finished in Shop Floor Control. (Inherited from JmgTermJob.)
	reportedStarted	Retrieves whether the job has been reported as started. An illegal job is never started. (Overrides the reportedStarted Method.)
	requireFeedbackInfo	Retrieves whether additional feedback is needed. Illegal jobs never require additional feedback. (Overrides the requireFeedbackInfo Method.)
	requireStartupInfo	Retrieves whether any additional startup information is needed. For an illegal job, this is never the case. (Overrides the requireStartupInfo Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	signType	Retrieves the type of registration associated with this job. For the illegal job, this method throws an error. (Overrides the signType Method.)
	sourceData	Provides access to the source data record from where the job originated. An invalid job is not based on any source records. (Overrides the sourceData Method.)
	stampType	Retrieves the stamp type associated with this job. For an illegal job, this method throws an error. (Overrides the stampType Method.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	validateStampJournalTransWrite	Validates a JmgStampJournalTrans record. (Inherited from JmgTermJob.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

Instances of this class represent illegal jobs. That is, if either the JmgTermJob::construct method or the JmgTermJob::constructJobTable method is invoked by using an invalid job ID, an instance of this class is returned.

Examples

The following example checks if the input job ID is valid; if it is invalid, an error is thrown.

public void checkInputJobId(JmgJobId _input) 
{ 
    JmgTermJob jmgTermJob = JmgTermJob::construct(_input); 
    if (!jmgTermJob.isValidJobId()) 
    { 
        throw error(_input + " is an illegal job id"); 
    } 
}

Inheritance Hierarchy

Object Class
  JmgTermJob Class
    JmgTermJob_illegal Class

See Also

JmgTermJob Class