JAMS 6.x Help
BatchQueue Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by BatchQueue.

Public Constructors
 NameDescription
Public ConstructorBatchQueue ConstructorCreate a new BatchQueue.  
Top
Protected Fields
 NameDescription
Protected Fieldm_DescriptionQueue Description (Inherited from MVPSI.JAMS.Queue)
Protected Fieldm_QueueIDQueue ID (Inherited from MVPSI.JAMS.Queue)
Protected Fieldm_QueueNameQueue Name (Inherited from MVPSI.JAMS.Queue)
Top
Public Properties
 NameDescription
Public PropertyDescriptionGets or sets a descption of the queue. (Inherited from MVPSI.JAMS.Queue)
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 PropertyJobCountGets the current count of Jobs running in the BatchQueue.  
Public PropertyJobLimitGets or sets the number of Jobs that can run in this BatchQueue.  
Public PropertyLastChangeGets the date and time when this BatchQueue definition was last changed.  
Public PropertyLastChangedByGets the user who last changed this BatchQueue.  
Public PropertyLastChangeUTCGets the UTC date and time when this BatchQueue definition was last changed.  
Public PropertyLoadedFromGets the JAMS Server that this Queue was loaded from. (Inherited from MVPSI.JAMS.Queue)
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 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 PropertyQueueIDGets the ID of the queue. (Inherited from MVPSI.JAMS.Queue)
Public PropertyQueueNameGets or sets the name of the Queue. (Inherited from MVPSI.JAMS.Queue)
Public PropertyStartedGets and sets the Started property. If true the BatchQueue is started.  
Public PropertyStartedOnGets the StartedOn property. This is a collection of nodes where this BatchQueue runs.  
Public PropertyStartedOnModifiedGets the StartedOnModified property. If true the StartedOn Queue Node List has been modified during this edit.  
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)
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 BatchQueue against a JAMS Server.  
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedOverridden. Clear the modified flag of this BatchQueue and all of the attached lists.  
Public MethodCloneImplementation of ICloneable Clone.  
Public MethodCompareToImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodDeleteOverloaded. Delete the BatchQueue definition.  
Public MethodEndEditEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)ExistsOverloaded. Test to determine if a given BatchQueue exists on the default server.  
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Creates and loads a new BatchQueueList.  
Public MethodInitializeInitializes all properties to their default values.  
Public Methodstatic (Shared in Visual Basic)LoadOverloaded. Load the BatchQueue with the specified Name from the default JAMS Server.  
Public MethodSaveAsSave this BatchQueue with a different name and/or server.  
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 Methodstatic (Shared in Visual Basic)StartOverloaded. Starts a queue.  
Public Methodstatic (Shared in Visual Basic)StopOverloaded. Stops a queue.  
Public MethodToStringString representation of this BatchQueue.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverloaded. Save the BatchQueue definition on the specified JAMS Server.  
Public MethodValidateOverloaded. Overridden. Validate all properties.  
Top
Protected Methods
 NameDescription
Protected MethodGetMyServerReturns the JAMS Server. (Inherited from MVPSI.JAMS.Queue)
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

BatchQueue Class
MVPSI.JAMS Namespace

Send Feedback