adTempus API
ArcanaDevelopment.adTempus.Client Namespace / Job Class
Properties Methods

In This Topic
    Job Class Members
    In This Topic

    The following tables list the members exposed by Job.

    Public Properties
     NameDescription
    Public Property List of permissions that the caller has for this object (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public PropertyIf the job is on an Agent, indicates the AgentType of the Queue the job belongs to  
    Public Property Determines how the job will be handled if another instance is already running when a new instance is triggered  
    Public Property Additional data stored by an API client  
    Public Property List of tags for this job that are not displayed in the user interface  
    Public Property A semicolon-delimited list of any additional assemblies to be referenced when compiling variable functions used in this job.  
    Public Property Description property used for binding. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public PropertyOverridden.  The Class ID for the object The Class ID for the object  
    Public PropertyOverridden.  The key name for the class. The key name for the class. The key name for the class. The key name for the class.  
    Public Property Returns a descriptive name for the class suitable for display to users. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public PropertyAction to take if one or more Conditions fails  
    Public PropertyDetermines how Conditions are evaluated  
    Public Property The conditions that must be met before the job executes  
    Public PropertyCustom script used to evaluate the state of the Conditions for the job  
    Public Property The date/time the object was first saved (in UTC). (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public PropertyThe CredentialProfile representing the user account that the job will run under  
    Public PropertyThe DataContext to which this object belongs. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property Optional description or notes for the job  
    Public Property Override for the system-generated description of the object  
    Public PropertyOverridden.  Returns an extended description of the object, if appropriate Returns an extended description of the object, if appropriate  
    Public Property Indicates whether the object came from a Master. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property The fully-qualified name of the job (including the full path of the group)  
    Public PropertyThe JobGroup that the job belongs to  
    Public Property Maximum time to retain history for this job  
    Public Property Override of history retention options for this job  
    Public Property The hold type for the job  
    Public PropertyOverridden.  Indicates whether the object is a dependent of (owned by) another object Indicates whether the object is a dependent of (owned by) another object  
    Public Property Indicates whether the object is dirty (modified or new since last save). (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Property Indicates whether the object is new (has never been saved). (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Property Indicates whether this object is read-only. Indicates whether this object is read-only. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property Indicates whether the object is a stub. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public PropertyThe System.Collections.Queue that the job belongs to  
    Public PropertyReturns a JobStatus object showing the status and statistics for the job  
    Public PropertyThe job variables defined for the job  
    Public Property The date/time the object was last saved (in UTC). (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property Maximum time to retain log entries for this job  
    Public Property The user-supplied name for the job  
    Public Property A semicolon-delimited list of any additional namespaces to be included when compiling variable functions used in this job.  
    Public Property The Object Identifier that uniquely identifies the object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public PropertyGet the parent of this object.The object that owns or contains this object, if IsDependent is true. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property Specify the priority of this job within the queue  
    Public PropertyStatus information for the remote agents where this job runs, if any.  
    Public PropertyAction to take if one or more Resources for the job cannot be obtained  
    Public PropertyThe resources that must be loaded before this job runs  
    Public Property Maximum time to wait for resources to be available when running the job  
    Public PropertyThe responses that are defined for this job  
    Public Property Determines how the job is handled if it is missed or abandoned.  
    Public Property Determines if administrative privileges will be enabled when the job runs  
    Public Property Script Libraries associated with this job  
    Public PropertyDetermines how Steps will be executed  
    Public PropertyThe steps to execute for this job  
    Public Property Gets a list of the events that are supported for Responses associated with this object.  
    Public PropertyOverridden.  List of security actions supported by this object. List of security actions supported by this object.  
    Public PropertyList of ArcanaDevelopment.adTempus.Shared.SecurityInheritanceOptions supported by the object (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Property User-defined tags assigned to the job (visible in the user interface)  
    Public PropertyGets or sets the Tags as a comma-delimited string.  
    Public PropertyThe triggers that cause this job to execute  
    Public Property Determines whether the cycle ID for the current scope will be updated when this job runs  
    Public Property Determines whether the job will execute Responses inherited from the Group or Queue  
    Public Property The user interaction mode to use when running the job  
    Public Property Extension data for the customer user interface for this object  
    Public Property Extension ID of the customer user interface for this object  
    Public PropertyMaximum time (in seconds) to wait for the previous instance to complete if is ArcanaDevelopment.adTempus.Shared.AlreadyRunningBehavior.WaitThenSkip or ArcanaDevelopment.adTempus.Shared.AlreadyRunningBehavior.WaitThenRun  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.  Creates an undo snapshot for the object graph. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Method Determines whether the user has the necessary permission to perform a specified action on the object (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Method Clears the history for the job, optionally resetting the statistics for the job.  
    Public MethodOverloaded.  Commits the current changes, discarding the latest undo snapshot. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Method Deletes the object from the database. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Method Deletes the object from the database and records an entry in the object change log. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Method Creates a new object that is a copy of the source object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Method Submits the job for execution  
    Public MethodOverloaded.  Generates a configuration report for the object (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public Method Gets a user-friendly description of the object's key settings. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Method Gets the effective HoldType for the job (combining the HoldType for the job, queue, and group hierarchy).  
    Public Method Fetches the history (instances) for this job  
    Public Method Gets history (instances) and messages (job log) for the job  
    Public Method Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.  
    Public Method Gets all jobs in the chain that contains this job.  
    Public Method Fetches log messages for this job  
    Public Method Gets all objects that referenced this object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public MethodGets the SecurityDescriptor containing the security information for the object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Methodstatic (Shared in Visual Basic) Gets the response events that are supported for jobs  
    Public Method Gets the status of the job, optionally refreshing from the server  
    Public MethodGets the Independent object to which this object ultimately belongs. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public MethodGets the TriggerStatus for the job or for a specified trigger.  
    Public Method Indicates whether the job was sent to this agent from the Master  
    Public Method Refreshes the object from the server. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Method Replaces references to this object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Method Resynchronizes status data for the job.  
    Public Method Reverts the object (and any contained objects) to their last-saved state, discarding any in-memory changes. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public MethodOverloaded.  Saves the object and throws an exception if the operation fails. (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public MethodOverloaded.  Saves the object and records an entry in the object change log. Throws an exception if the operation fails (Inherited from ArcanaDevelopment.adTempus.Client.ADTIndependentObject)
    Public Method Terminates one or more instances of the job  
    Public MethodReturns a string that represents the current object. Returns a description of the object. (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public MethodOverloaded. Reverts to the previous undo snapshot created by ObjectBase.BeginEdit. (Inherited from ArcanaDevelopment.adTempus.Client.ObjectBase)
    Public Method Updates the HoldType for the Job immediately.  
    Public Method Performs server-side validation of the object (Inherited from ArcanaDevelopment.adTempus.Client.ADTObject)
    Public MethodOverridden.  Writes the object and any contained objects to a configuration report Writes the object and any contained objects to a configuration report Writes the object and any contained objects to a configuration report Writes the object and any contained objects to a configuration report  
    Top
    See Also