JAMS Developer Guide
Param Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : Param Class

The following tables list the members exposed by Param.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyGets 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 PropertyGets or sets the DataType for this Parameter. Valid DataTypes for a Parameter are:
  • Text
  • Integer
  • Date
  • DateTime
  • Time
  • Boolean
  • Float
 
Public PropertyGets 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 PropertyGets or sets the DefaultValue for this Parameter. This value will be supplied to the Job when it is submitted.  
Public PropertyGets a description of this parameter.  
Public PropertyGets the internal ID of this element.  
Public PropertyGets the ElementKind of this element. This cannot be modified, it is defined in the ElementType.  
Public PropertySynonymous with ParamName.  
Public PropertyGets the ElementState of this element.  
Public PropertyGets or sets the ID of the element type for this element.  
Public PropertyGets or sets the name of the element type for this element.  
Public PropertyGet or sets the internal GUID of this element.  
Public PropertyGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyThe 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 PropertyGets 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 PropertyGets 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 PropertyIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyReturns true if the Element was inherited from a folder above the current object.  
Public PropertyReturns the ID of the object that we inherited from.  
Public PropertyReturns the name of the object that we inherited from.  
Public PropertyReturns type of object that we inherited from.  
Public PropertyReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyGets or sets the Length of this Parameter value. Date, Time and DateTime Parameter lengths will always be 8.  
Public PropertyGets the JAMS server where this Parameter is stored.  
Public PropertyThe 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 PropertyGets 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 PropertyThe 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 PropertyIdentifies where this parameter originated.  
Public PropertyThe ParamID is used internally to uniquely identify a parameter  
Public PropertyGets or sets the command procedure Parameter Name. This is required.  
Public PropertyThe ParamID is used internally to uniquely identify a parameter  
Public PropertyGets the list that this Param is contained in.  
Public PropertyGets or sets the end-user Prompt for this Parameter when this Job is submitted interactively.  
Public PropertyGets a collection of property values.  
Public PropertyGets or sets the Required property. If set to true, a value is required for this Parameter when the Job is submitted interactively.  
Public PropertyGets the Sequence number of this Parameter.  
Public PropertyGets 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 PropertyThe 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 PropertyGets or sets the ValidationData for this Parameter. This value is used to edit or validate the parameter value.  
Public PropertyGets or sets the ValidationType for this Parameter which defines how the parameter value will be validated.  
Public PropertyGets or sets the JAMS Variable which provides the DefaultValue for this Parameter.  
Public PropertyGets 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 PropertyGets or sets the name of the Variable which will provide the DefaultValue for this Parameter.  
Public PropertyGets 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 MethodStarts an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodCancels an edit of this object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModified 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 MethodClone 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 MethodImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public Methodstatic (Shared in Visual Basic)Returns a new Param  
Public MethodEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodInitializes all Param properties to their default values.  
Public MethodSets the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodMarks the object as modified. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodReturns a string representation of this Parameter.  
Public MethodOverridden. Undo changes that have not been saved to the database.  
Public MethodOverridden. Save pending updates.  
Public MethodOverloaded. Overridden. Validate all properties.  
Top
Protected Methods
 NameDescription
Protected MethodAttempts to raise the PropertyChanged event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodAttempts to raise the PropertyChanging event (Inherited from MVPSI.JAMS.BasePublicObject)
Protected MethodOverridden. Save the original values incase we have to Undo.  
Top
Public Events
 NameDescription
Public EventEvent Handler for Property Changed Event (Inherited from MVPSI.JAMS.BasePublicObject)
Public EventEvent Handler for Property Changing Event (Inherited from MVPSI.JAMS.BasePublicObject)
Top
See Also

Reference

Param Class
MVPSI.JAMS Namespace