JAMS Developer Guide
Agent Class Members
Properties  Methods  Events


MVPSI.JAMS Namespace : Agent Class

The following tables list the members exposed by Agent.

Public Constructors
 NameDescription
Public ConstructorDefault constructor.  
Top
Public Properties
 NameDescription
Public PropertyAccess Control List  
Public PropertyThe AgentID is a unique number used to identify an Agent.  
Public PropertyThe name of this Agent.  
Public PropertyGets the platform of Agent.  
Public PropertyGets the current state of Agent.  
Public PropertyGets the type of Agent.  
Public PropertyGets the ID of the AgentTypeName  
Public PropertyGets the type of Agent.  
Public PropertyThe AgentUid is a univerally unique number used to identify an Agent.  
Public PropertyReturns true if this agent is actually available. Will return false if the agent name can't be resolved or it the agent cannot be contacted.  
Public PropertyA description of this Agent.  
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 PropertyGets the IPHostEntry of the Agent.  
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 or sets the job limit for the agent  
Public PropertyGets or sets the job limit for the agent  
Public PropertyThe date and time that this Agent definition was last changed.  
Public PropertyUser who last changed this Agent.  
Public PropertyThe UTC date and time that this Agent definition was last changed.  
Public PropertyGets or sets the last date and time that a job started.  
Public PropertyGets or sets the last date and time that a job started.  
Public PropertyReturns true if the JAMS Scheduler has allocated a license for the agent.  
Public Property  
Public PropertyReturns the JAMS Server that this Agent was loaded from.  
Public PropertyReturns true if the agent is the machine that's running the JAMSScheduler.  
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 or sets the online state of the agent.  
Public PropertyGets the ID of the PlatformTypeName  
Public PropertyGets the Element Type name of the platform.  
Public PropertyGets or sets the port for the agent. Setting this to zero will use the default port.  
Public PropertyA collection of the dynamic PropertyValues for this instance of this object.  
Public PropertyGets a list of References to this Agent.  
Public PropertyGets or sets a certificate thumbprint associated with this agent.  
Public PropertyGets the time difference between the JAMS Scheduler and this agent  
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 the version of the JAMS agent installed on this agent  
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 MethodUpdates the Agent's properties after its Type has been changed. Properties of the old type are replaced by properties of the new type with any common values being retained.  
Public Methodstatic (Shared in Visual Basic)Check to see if a Agent is valid and the caller has the access desired.  
Public MethodClears the error message for a property. (Inherited from MVPSI.JAMS.BasePublicObject)
Public MethodOverridden. Clear the modified flag of this Agent and all of the attached lists.  
Public MethodClone the Agent  
Public MethodCompare two Agents. This compares the AgentName.  
Public MethodOverloaded. Delete the Agent definition.  
Public MethodDeploy Agent  
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 Agent exists on the default server.  
Public Methodstatic (Shared in Visual Basic)Returns a list of Agents that match the specified Agent name.  
Public MethodOverloaded. Gets a JobSecurity object that encapsulates the access control list (ACL) entries for the Job described by the current Job object.  
Public MethodInitializes the Agent to default values.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Load the Agent with the specified name from the specified JAMS Server.  
Public MethodReads Agent values from XML  
Public MethodSave the Agent with a new name and/or server.  
Public MethodApplies access control list (ACL) entries described by a AgentSecurity object to the Agent described by the current Agent 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 MethodConvert a Agent to a String  
Public MethodOverridden. Undo changes that have not been saved to the database.  
Public MethodOverloaded. Save the Agent definition on the specified JAMS Server.  
Public MethodOverloaded. Overridden. Validate all properties.  
Public MethodWrites Agent 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

Agent Class
MVPSI.JAMS Namespace