JAMS 6.x Help
Method Class Members
Properties  Methods  Events


The following tables list the members exposed by Method.

Public Constructors
 NameDescription
Public ConstructorMethod ConstructorCreate an new Method.  
Top
Public Properties
 NameDescription
Public PropertyApplicationThe application string that is used when creating a process.  
Public PropertyAssemblyNameThe name of the assembly that contains the routine.  
Public PropertyBadPatternA regular expression that is matched against the job's log file.  
Public PropertyCommandGets or sets the command line to send the the JAMS Agent.  
Public PropertyDescriptionGets or sets a description of this execution method.  
Public PropertyEditAfterStartWhen set to true, a Job's Source can be edited after it has started.  
Public PropertyEditAssemblyNameGets or sets name of the assembly that contains the class specified in the EditClassName property.  
Public PropertyEditClassNameGets or sets name of the class that is called to edit the source for a job that uses this execution method. This class must implement the MVPSI.JAMSExtensions.IEditJobSOurce interface.  
Public PropertyEditSourceWhen set to true, a Job's source can be edited in the submit dialog.  
Public PropertyErrorGets an error message that describes the errors in the object. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyExitCodeHandlingDefines how JAMS will evaluate the final status of a job.  
Public PropertyExtensionGets or sets the default file extension for command procedures of jobs that use this method.  
Public PropertyGoodPatternA regular expression that is matched against the job's log file.  
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 PropertyHostLocallyWhen set to true, the host process is always executed locally, the host is responsible for making the hop to the remote agent machine. This is designed to be used by hosts which implement custom agents such as the SSH host.  
Public PropertyInEditIs this object in the middle of an edit? (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyInteractiveWhen set to true, a job can interact with the desktop.  
Public PropertyItemReturns any error messages currently associated with this column. (Inherited from MVPSI.JAMS.BasePublicObject)
Public PropertyJobModuleGets or sets the name of the job module that is the starting point for parsing a jobs source.  
Public PropertyLastChangeGets the date and time that this Method was last changed.  
Public PropertyLastChangedByGets the user who last changed this Execution Method.  
Public PropertyLastChangeUTCGets the UTC date and time that this Method was last changed.  
Public PropertyLoadedFromGets the JAMS Server where this Method is stored.  
Public PropertyMethodIDGets the unique Method ID.  
Public PropertyMethodNameGets or sets the unique name for this JAMS Method.  
Public PropertyMethodTypeGets or sets the Method Type, which specifies how this method executes jobs.  
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 PropertyOptionsGets or sets a comma separated list of options. These options are specific to each method type.  
Public PropertyParametersGets the list of Parameters for this Method.  
Public PropertyParamsModifiedGets a boolean which indicates if the Parameters were modified after the Method was Loaded.  
Public PropertyProxyUserNameGets or sets the ProxyUserName of this execution method. Not implemented yet.  
Public PropertyRoutineNameGets or sets the routine that is called to run a job that uses this execution method. Routine based execution methods have not been implemented. This class must implement either the MVPSI.JAMS.Host.IJAMSHost interface or the MVPSI.JAMS.Host.IJAMSHostReports interface.  
Public PropertySingleCommandWhen set to true, the jobs source file specification is treated as a command instead of a filename. This is OpenVMS specific.  
Public PropertySnapshotSourceWhen set to true, a snapshot of the Job's source is taken at submit time and used for the Job's execution.  
Public PropertySpecificInformationalA comma separated list of specific informational values. Used when the ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Informational.  
Public PropertySpecificValuesA comma separated list of specific values. Used when the ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad.  
Public PropertySpecificWarningA comma separated list of specific warning values. Used when the ExitCodeHandling is set to SpecificValuesGood or SpecificValuesBad. Matching one of these values will result in a final severity of Warning.  
Public PropertyTemplateGets or sets the Template for this execution method.  
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 PropertyViewAssemblyNameGets or sets name of the assembly that contains the classes specified in the ViewClassName property.  
Public PropertyViewClassNameGets or sets a comma separated list of class names used to view an instance of this job. The classes can implement either the MVPSI.JAMSExtensions.IViewExecutingJob interface or the MVPSI.JAMSExtensions.IViewJobHistory interface. A class could implement both interfaces. Classes that implement IViewExecutingJob can add a tab to the Monitor Detail form. Classes that implement IViewJobHistory can add a tab to the History Detail form.  
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)CheckOverloaded. Checks a Method 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 Method 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 Method exists on the default server.  
Public Methodstatic (Shared in Visual Basic)FindOverloaded. Creates and loads a new MethodList.  
Public MethodGetHashCodeReturns a hashcode.  
Public MethodInitializeInitializes a Method to default values.  
Public Methodstatic (Shared in Visual Basic)LoadOverloaded. Load the Method with the specified name from the current JAMS Server.  
Public MethodSaveAsSave the Method 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 Method to a String.  
Public MethodUndoEditsOverridden. Undo changes that have not been saved to the database.  
Public MethodUpdateOverloaded. Save the Method 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

Method Class
MVPSI.JAMS Namespace