JmgTermJob_IPC Class [AX 2012]

Instances of this class represent IPC jobs. These jobs originate from the JmgIpcActivity table.

Syntax

class JmgTermJob_IPC extends JmgTermJob

Run On

Called

Methods

	Method	Description
	actOprId	Retrieves the activity ID of the IPC job. (Overrides the actOprId Method.)
	allow	Indicates whether employees can create registrations on the job. (Overrides the allow Method.)
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	createAttendanceRegistration	Creates an attendance registration on the job.
	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. (Overrides the function Method.)
	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 into memory the JmgIpcActivity record that the job is based on. (Overrides the initSourceData Method.)
	initTermRegBreak	Initializes a JmgTermReg record when a break registration is made.
	initTermRegEventCode	Initializes a JmgTermReg record when a switch code registration is made.
	initTermRegOnCall	Initializes a JmgTermReg record when an on-call registration is made.
	initTermRegWork	Initializes a JmgTermReg record when an IPC job registration is made.
	isValidJobId	This method returns whether an instance of the JmgTermJob Class is based on a valid job ID. (Inherited from JmgTermJob.)
	jmgJobTable	Retrieves the JmgJobTable record, which is associated to the job. (Inherited from JmgTermJob.)
	jobDescription	Retrieves a description of the job, which is the Description field of the JmgIpcActivity record. The job originated from this record. (Overrides the jobDescription Method.)
	jobId	This method returns the job ID which identifies this job. (Inherited from JmgTermJob.)
	jobRef	Retrieves the job reference of this job, which is the Category field of the JmgIpcActivity record. The job originates from this record. (Overrides the jobRef Method.)
	jobStatus	Retrieves the status of a job. (Inherited from JmgTermJob.)
	jourRegType	Retrieves the journal registration type that this kind of job corresponds to. (Overrides the jourRegType Method.)
	makeFeedback	This method is used to provide feedback on a started job. (Overrides the makeFeedback Method.)
	makeRegistration	This method creates a start or a stop job registration on this job. (Overrides the makeRegistration Method.)
	module	Retrieves the module that the job originated from. For IPC jobs, this is JmgModuleEnum::IPC. (Overrides the module Method.)
	new	Creates a new instance of the JmgTermJob_IPC Class. (Overrides the new Method.)
	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	Retrieves whether the job has been reported as finished. IPC jobs cannot be reported as finished. (Overrides the reportedFinish Method.)
	reportedStarted	Retrieves whether an IPC job is reported as started. An IPC job is always considered as started. (Overrides the reportedStarted Method.)
	requireFeedbackInfo	Retrieves whether more feedback information is needed when a stop registration is made. It is impossible to give feedback on an IPC job. (Overrides the requireFeedbackInfo Method.)
	requireStartupInfo	Retrieves whether additional startup information is needed. No additional registration parameters are needed for IPC jobs. (Overrides the requireStartupInfo Method.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	signType	Retrieves the type of registration that is associated with this job. (Overrides the signType Method.)
	sourceData	Retrieves the source data record that the job originated from. For IPC jobs, this is a JmgIpcActivity record. (Overrides the sourceData Method.)
	stampType	Retrieves the stamp type associated with this job. For IPC jobs, this is the value of the Type field on the JmgIpcActivity record, which is where the job originated. (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

The JmgIpcActivity table both defines IPC jobs that registrations can be made on and those that are used to perform special tasks. They include the clock-in and clock-out jobs, the start assistance and stop assistance jobs, and the stop break jobs. Registering on system jobs and on ordinary jobs is performed the same way, by using the JmgTermJob.makeRegistration Method method.

Examples

The following example makes a registration on the stop break system job for the specified employee at the current point in time.

JmgTermJob jmgTermJob; 
 
jmgTermJob = JmgTermJob::construct( 
    JmgIpcActivity::findSignTypeJobId(JmgSignInOut::StopBreak)); 
jmgTermJob.makeRegistration(jmgWorkerRecId, today(), timenow());

Inheritance Hierarchy

Object Class
  JmgTermJob Class
    JmgTermJob_IPC Class

See Also

JmgTermJob Class