JAMS 6.x Help
Agent Class Members
Properties  Methods  Events


The following tables list the members exposed by Agent.

Public Constructors
 NameDescription
Public ConstructorAgent ConstructorDefault constructor.  
Top
Public Properties
 NameDescription
Public PropertyAgentIDThe AgentID is a unique number used to identify an Agent.  
Public PropertyAgentNameThe name of this Agent.  
Public PropertyAgentStateGets the current state of Agent.  
Public PropertyAgentTypeGets the type of Agent.  
Public PropertyDescriptionA description of this Agent.  
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 or sets the job limit for the agent  
Public PropertyJobLimitGets or sets the job limit for the agent  
Public PropertyLastChangeThe date and time that this Agent definition was last changed.  
Public PropertyLastChangedByUser who last changed this Agent.  
Public PropertyLastChangeUTCThe UTC date and time that this Agent definition was last changed.  
Public PropertyLicenseAllocatedReturns true if the JAMS Scheduler has allocated a license for the agent.  
Public PropertyLoadedFromReturns the JAMS Server that this Agent was loaded from.  
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 PropertyOnlineGets or sets the online state of the agent.  
Public PropertyPlatformGets the Platform of this Agent.  
Public PropertyPortGets or sets the port for the agent. Setting this to zero will use the default port.  
Public PropertyTimeOffsetGets the time difference between the JAMS Scheduler and this agent  
Public PropertyUsernameGets or sets the JAMS User definition to be used to deploy the agent.  
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)CheckCheck to see if a Agent is valid and the caller has the access desired.  
Public MethodClearErrorClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodClearModifiedOverridden. Clear the modified flag of this Agent and all of the attached lists.  
Public MethodCloneClone the Agent  
Public MethodCompareToCompare two Agents. This compares the AgentName.  
Public MethodDeleteOverloaded. Delete the Agent definition.  
Public MethodDeployDeploy Agent  
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 Agent exists on the default server.  
Public Methodstatic (Shared in Visual Basic)FindReturns a list of Agents that match the specified Agent name.  
Public MethodInitializeInitializes the Agent to default values.  
Public Methodstatic (Shared in Visual Basic)LoadOverloaded. Load the Agent with the specified name from the specified JAMS Server.  
Public MethodSaveAsSave the Agent with a new 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 MethodToStringConvert a Agent to a String  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverloaded. Save the Agent 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

Agent Class
MVPSI.JAMS Namespace

Send Feedback