JAMS 6.x Help
JobRef Class Members
Properties  Methods  Events


The following tables list the members exposed by JobRef.

Public Constructors
 NameDescription
Public ConstructorJobRef ConstructorCreates a new JobRef.  
Top
Public Properties
 NameDescription
Public PropertyDescriptionGets the Description of Job Reference. This name is dependent upon the Type. It could be a Setup description, Trigger description, or Job description.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyFolderPathGet or Sets the folder path for the job reference  
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 PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyLoadedFromGets the JAMS server where this Job Reference is stored.  
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 PropertyNameGets the Name of Job Reference. This name is dependent upon the Type. It could be a Setup name, Trigger name, or Job name.  
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 PropertyReferenceIDGets the Reference ID of Job Reference. This ID is dependent upon the Type. It could be a Setup ID, Trigger ID, or Job ID.  
Public PropertyTypeGets the Type of Job Reference. Types are Setup, Event, Action, and Dependency.  
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)
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. Compares this instance to the one specified.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)FindCreates and loads a new JobRefList.  
Public MethodInitializeInitializes all JobRef properties to their default values.  
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 MethodUndoEditsOverridden. UndoEdits is not supported.  
Public MethodUpdateOverridden. Update is not supported. You cannot alter a reference.  
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 MethodSaveOriginalOverridden. SaveOriginal is not supported. References cannot be altered.  
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
See Also

Reference

JobRef Class
MVPSI.JAMS Namespace

Send Feedback