adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetObject Method / GetObject(OID) Method


In This Topic
    GetObject(OID) Method
    In This Topic
    Gets the object with the specified OID.
    Syntax
    'Declaration
     
    
    <CanBeNullAttribute()>
    Public Overloads Function GetObject( _
       ByVal oid As OID _
    ) As ADTObject
    [CanBeNull()]
    public ADTObject GetObject( 
       OID oid
    )
    [CanBeNull()]
    public:
    ADTObject^ GetObject( 
       OID^ oid
    ) 

    Parameters

    oid

    Return Value

    The requested object.
    Exceptions
    ExceptionDescription
    Thrown if the caller does not have permission for the requested object.
    Thrown if the object does not exist
    Remarks

    All fetches of an object through this DataContext (or through objects that belong to it) are guaranteed to return the same copy of the object for as long as the DataContext exists.

    This method fetches the requested object and all dependent objects. For example, fetching a Job fetches back to the client all steps, conditions, triggers, etc. In scenarios where the dependent objects are not required (for example, you only are going to be listing the job names), use GetObject(OID,ObjectFetchOptions) to fetch only a "stub" of the object on the initial fetch. This is more efficient as less data needs to be retrieved from the database and returned to the client.

    See Also