adTempus API
ArcanaDevelopment.adTempus.Shared Namespace / ObjectFetchOptions Enumeration


In This Topic
    ObjectFetchOptions Enumeration
    In This Topic
    Controls how objects are fetched.
    Syntax
    'Declaration
     
    
    <FlagsAttribute()>
    Public Enum ObjectFetchOptions 
       Inherits System.Enum
    [Flags()]
    public enum ObjectFetchOptions : System.Enum 
    [Flags()]
    public enum class ObjectFetchOptions : public System.Enum 
    Members
    MemberValueDescription
    FullFetch0 The object is fully fetched, along with any objects it references.
    StubsOnly1 Only a stub of the object is fetched, with basic information.
    Remarks

    These options are used in object fetch operations (such as ArcanaDevelopment.adTempus.Client.DataContext.GetObject to determine how much detail is fetched for an object.

    When FullFetch is used, the object is fully fetched on the initial call (e.g., if you request a Job, the server also returns its steps, triggers, conditions, etc.).

    When StubsOnly, the server returns only the basic properties of the Job on the initial call, which requires that less data be read from the database and sent to the client. If you subsequently call a method or property that requires data not included in the initial stub, the client will automatically perform a full fetch on the object to return the rest of the data.

    Use StubsOnly when fetching data to be be displayed in a list, for example, and in other situations where you need only basic properties from the object.

    Inheritance Hierarchy

    System.Object
       System.ValueType
          System.Enum
             ArcanaDevelopment.adTempus.Shared.ObjectFetchOptions

    See Also