JAMS 6.x Help
SetupJobParam Class Members
Properties  Methods  Events


The following tables list the members exposed by SetupJobParam.

Public Constructors
 NameDescription
Public ConstructorSetupJobParam ConstructorCreate a new SetupJobParam.  
Top
Public Properties
 NameDescription
Public PropertyAllowEntryGets or sets the override AllowEntry property. If set to true, the end-user will be able to enter a value for this Parameter, when the Job is submitted interactively.  
Public PropertyDefaultValueGets or sets the override Default Value. This value will be supplied to the Job when it is submitted.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyGlobalNameGets or Sets the Global Name for this parameter. Global names simplify parameter gathering at submit-time.  
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 PropertyHideGets or sets the override Hide property. If set to true, this Parameter will not be displayed to the end-user when the Job is submitted interactively.  
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 PropertyJobParameterGets or sets the Job Parameter that this Setup Job Parameter is overriding.  
Public PropertyLastChangeGets the date and time that this Setup Job Param was last changed.  
Public PropertyLastChangeUTCGets the UTC date and time that this Setup Job Param was last changed.  
Public PropertyLoadedFromGets the JAMS server where this Param 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 PropertyMustFillGets or sets the override MustFill property. If set to true, the value entered for this Parameter, when the Job is submitted interactively, must be the same length as the Length property.  
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 PropertyOverriddenGets the Overridden property which returns true if this Parameter has been overriden.  
Public PropertyOverridenThis property name was misspelled in early versions of JAMS. The misspelled propery is still provides for backwards compatablity, it returns the value of the Overridden property.  
Public PropertyParamNameGets the command procedure Parameter Name.  
Public PropertyParentListGets the list that this object is contained in.  
Public PropertyPromptGets or sets the override end-user prompt which is used when this Job is submitted interactively.  
Public PropertyRequiredGets or sets the override Required property. If set to true, a value is required for this Parameter when the Job is submitted interactively.  
Public PropertySequenceGets this Parameter's sequence.  
Public PropertySubmitPromptGets the end-user prompt which is used when this Job is submitted interactively.  
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 PropertyVariableGets or sets the override Variable which provides the default value.  
Public PropertyVariableIDGets the override Variable ID which provides the default value.  
Public PropertyVariableNameGets the override Variable Name which provides the default value.  
Public PropertyVariableNameIsRelativeGets or Sets the "Variable Name Is Relative" property. If set to true, it means the VariableName is a relative path. Otherwise, VariableName is an absolute path.  
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 MethodCloneImplementation of ICloneable Clone.  
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 SetupJobParamList.  
Public MethodInitializeInitializes all 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 MethodToStringUse this method to retrieve a string representation of this Setup Job Paramater.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverridden. Save pending updates.  
Public MethodValidateOverloaded. Overridden. Validate all properties.  
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. Save the original values incase we have to Undo.  
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

SetupJobParam Class
MVPSI.JAMS Namespace

Send Feedback