JAMS Developer Guide
BatchQueue Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : BatchQueue Class

The following tables list the members exposed by BatchQueue.

Public Constructors
 NameDescription
Public ConstructorCreate a new BatchQueue.  
Top
Public Properties
 NameDescription
Public PropertyAccess Control List  
Public PropertyGets or sets a descption of the queue.  
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 current count of Jobs running in the BatchQueue.  
Public PropertyGets or sets the number of Jobs that can run in this BatchQueue.  
Public PropertyGets the date and time when this BatchQueue definition was last changed.  
Public PropertyGets the user who last changed this BatchQueue.  
Public PropertyGets the UTC date and time when this BatchQueue definition was last changed.  
Public PropertyGets the JAMS Server that this Queue was loaded from.  
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 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 the ID of the queue.  
Public PropertyGets or sets the name of the Queue.  
Public PropertyGets a list of References to this Queue.  
Public PropertyGets and sets the Started property. If true the BatchQueue is started.  
Public PropertyGets the StartedOn property. This is a collection of agents where this BatchQueue runs.  
Public PropertyGets the StartedOnModified property. If true the StartedOn Queue Agent List has been modified during this edit.  
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)
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 BatchQueue against a JAMS Server.  
Public MethodClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodOverridden. Clear the modified flag of this BatchQueue and all of the attached lists.  
Public MethodImplementation of ICloneable Clone.  
Public MethodImplementation of IComparable CompareTo. Compares this instance to the one specified.  
Public MethodOverloaded. Delete the BatchQueue definition.  
Public MethodEnds an edit of this object. Any changes are saved. (Inherited from MVPSI.JAMS.BasePublicObject)
Public Methodstatic (Shared in Visual Basic)Overloaded. Test to determine if a given BatchQueue exists on the default server.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Creates and loads a new BatchQueueList.  
Public MethodOverloaded. Gets a BatchQueueSecurity object that encapsulates the access control list (ACL) entries for the batch queue described by the current BatchQueue object.  
Public MethodInitializes all properties to their default values.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Load the BatchQueue with the specified Name from the default JAMS Server.  
Public MethodReads the BatchQueue values from XML  
Public MethodSave this BatchQueue with a different name and/or server.  
Public MethodApplies access control list (ACL) entries described by a BatchQueueSecurity object to the batch queue described by the current BatchQueue 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 Methodstatic (Shared in Visual Basic)Overloaded. Starts a queue.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Stops a queue.  
Public MethodString representation of this BatchQueue.  
Public MethodOverridden. Undo changes that have not been saved to the database.  
Public MethodOverloaded. Save the BatchQueue definition on the specified JAMS Server.  
Public MethodOverloaded. Overridden. Validate all properties.  
Public MethodWrites the BatchQueue 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

BatchQueue Class
MVPSI.JAMS Namespace