/extra/kbs/check_outs/co_206438/STABLE_geranium_lpm_cornsilk_1/dist/idl/js/toi/ToiSchedulerService.idl

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *--------------------------------------------------------------------
 *
 * ToiSchedulerService.idl
 *
 * This file was created by the Motorola IDL backend, 
 * which is based on the OmniORB IDL parser.
 * Please do not modify.
 *
 * Copyright (c) 2009 Motorola Inc. All Rights Reserved.
 *
 *--------------------------------------------------------------------
 */

#ifndef TOISCHEDULERSERVICE_IDL
#define TOISCHEDULERSERVICE_IDL

#include "TToiInvalidArgumentException.idl"
#include "TToiNotEnoughResourcesException.idl"
#include "TToiOperationNotSupportedException.idl"
#include "TToiPermissionDeniedException.idl"
#include "ToiEventTarget.idl"

//@ [Struct(Interface=IToiSchedulerService,Name=TToiSeries)]
interface ToiSchedulerServiceSeries;
//@ [Struct(Interface=IToiSchedulerService,Name=TToiBooking)]
interface ToiSchedulerServiceBooking;
//@ [Struct(Interface=IToiSchedulerService,Name=TToiSolution)]
interface ToiSchedulerServiceSolution;

//@ [EventTarget(EventObserver=IToiSchedulerObserver)]
//@ [Service(Name=SchedulerService)]
interface ToiSchedulerService : ToiEventTarget {

  
  const long ON_SCHEDULED_START = 2200;
  
  const long ON_SCHEDULED_STOP = 2201;
  
  const long ON_SCHEDULED_TRIGGER = 2202;
  
  const long ON_SCHEDULED_DISCONTINUITY = 2203;
  
  const long ON_BOOKINGS_ADDED = 2204;
  
  const long ON_BOOKINGS_REMOVED = 2205;
  
  const long ON_BOOKINGS_CHANGED = 2206;
  
  const long ON_SERIES_CHANGED = 2207;
  
  
  typedef long TToiBookingId;
  
  const TToiBookingId BOOKING_ID_NONE = 0;
  
  typedef long TToiSeriesId;
  
  const TToiSeriesId SERIES_ID_NONE = 0;
  
  typedef long TToiTime;
  
  const TToiTime TIME_NOW = -1;
  
  typedef long TToiWeekdayMask;
  
  const long WEEKDAY_MONDAY = 1;
  
  const long WEEKDAY_TUESDAY = 2;
  
  const long WEEKDAY_WEDNESDAY = 4;
  
  const long WEEKDAY_THURSDAY = 8;
  
  const long WEEKDAY_FRIDAY = 16;
  
  const long WEEKDAY_SATURDAY = 32;
  
  const long WEEKDAY_SUNDAY = 64;
  
  const long WEEKDAY_ALL_WEEKDAYS = 127;
  
  typedef sequence < TToiBookingId > TToiBookingIdSequence;
  
  typedef sequence < TToiSeriesId > TToiSeriesIdSequence;
  
  typedef sequence < ToiSchedulerServiceBooking > TToiBookingSequence;
  
  //@ [Enum]
  typedef long TToiConflictStrategy;
  
  //@ [Enumerator(Enum=TToiConflictStrategy,Name=CONFLICT_STRATEGY_FAIL)]
  const TToiConflictStrategy CONFLICT_STRATEGY_FAIL = 0;
  
  //@ [Enumerator(Enum=TToiConflictStrategy,Name=CONFLICT_STRATEGY_SKIP_BOOKINGS)]
  const TToiConflictStrategy CONFLICT_STRATEGY_SKIP_BOOKINGS = 1;
  

  //@ [Enum]
  typedef long TToiSolutionType;
  
  //@ [Enumerator(Enum=TToiSolutionType,Name=SOLUTION_TYPE_NONE)]
  const TToiSolutionType SOLUTION_TYPE_NONE = 0;
  
  //@ [Enumerator(Enum=TToiSolutionType,Name=SOLUTION_TYPE_REMOVE)]
  const TToiSolutionType SOLUTION_TYPE_REMOVE = 1;
  

  typedef sequence < ToiSchedulerServiceSolution > TToiConflictSequence;
  
  typedef long TToiDelta;
  
  typedef sequence < TToiDelta > TToiDeltaSequence;
  
  typedef sequence < string > TToiParameterNameSequence;
  
  typedef sequence < string > TToiParameterValueSequence;
  
  //@ [OutParam(Name=id,Position=5,IsBinary=0, Bound=0)]
  TToiBookingId schedule(in string category, 
        in string activity, 
        in TToiTime start, 
        in long duration)
   raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException);
  
  //@ [OutParam(Name=id,Position=8,IsBinary=0, Bound=0)]
  TToiSeriesId scheduleSeries(in string category, 
        in string activity, 
        in TToiTime start, 
        in long duration, 
        in long weekdays, 
        in long numberOfOccurrences, 
        in TToiConflictStrategy conflictStrategy)
   raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException);
  
  void reschedule(in TToiBookingId id, 
        in string category, 
        in string activity, 
        in TToiTime start, 
        in long duration)
   raises (TToiInvalidArgumentException, TToiNotEnoughResourcesException);
  
  void remove(in TToiBookingId id)
   raises (TToiInvalidArgumentException);
  
  void removeSeries(in TToiSeriesId id)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=conflicts,Position=6,IsBinary=0, Bound=0)]
  TToiConflictSequence getConflicts(in TToiBookingId id, 
        in string category, 
        in string activity, 
        in TToiTime start, 
        in long duration)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=conflicts,Position=8,IsBinary=0, Bound=0)]
  TToiConflictSequence getSeriesConflicts(in TToiSeriesId id, 
        in string category, 
        in string activity, 
        in TToiTime start, 
        in long duration, 
        in long weekdays, 
        in long occurrence)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=nextStart,Position=2,IsBinary=0, Bound=0)]
  TToiTime getNextStartTime(in string categoryExpression);
  
  //@ [OutParam(Name=booking,Position=2,IsBinary=0, Bound=0)]
  ToiSchedulerServiceBooking getBooking(in TToiBookingId id)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=series,Position=2,IsBinary=0, Bound=0)]
  ToiSchedulerServiceSeries getSeries(in TToiSeriesId id)
   raises (TToiInvalidArgumentException);
  
  //@ [ExtendIpcMessage(SoftLimit=20480)]
  
  
  //@ [OutParam(Name=bookings,Position=4,IsBinary=0, Bound=0)]
  TToiBookingIdSequence getBookingIds(in string categoryExpression, 
        in TToiTime start, 
        in TToiTime stop)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=seriesIds,Position=2,IsBinary=0, Bound=0)]
  TToiSeriesIdSequence getSeriesIds(in string categoryExpression);
  
  //@ [OutParam(Name=bookings,Position=2,IsBinary=0, Bound=0)]
  TToiBookingIdSequence getBookingIdsForSeries(in TToiSeriesId seriesId)
   raises (TToiInvalidArgumentException);
  
  void addTrigger(in TToiBookingId id, 
        in TToiDelta delta)
   raises (TToiInvalidArgumentException);
  
  void removeTrigger(in TToiBookingId id, 
        in TToiDelta delta)
   raises (TToiInvalidArgumentException);
  
  void addTriggerOnBookings(in TToiBookingIdSequence ids, 
        in TToiDelta delta)
   raises (TToiInvalidArgumentException);
  
  void removeTriggerOnBookings(in TToiBookingIdSequence ids, 
        in TToiDelta delta)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=deltas,Position=2,IsBinary=0, Bound=0)]
  TToiDeltaSequence getTriggers(in TToiBookingId id)
   raises (TToiInvalidArgumentException);
  
  void setParameter(in TToiBookingId id, 
        in string name, 
        in string value)
   raises (TToiInvalidArgumentException);
  
  void unsetParameter(in TToiBookingId id, 
        in string name)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=value,Position=3,IsBinary=0, Bound=0)]
  string getParameter(in TToiBookingId id, 
        in string name)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=names,Position=2,IsBinary=0, Bound=0)]
  TToiParameterNameSequence getParameterNames(in TToiBookingId id)
   raises (TToiInvalidArgumentException);
  
  void setParametersOnBookings(in TToiBookingIdSequence ids, 
        in TToiParameterNameSequence names, 
        in TToiParameterValueSequence values)
   raises (TToiInvalidArgumentException);
  
  void setSeriesParameter(in TToiSeriesId id, 
        in string name, 
        in string value)
   raises (TToiInvalidArgumentException);
  
  void unsetSeriesParameter(in TToiSeriesId id, 
        in string name)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=value,Position=3,IsBinary=0, Bound=0)]
  string getSeriesParameter(in TToiSeriesId id, 
        in string name)
   raises (TToiInvalidArgumentException);
  
  //@ [OutParam(Name=names,Position=2,IsBinary=0, Bound=0)]
  TToiParameterNameSequence getSeriesParameterNames(in TToiSeriesId id)
   raises (TToiInvalidArgumentException);
  
  //@ [EventFilter(AddressPosition=1)]
  
  
  void setCategorySubscription(in ToiEventListener eventListener, 
        in string categoryExpression)
   raises (TToiInvalidArgumentException);
  
};

#endif