SchedulerContext Class

Quartz.NET 3.0 API Documentation
Holds context/environment data that can be made available to Jobs as they are executed.
Inheritance Hierarchy

SystemObject
  Quartz.UtilDirtyFlagMapString, Object
    Quartz.UtilStringKeyDirtyFlagMap
      QuartzSchedulerContext

Namespace:  Quartz
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
[SerializableAttribute]
public class SchedulerContext : StringKeyDirtyFlagMap

The SchedulerContext type exposes the following members.

Constructors

  NameDescription
Public methodSchedulerContext
Create an empty JobDataMap.
Public methodSchedulerContext(IDictionaryString, Object)
Create a JobDataMap with the given data.
Protected methodSchedulerContext(SerializationInfo, StreamingContext)
Serialization constructor.
Top
Properties

  NameDescription
Public propertyCount
When implemented by a class, gets the number of elements contained in the ICollection.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyDirty
Determine whether the IDictionary is flagged dirty.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyIsEmpty
Gets a value indicating whether this instance is empty.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyIsFixedSize
When implemented by a class, gets a value indicating whether the IDictionary has a fixed size.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyIsReadOnly
When implemented by a class, gets a value indicating whether the IDictionary is read-only.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyIsSynchronized
When implemented by a class, gets a value indicating whether access to the ICollection is synchronized (thread-safe).
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyItem
Gets or sets the Object with the specified key.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyKeys
When implemented by a class, gets an ICollection containing the keys of the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertySyncRoot
When implemented by a class, gets an object that can be used to synchronize access to the ICollection.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyValues
When implemented by a class, gets an ICollection containing the values in the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public propertyWrappedMap
Get a direct handle to the underlying Map.
(Inherited from DirtyFlagMapTKey, TValue.)
Top
Methods

  NameDescription
Public methodAdd(KeyValuePairTKey, TValue) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodAdd(Object, Object) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodAdd(TKey, TValue)
When implemented by a class, adds an element with the provided key and value to the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodClear
When implemented by a class, removes all elements from the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodClearDirtyFlag
Clear the 'dirty' flag (set dirty flag to ).
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodContains(KeyValuePairTKey, TValue) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodContains(Object) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodContainsKey
When implemented by a class, determines whether the IDictionary contains an element with the specified key.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodContainsValue
Determines whether the specified obj contains value.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodCopyTo(Array, Int32)
When implemented by a class, copies the elements of the ICollection to an Array, starting at a particular Array index.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodCopyTo(KeyValuePairTKey, TValue, Int32) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodEntrySet
Gets the entries as a set.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from StringKeyDirtyFlagMap.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGet
Gets the value behind the specified key.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodGetBoolean
Retrieve the identified Boolean value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetChar
Retrieve the identified Char value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetDateTime
Retrieve the identified DateTime value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetDateTimeOffset
Retrieve the identified DateTimeOffset value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetDouble
Retrieve the identified Double value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetEnumerator
When implemented by a class, returns an IDictionaryEnumerator for the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodGetFloat
Retrieve the identified Single value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetHashCode
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetInt
Retrieve the identified Int32 value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetKeys
Gets the keys.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetLong
Retrieve the identified Int64 value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetObjectData (Inherited from DirtyFlagMapTKey, TValue.)
Public methodGetString
Retrieve the identified String value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetTimeSpan
Retrieve the identified TimeSpan value from the JobDataMap.
(Inherited from StringKeyDirtyFlagMap.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodKeySet
Gets keyset for this map.
(Inherited from DirtyFlagMapTKey, TValue.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPut(TKey, TValue)
Puts the value behind a specified key.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodPut(String, Boolean)
Adds the given Boolean value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, Char)
Adds the given Char value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, Double)
Adds the given Double value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, Int32)
Adds the given Int32 value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, Int64)
Adds the given Int64 value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, Single)
Adds the given Single value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPut(String, String)
Adds the given String value to the IJob's data map.
(Inherited from StringKeyDirtyFlagMap.)
Public methodPutAll
Adds the name-value pairs in the given IDictionary to the JobDataMap.

All keys must be Strings, and all values must be serializable.

(Inherited from StringKeyDirtyFlagMap.)
Public methodRemove(KeyValuePairTKey, TValue) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodRemove(Object) (Inherited from DirtyFlagMapTKey, TValue.)
Public methodRemove(TKey)
When implemented by a class, removes the element with the specified key from the IDictionary.
(Inherited from DirtyFlagMapTKey, TValue.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetValue (Inherited from DirtyFlagMapTKey, TValue.)
Top
Remarks

Future versions of Quartz may make distinctions on how it propagates data in SchedulerContext between instances of proxies to a single scheduler instance - i.e. if Quartz is being used via WCF of Remoting.
See Also

Reference