JAMS 6.x Help
Variable Class Members
Properties  Methods  Events


The following tables list the members exposed by Variable.

Public Constructors
 NameDescription
Public ConstructorVariable ConstructorCreate a new Variable.  
Top
Public Properties
 NameDescription
Public PropertyACLGets or sets the Access Control List  
Public PropertyCurrentLengthGets the length of the Variable.  
Public PropertyDataTypeGets or sets the DataType for this Variable.  
Public PropertyDescriptionGets or sets the user-defined description of this Variable.  
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 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 PropertyLastChangeGets the date and time that this Variable was last changed.  
Public PropertyLastChangedByGets the last person that changed this Variable.  
Public PropertyLastChangeUTCGets the UTC date and time that this Variable was last changed.  
Public PropertyLoadedFromGets the JAMS Server that where this Variable 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 unique name for this JAMS Variable.  
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 PropertyParentFolderGets or sets the JAMS Folder that this Variable is a member of.  
Public PropertyParentFolderIDGets the Parent Folder ID for this Variable. This property is designed to be used by JAMS, not user code.  
Public PropertyParentFolderNameGets or sets the name of the JAMS Folder that this variable is a member of.  
Public PropertyQualifiedNameReturn the full qualified name of the job.  
Public PropertyRawValueGets or sets the raw value of this variable.  
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 PropertyValueGets or sets the value of this variable.  
Public PropertyVariableIDGets the unique Variable ID. This is the primary key for this table.  
Public PropertyVariableNameGets or sets the unique name for this JAMS Variable.  
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 Methodstatic (Shared in Visual Basic)CheckChecks a Variable against a JAMS Server.  
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 MethodDeleteOverloaded. Delete the Variable definition.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodEqualsChecks for equality.  
Public Methodstatic (Shared in Visual Basic)ExistsOverloaded. Test to determine if a given Variable exists on the default server.  
Public Methodstatic (Shared in Visual Basic)ExistsInPathDetermines if a Variable can be found within the specified Folder's search path.  
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Creates and loads a new VariableList from the default JAMS Server.  
Public Methodstatic (Shared in Visual Basic)GetOverloaded. Gets the current value of a JAMS Variable.  
Public MethodGetAccessControlOverloaded. Gets a VariableSecurity object that encapsulates the access control list (ACL) entries for the Variable described by the current Variable object.  
Public MethodGetHashCodeReturns a hashcode.  
Public MethodInitializeInitializes a Variable to default values.  
Public Methodstatic (Shared in Visual Basic)LoadOverloaded. Load the Variable definition with the specified name from the current JAMS Server.  
Public MethodMoveToSave the Variable with a new name and/or server and remove the old instance of the Variable.  
Public MethodSaveAsSave this Variable with a new name and/or server  
Public Methodstatic (Shared in Visual Basic)SetOverloaded. Sets the Variable to the specified value.  
Public MethodSetAccessControlApplies access control list (ACL) entries described by a VariableSecurity object to the Variable described by the current Variable object.  
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 the string equivalent of this Variable.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverloaded. Save the Variable definition on the specified JAMS Server.  
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 MethodSaveOriginalSaveOriginal 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 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

Variable Class
MVPSI.JAMS Namespace

Send Feedback