ig.scheduler.AppointmentQueryResult

Encapsulates the result returned from the ScheduleDataSource.getAppointmentsInRange method

Remarks

An implementation of the ScheduleDataSource.getAppointmentsInRange method may require asynchronous interaction with the underlying data store in order to execute the query.

In such cases, the GetAppointmentsInRange method returns synchronously, and marks the OperationResultBase.status property for the result as 'Pending'. Upon return, the caller can then register as a listener of the OperationResultBase.completed event, which occurs when the query has been fully executed.

A typical pattern for handling the result is to check the Status property, and if 'Pending' is returned, register as a listener of the Completed event, specifying a delegate to be called when the result completes. If 'Completed' is returned, as would be the case for a data source which executes the query synchronously, the caller can then directly call the Completed event handler, thus ensuring that the same action takes place regardless of whether the query is executed synchronously or asynchronously.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.dv_core.js
infragistics.dv_jquerydom.js
infragistics.dv_interactivity.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • activities
    Inherited

    .activities( );

    List of activities.

  • activities
    Inherited

    .activities( value:ig.List`1 );

    List of activities.

    • value
    • Type:ig.List`1

  • appointments

    .appointments( );

    Returns the list of appointments selected by the query.

    Remarks

    This property returns an empty list when no appointments meet the criteria specified in the activity query.

    The list is sorted primarily by the value of the ActivityBase.start property; for two appointments with the same exact start date, the are sorted by their duration (with the longer duration appearing first), and finally, by the alphabetical order of their respective subjects.

  • appointments

    .appointments( value:ig.IList`1 );

    Returns the list of appointments selected by the query.

    • value
    • Type:ig.IList`1

    Remarks

    This property returns an empty list when no appointments meet the criteria specified in the activity query.

    The list is sorted primarily by the value of the ActivityBase.start property; for two appointments with the same exact start date, the are sorted by their duration (with the longer duration appearing first), and finally, by the alphabetical order of their respective subjects.

  • completedCallback
    Inherited

    .completedCallback( );

    Returns a delegate which is called upon completion of the task associated with this result.

    Remarks

    Certain ScheduleDataSource methods return a result containing the data yielded by the associated operation.

    In cases where the operation executes asynchronously, the CompletedCallback can be used to receive a notification what the operation has completed.

    Before assigning a callback, the developer should check the value of the OperationResultBase.status property; if the status is 'Completed', the result is already available, in which case the callback is unnecessary.

  • completedCallback
    Inherited

    .completedCallback( value:function );

    Sets a delegate which is called upon completion of the task associated with this result.

    • value
    • Type:function

    Remarks

    Certain ScheduleDataSource methods return a result containing the data yielded by the associated operation.

    In cases where the operation executes asynchronously, the CompletedCallback can be used to receive a notification what the operation has completed.

    Before assigning a callback, the developer should check the value of the OperationResultBase.status property; if the status is 'Completed', the result is already available, in which case the callback is unnecessary.

  • errors
    Inherited

    .errors( );

    Returns a list of errors that were encountered during the query.

  • range
    Inherited

    .range( );
    Return Type:
    ig.scheduler.DateTimeRange
    Return Type Description:
    Returns a DateTimeRange.

    Returns the range for which the associated query was created.

    See Also

  • resources
    Inherited

    .resources( );

    Returns the owners for which the associated query was created.

  • status
    Inherited

    .status( );
    Return Type:
    ig.scheduler.OperationStatus
    Return Type Description:
    Returns a OperationStatus.

    Returns a constant which describes the current status of the operation.

    See Also

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.