JAMS Developer Guide
Variable Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : Variable Class

The following tables list the members exposed by Variable.

Public Constructors
 NameDescription
Public ConstructorCreate a new Variable.  
Top
Public Properties
 NameDescription
Public PropertyGets or sets the Access Control List  
Public PropertyGets the length of the Variable.  
Public PropertyGets or sets the DataType for this Variable.  
Public PropertyGets or sets the user-defined description of this Variable.  
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 PropertyIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyGets the date and time that this Variable was last changed.  
Public PropertyGets the last person that changed this Variable.  
Public PropertyGets the UTC date and time that this Variable was last changed.  
Public PropertyGets the JAMS Server that where this Variable 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 the unique name for this JAMS Variable.  
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 PropertyGets or sets the JAMS Folder that this Variable is a member of.  
Public PropertyGets the Parent Folder ID for this Variable. This property is designed to be used by JAMS, not user code.  
Public PropertyGets or sets the name of the JAMS Folder that this variable is a member of.  
Public PropertyGets the fully qualified name of the folder that contains this variable.  
Public PropertyReturn the full qualified name of the job.  
Public PropertyGets or sets the raw value of this variable.  
Public PropertyGets a list of References to this Variable.  
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 value of this variable.  
Public PropertyGets the unique Variable ID. This is the primary key for this table.  
Public PropertyGets or sets the unique name for this JAMS Variable.  
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 Methodstatic (Shared in Visual Basic)Checks a Variable against a JAMS Server.  
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 MethodImplementation of ICloneable Clone.  
Public MethodImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodOverloaded. Delete the Variable definition.  
Public MethodEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodChecks for equality.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Test to determine if a given Variable exists on the default server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Creates and loads a new VariableList from the default JAMS Server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the current value of a JAMS Variable.  
Public MethodOverloaded. Gets a VariableSecurity object that encapsulates the access control list (ACL) entries for the Variable described by the current Variable object.  
Public MethodReturns a hashcode.  
Public MethodInitializes a Variable to default values.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Load the Variable definition with the specified name from the current JAMS Server.  
Public MethodSave the Variable with a new name and/or server and remove the old instance of the Variable.  
Public MethodReads the variable values from XML.  
Public MethodSave this Variable with a new name and/or server  
Public Methodstatic (Shared in Visual Basic)Overloaded. Sets the Variable to the specified value.  
Public MethodApplies access control list (ACL) entries described by a VariableSecurity object to the Variable described by the current Variable object.  
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 the string equivalent of this Variable.  
Public MethodOverridden. Undo changes that have not been saved to the database.  
Public MethodOverloaded. Save the Variable definition on the specified JAMS Server.  
Public MethodOverloaded. Overridden. Validate all properties.  
Public MethodWrites the variable values to XML.  
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 MethodSaveOriginal 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 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

Variable Class
MVPSI.JAMS Namespace