JAMS 6.x Help
Param Class Members
Properties  Methods  Events


The following tables list the members exposed by Param.

Public Constructors
 NameDescription
Public ConstructorParam ConstructorCreates a new Param.  
Top
Public Properties
 NameDescription
Public PropertyAllowEntryGets or sets the 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 PropertyDataTypeGets or sets the DataType for this Parameter. Valid DataTypes for a Parameter are:
  • Text
  • Integer
  • Date
  • DateTime
  • Time
  • Boolean
  • Float
 
Public PropertyDefaultFormatGets or sets the DefaultFormat property. Parameters can be formatted many different ways before being placed in the Job which is being submitted. DefaultFormats do vary depending upon the Parameter's DataType.  
Public PropertyDefaultValueGets or sets the DefaultValue for this Parameter. 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 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 PropertyHelpTextGets or sets the HelpText indicating the purpose of this Parameter. This help is displayed to the end-user when a Job is submitted interactively.  
Public PropertyHideGets or sets the 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 PropertyJobIDGets the Job ID that this Parameter is associated with. This is for use by the JAMS system and should not be used in user-code.  
Public PropertyLastChangeGets the date and time that this Parameter was last changed.  
Public PropertyLastChangeUTCGets the UTC date and time that this Parameter was last changed.  
Public PropertyLengthGets or sets the Length of this Parameter value. Date, Time and DateTime Parameter lengths will always be 8.  
Public PropertyLoadedFromGets the JAMS server where this Parameter 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 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 PropertyParameterOriginIdentifies where this parameter originated.  
Public PropertyParamNameGets or sets the command procedure Parameter Name. This is required.  
Public PropertyParentListGets the list that this Param is contained in.  
Public PropertyPromptGets or sets the end-user Prompt for this Parameter when this Job is submitted interactively.  
Public PropertyRequiredGets or sets the Required property. If set to true, a value is required for this Parameter when the Job is submitted interactively.  
Public PropertySequenceGets the Sequence number of this Parameter.  
Public PropertyUppercaseGets or sets the Uppercase property. If set to true, the value entered for this Parameter, when the Job is submitted interactively, will be converted to Uppercase.  
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 PropertyValidationDataGets or sets the ValidationData for this Parameter. This value is used to edit or validate the parameter value.  
Public PropertyValidationTypeGets or sets the ValidationType for this Parameter which defines how the parameter value will be validated.  
Public PropertyVariableGets or sets the JAMS Variable which provides the DefaultValue for this Parameter.  
Public PropertyVariableIDGets the Variable ID for the JAMS Variable which is supplying the DefaultValue for this Parameter. This property is for use by the JAMS system, and is not designed for user code.  
Public PropertyVariableNameGets or sets the name of the Variable which will provide the DefaultValue for this Parameter.  
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 MethodCloneClone the Parameter. Clone always assumes that the new object might be saved on a different JAMS server so it doesn't copy internal information such as IDs.  
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 ParamList.  
Public Methodstatic (Shared in Visual Basic)FindFolderCreates and loads a new ParamList for System.  
Public Methodstatic (Shared in Visual Basic)FindMergedCreates and loads a new merged ParamList.  
Public Methodstatic (Shared in Visual Basic)FindMethodCreates and loads a new ParamList for a Method.  
Public MethodInitializeInitializes all Param 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 MethodToStringReturns a string representation of this Parameter.  
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

Param Class
MVPSI.JAMS Namespace