JAMS Developer Guide
History Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : History Class

The following tables list the members exposed by History.

Public Constructors
 NameDescription
Public ConstructorHistory ConstructorCreates a new History.  
Top
Public Properties
 NameDescription
Public PropertyAuditTrailGets a list of audit trail events for this entry.  
Public PropertyAvgElapsedSecondsGets the Average Elapsed Time for this Job in seconds.  
Public PropertyAvgElapsedTimeGets the Average Elapsed Time for this Job.  
Public PropertyBufferedIOCount  
Public PropertyCompletionTimeGets the date and time that this Job completed.  
Public PropertyCompletionTimeUTCGets the UTC date and time that this Job completed.  
Public PropertyCpuTime  
Public PropertyDebugModeGets the debug mode for this run. True if this was a debug run. Debug runs don't satisfy dependencies or fire triggers.  
Public PropertyDirectIOCount  
Public PropertyElapsedSecondsGets the Elapsed Time for this run in seconds.  
Public PropertyElapsedTimeGets the Elapsed Time for this run.  
Public PropertyElementsA collection of elements that apply to this Job  
Public PropertyEntryTypeType of History entry. There are three types: Job, Setup, and Command Procedure.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyExecutionPriorityGets the Execution Priority  
Public PropertyFinalSeverityGets the final severity for this run.  
Public PropertyFinalStatusGets the final status for this run.  
Public PropertyFinalStatusCodeGets the final status for this run.  
Public PropertyHasErrorsThe HasErrors property can be used to determine if the object has any errors. If the object needs to be validated, it is done before returning. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyHeldGets the Held flag  
Public PropertyHistoryIDGets and sets history ID  
Public PropertyHoldTimeGets the date and time that this Job was supposed to start.  
Public PropertyHoldTimeUTCGets the UTC date and time that this Job was supposed to start.  
Public PropertyIconMessageGets the Icon message for this run.  
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyInitiatorIDGets an identifier of an object that initiated this entry. For an InitiatorType of Trigger, this is the TriggerID. For an InitiatorType of Notify, Recover, Precheck and RepeatSubmit, this is a JAMS Entry.  
Public PropertyInitiatorTypeGets the type of event that initiated this entry.  
Public PropertyInitiatorUidGets a GUID that identifies the object that initiated this entry. This is often the ElementUid of an element.  
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyJAMSEntryGets the JAMS entry number for this run of the Job.  
Public PropertyJAMSIDGets the JAMS ID for this entry.  
Public PropertyJobGets the complete Job definition.  
Public PropertyJobIDGets the Job ID.  
Public PropertyJobNameGets the job name.  
Public PropertyJobStatusGets the final value of the JobStatus text.  
Public PropertyLoadedFromGets the JAMS Server that this run is from.  
Public PropertyLogFileGets a Stream to the History entries Log File.  
Public PropertyLogFilenameGets the name of the log file for this run.  
Public PropertyMaxElapsedSecondsGets the Maximum recorded Elapsed Time for this Job in seconds.  
Public PropertyMaxElapsedTimeGets the Maximum recorded Elapsed Time for this Job.  
Public PropertyMinElapsedSecondsGets the Minimum recorded Elapsed Time for this Job in seconds.  
Public PropertyMinElapsedTimeGets the Minimum recorded Elapsed Time for this Job.  
Public PropertyModifiedThe Modified property keeps track of modified state of this object. You cannot set the Modified property. If you modify the object, the modified property will be true until you end or cancel the update. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNewObjectThe NewObject property indicates that this object has just been created and has never been saved on a JAMS Server. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyNoteGets the note added to this run when it was submitted.  
Public PropertyPageFaults  
Public PropertyParametersGets the list of Parameters for this Job.  
Public PropertyParentFolderIDGets the Parent Folder ID for this Job.  
Public PropertyParentFolderNameGets the Parent Folder Name for this Job.  
Public PropertyParentRRONGets RRON of the parent.  
Public PropertyProcessIDGets the operating system's process identifier for this run.  
Public PropertyPropertiesA collection of PropertyValues for this Job  
Public PropertyRestartCountGets the restart count for this run. It is zero for the initial run and is incremented each time the Job is restarted.  
Public PropertyRONGets the run occurance number.  
Public PropertyRRONGets the restarted run occurance number. This is a combination of the RestartCount and the MasterRON  
Public PropertyScheduledTimeGets the date and time that this Job was submitted to the JAMS schedule.  
Public PropertyScheduledTimeUTCGets the UTC date and time that this Job was submitted to the JAMS schedule.  
Public PropertySchedulingPriorityGets the Scheduling Priority  
Public PropertySourceElementsA collection of elements that make up the source code for this job  
Public PropertyStartTimeGets the date and time that this Job actually started.  
Public PropertyStartTimeUTCGets the UTCdate and time that this Job actually started.  
Public PropertyStatusImageGets the status icon.  
Public PropertySubmittedByGets the identity of the user who submitted this run.  
Public PropertyTagsThe Tags object manages the tags applied to this History.  
Public PropertyValidatedThe Validated property keeps track of the validation state of this object. If the object has been modified, Validated will be false until the object has been successfully validated by the Validate method. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyWFTrackingGets a list of workflow tracking records for this entry  
Public PropertyWorkingSetPeak  
Top
Public Methods
 NameDescription
Public MethodBeginEditStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancelEditCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedClearModified is designed to be used internally and should not be called from end-user code. Call Update() which saves the modifications and then calls ClearModified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCompareToImplementation of IComparable CompareTo. Compare this instance to the one specified.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodEqualsCompare two History object to see if they represent the same run.  
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Searches for job execution history which matches the selection criteria.  
Public MethodGetHashCodeReturn a hash code for this history entry.  
Public Methodstatic (Shared in Visual Basic)LoadLoads a history object from a job ID and a history ID on a specified server  
Public MethodSetErrorSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodSetModifiedMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodToStringString representation of a JAMS history entry.  
Public MethodUndoEditsOverridden. UndoEdits is not supported. History entries cannot be modified.  
Public MethodUpdateOverridden. Updates to History are not supported.  
Public MethodValidateThe Validate method is a virtual method used to validate the object. The default implantation does no validation it simply marks the object as valid. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Protected Methods
 NameDescription
Protected MethodRaisePropertyChangedAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodRaisePropertyChangingAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodSaveOriginalSaveOriginal is called when an edit is about to begin. You override this method to save the original values. (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Public Events
 NameDescription
Public EventPropertyChangedEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventPropertyChangingEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
Public Operators
public Operator Equality Overload the "==" operator
public Operator Greater Than Overload the ">" operator
public Operator Greater Than or Equal Overload the ">=" operator
public Operator Inequality Overload the "!=" operator
public Operator Less Than Overload the "<" operator
public Operator Less Than or Equal Overload the "<=" operator
Top
See Also

Reference

History Class
MVPSI.JAMS Namespace

 

 

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.