Share via


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
Gg770737.pubmethod(en-us,AX.60).gif actOprId This method retrieves the operation or activity ID associated with the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif allow Determines whether employees can register on the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif estimatedHours Retrieves the estimated job time. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif function Retrieves the function that is associated with the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg770737.protmethod(en-us,AX.60).gif 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.)
Gg770737.protmethod(en-us,AX.60).gif initCommon This method initializes the common fields in a JmgTermReg record, which is created when a registration is made. (Inherited from JmgTermJob.)
Gg770737.protmethod(en-us,AX.60).gif 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.)
Gg770737.pubmethod(en-us,AX.60).gif isValidJobId Checks whether this instance is based on a valid job ID. (Overrides the isValidJobId Method.)
Gg770737.pubmethod(en-us,AX.60).gif jmgJobTable Retrieves the JmgJobTable record, which is associated to the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif jobDescription This method returns a description of the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif jobId This method returns the job ID which identifies this job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif jobRef Returns the job reference of the job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif jobStatus Retrieves the status of a job. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif jourRegType Retrieves the journal registration type that this type of job corresponds to. (Overrides the jourRegType Method.)
Gg770737.pubmethod(en-us,AX.60).gif makeFeedback Creates feedback on a job that was started. (Overrides the makeFeedback Method.)
Gg770737.pubmethod(en-us,AX.60).gif makeRegistration Creates a start job registration or a stop job registration. (Overrides the makeRegistration Method.)
Gg770737.pubmethod(en-us,AX.60).gif module Retrieves the module from where the job originated. (Overrides the module Method.)
Gg770737.pubmethod(en-us,AX.60).gif new Initializes a new instance of the JmgTermJob class. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif pmfCanHaveCoProducts Indicates whether the job can have co-product outputs. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif pmfIsBatchOrderJob Indicates whether the term job belongs to the batch order. (Inherited from JmgTermJob.)
Gg770737.protmethod(en-us,AX.60).gif 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.)
Gg770737.pubmethod(en-us,AX.60).gif reportedFinish This method returns whether the job is reported as finished in Shop Floor Control. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif reportedStarted Retrieves whether the job has been reported as started. An illegal job is never started. (Overrides the reportedStarted Method.)
Gg770737.pubmethod(en-us,AX.60).gif requireFeedbackInfo Retrieves whether additional feedback is needed. Illegal jobs never require additional feedback. (Overrides the requireFeedbackInfo Method.)
Gg770737.pubmethod(en-us,AX.60).gif requireStartupInfo Retrieves whether any additional startup information is needed. For an illegal job, this is never the case. (Overrides the requireStartupInfo Method.)
Gg770737.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif signType Retrieves the type of registration associated with this job. For the illegal job, this method throws an error. (Overrides the signType Method.)
Gg770737.pubmethod(en-us,AX.60).gif 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.)
Gg770737.pubmethod(en-us,AX.60).gif stampType Retrieves the stamp type associated with this job. For an illegal job, this method throws an error. (Overrides the stampType Method.)
Gg770737.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif validateStampJournalTransWrite Validates a JmgStampJournalTrans record. (Inherited from JmgTermJob.)
Gg770737.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg770737.pubmethod(en-us,AX.60).gif 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