epan/dissectors/corba-idl/gias/ps.idl

   1 #ifndef PS_IDL
   2 #define PS_IDL
   3
   4 //***************************************************************
   5   //*      APPROVED via RFC N01-0268 on 6 August 2001
   6 //***************************************************************
   7
   8 //*****************************************************************
   9  // FILE:             profile.idl
  10  //
  11  //
  12  //
  13  // DESCRIPTION:      Profile Service
  14  //
  15  //    Defines the data types and interfaces needed to support search,
  16  //    retrieval and access to user, node, and system profiles.
  17  //
  18  // LIMITATIONS:
  19  //
  20  //
  21  // SOFTWARE HISTORY:
  22  //
  23  //<
  24  //***************************************************************************
  25
  26  #include "uco.idl"
  27  #include "gias.idl"
  28
  29  //***************************************************************************
  30  // MODULE: PS
  31  //>   The main module for the Profile Service
  32  //<
  33  //***************************************************************************
  34  module PS
  35  {
  36
  37 //***************************************************************
  38 //*     The Exception Identifiers for Profile Service (PS) Module
  39 //***************************************************************
  40
  41  const string UnknownProfileElementTypeConst = "UnknownProfileElementType";
  42  const string BadAccessCriteriaConst = "BadAccessCriteria";
  43  const string BadProfileElementConst = "BadProfileElement";
  44  const string BadAccessValueConst = "BadAccessValue";
  45  const string PasswordExpiredConst = "PasswordExpired";
  46  const string InvalidOrderConst = "InvalidOrder";
  47  const string InvalidQueryConst = "InvalidQuery";
  48  const string UnknownOperationConst = "UnknownOperation";
  49  const string VolumeReadAccessDeniedConst = "VolumeReadAccessDenied";
  50  const string VolumeWriteAccessDeniedConst = "VolumeWriteAccessDenied";
  51  const string FolderNotEmptyConst = "FolderNotEmpty";
  52  const string FolderExistsConst = "FolderExists";
  53  const string UnknownFolderItemTypeConst = "UnknownFolderItemType";
  54  const string UnknownVolumeConst = "UnknownVolume";
  55  const string UnknownPRIDConst = "UnknownPRID";
  56  const string PermissionDeniedConst = "PermissionDenied";
  57  const string BadFileLocationConst = "BadFileLocation";
  58  const string SystemFaultConst = "SystemFault";
  59
  60     typedef string ProfileElementType;
  61
  62     typedef sequence <ProfileElementType> ProfileElementTypeList;
  63
  64     //***
  65     // Forward References
  66     //***
  67     interface ProfileMgr;
  68     interface Profile;
  69     interface ProfileElement;
  70
  71     //***
  72     // Forward References to the specific ProfileElements
  73     //***
  74     interface BasicProfile;
  75     interface GIASProfile;
  76     interface SecureProfile;
  77     interface SecureViewProfile;
  78
  79     //**************************************************************************
  80     // INTERFACE: ProfileMgr
  81     //>  The ProfileMgr provides access control to Profile objects
  82     //<
  83     //**************************************************************************
  84     interface ProfileMgr
  85     {
  86        Profile get_profile(in UCO::NameValueList access_criteria)
  87           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
  88        //> Returns the Profile for the user identified in access_criteria.
  89        //<
  90
  91        string get_version()
  92                 raises (UCO::ProcessingFault, UCO::SystemFault);
  93        //> Returns the version of this Profile manager.
  94        //<
  95
  96        void set_user_password
  97                         (in UCO::NameValueList access_criteria,
  98                         in string new_password)
  99                                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 100
 101     };
 102
 103  //**************************************************************************
 104     // INTERFACE: Profile
 105     //> The Profile object provides access to the contents of a Profile
 106     //  by serving as a container for ProfileElement objects of different types.
 107     //<
 108     //**************************************************************************
 109     interface Profile
 110     {
 111        ProfileElementTypeList get_profile_element_types()
 112                         raises (UCO::ProcessingFault, UCO::SystemFault);
 113
 114        //> Returns a list of all ProfileElementTypes contained in this Profile.
 115        //<
 116
 117        ProfileElement     get_profile_element(in ProfileElementType element_type)
 118           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 119        //> Returns the ProfileElement of the specified type.
 120        //<
 121
 122        SecureProfile      get_secure_profile_element
 123                              (in UCO::NameValueList  trusted_access_criteria)
 124           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 125        //> This operation returns the secure profile element that contains
 126        //  user security information that does not change across views.
 127        //  The trusted access criteria limits the availability of this
 128        //  information.  If the access criteria does not contain expected names,
 129        //  the operation will return a BadAccessCriteria exception identifier.  If the access
 130        //  criteria does not contain expected values, the operation will return a
 131        //  BadAccessValue exception identifier.
 132        //<
 133
 134        SecureViewProfile  get_secure_view_profile_element
 135                              (in UCO::NameValueList  trusted_access_criteria,
 136                               in GIAS::ViewName      view)
 137           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 138        //> This method returns the secure profile element that contains
 139        //  user security information that is view specific.  The
 140        //  trusted access criteria limits the availability of this
 141        //  information.  If the access criteria does not contain expected names,
 142        //  the operation will return a BadAccessCriteria exception identifier.  If the access
 143        //  criteria does not contain expected values, the operation will return a
 144        //  BadAccessValue exception identifier.
 145        //<
 146
 147        UCO::AbsTime       get_last_update_time()
 148                 raises (UCO::ProcessingFault, UCO::SystemFault);
 149        //> Returns the time the Profile was last changed.
 150        //<
 151
 152        void               get_profiled_views(out UCO::NameList view_list)
 153                 raises (UCO::ProcessingFault, UCO::SystemFault);
 154        //> Returns a list of views that are valid for a particular profile
 155        //<
 156
 157     };
 158
 159
 160     //**************************************************************************
 161     // INTERFACE ProfileElement
 162     //> The ProfileElement object serves as the base abstract class for all
 163     //  types of content objects in a Profile. It contains operations common to
 164     //  all types of ProfileElement objects.
 165     //<
 166     //**************************************************************************
 167     interface ProfileElement
 168     {
 169        UCO::AbsTime get_last_update_time()
 170                 raises (UCO::ProcessingFault, UCO::SystemFault);
 171        //> Returns the time this ProfileElement was last changed.
 172        //<
 173     };
 174
 175
 176     //**************************************************************************
 177     // INTERFACE: BasicProfile
 178     //
 179     //> The BasicProfile object is a specialization of the ProfileElement
 180     //  object to support all types of users. It contains operations and
 181     //  types common to all types of users.
 182     //<
 183     //**************************************************************************
 184     interface BasicProfile : ProfileElement
 185     {
 186
 187         struct TelephoneNumber
 188         {
 189           string name;
 190           string number;
 191         };
 192
 193        typedef sequence<TelephoneNumber> TelephoneNumberList;
 194
 195        struct UserInformation
 196        {
 197           string              name;
 198           string              organization;
 199           string              address;
 200           string              city;
 201           string              state;
 202           string              zip;
 203           string              country;
 204           string              email;
 205           TelephoneNumberList phone_numbers;
 206           UCO::FileLocation   ftp_location;
 207                  UCO::AbsTime       password_expiration;
 208
 209        };
 210
 211        struct UserPreference
 212        {
 213           string  name;
 214           string  value;
 215           boolean editable;
 216           string  description;
 217        };
 218
 219        typedef sequence<UserPreference> UserPreferenceList;
 220
 221
 222        typedef sequence<string> PreferenceNameList;
 223
 224        struct UserPreferenceDomain
 225        {
 226           GIAS::Domain adomain;
 227           boolean      multi_select;
 228        };
 229
 230        struct SecurityInformation
 231        {
 232           string  classification;
 233           boolean security_administrator_flag;
 234        };
 235
 236        void get_user_information      (out UserInformation     info)
 237                 raises (UCO::ProcessingFault, UCO::SystemFault);
 238
 239        void set_user_information      (in  UserInformation     info)
 240                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 241
 242        void get_security_information  (out SecurityInformation info)
 243                 raises (UCO::ProcessingFault, UCO::SystemFault);
 244
 245        void get_available_preferences (out PreferenceNameList  names)
 246                 raises (UCO::ProcessingFault, UCO::SystemFault);
 247
 248        void get_preference_domain     (in  string              preference_name,
 249                                        out GIAS::Domain        domain)
 250                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 251
 252        void get_user_preference       (in  string              preference_name,
 253                                        out UserPreference      preference)
 254                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 255
 256        void get_user_preferences      (out UserPreferenceList  list)
 257                 raises (UCO::ProcessingFault, UCO::SystemFault);
 258
 259        void set_user_preference       (in  UserPreference      preference)
 260                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 261
 262        void set_user_preferences      (in  UserPreferenceList  preferences)
 263                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 264
 265     };
 266
 267     //**************************************************************************
 268     // INTERFACE: SecureProfile
 269     //
 270     //> The SecureProfile object is a specialization of the ProfileElement
 271     //  object to support basic security information access.
 272     //<
 273     //**************************************************************************
 274     interface SecureProfile : ProfileElement
 275     {
 276        //***
 277        // Authorization Information
 278        //***
 279
 280        struct Authorization
 281        {
 282           string         authorization_classification;
 283           UCO::NameList  exception_country_list;
 284           UCO::NameList  releasable_country_list;
 285           UCO::NameList  releasable_org_list;
 286           UCO::NameList  distribution_limit_code_list;
 287           UCO::NameList  access_agreement_list;
 288           UCO::NameList  compartment_list;
 289        };
 290        //> This data structure holds the elements that constitute
 291        //  a discretionary access authorization for the user.
 292        //<
 293
 294        void    get_authorization
 295                    (out Authorization     aauthorization)
 296                 raises (UCO::ProcessingFault, UCO::SystemFault);
 297        //> This operation returns the authorization information.
 298        //<
 299
 300        void    get_authorization_classification
 301                    (out string            classification)
 302                 raises (UCO::ProcessingFault, UCO::SystemFault);
 303        //> This operation returns a user's authorization classification level.
 304        //<
 305
 306        void    get_exception_by_countries
 307                    (out UCO::NameList     country_list)
 308                 raises (UCO::ProcessingFault, UCO::SystemFault);
 309
 310        //> This operation returns the exception by country list.
 311        //<
 312
 313        void    get_releasable_countries
 314                    (out UCO::NameList     country_list)
 315                 raises (UCO::ProcessingFault, UCO::SystemFault);
 316
 317        //> This operation returns the releasable country list.
 318        //<
 319
 320        void    get_releasable_organizations
 321                    (out UCO::NameList     organization_list)
 322                 raises (UCO::ProcessingFault, UCO::SystemFault);
 323
 324        //> This operation returns the releasable organization list.
 325        //<
 326
 327        void    get_distribution_limitation_codes
 328                    (out UCO::NameList     code_list)
 329                 raises (UCO::ProcessingFault, UCO::SystemFault);
 330
 331        //> This operation returns the distribution limitation code list.
 332        //<
 333
 334        void    get_access_agreements
 335                    (out UCO::NameList     agreement_list)
 336                 raises (UCO::ProcessingFault, UCO::SystemFault);
 337
 338        //> This operation returns the access agreement list.
 339        //<
 340
 341        void    get_compartments
 342                    (out UCO::NameList     compartment_list)
 343                 raises (UCO::ProcessingFault, UCO::SystemFault);
 344
 345        //> This operation returns the compartment list for the user.
 346        //<
 347
 348        //***
 349        // Attribute/entity Restriction Information
 350        //***
 351
 352        enum  AccessType {READ_DENIED, WRITE_DENIED};
 353
 354        void  get_restricted_attributes
 355                  (in  AccessType    access_type,
 356                   out UCO::NameList attribute_list)
 357                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 358        //> This operation returns the restricted attribute identifiers
 359        //  for the user relative to a specific view.
 360        //<
 361
 362        void  get_restricted_entities
 363                  (in  AccessType    access_type,
 364                   out UCO::NameList entity_list)
 365                 raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 366        //> This operation returns the restricted entity identifiers
 367        //  for the user relative to a specific view.
 368        //<
 369
 370
 371     };
 372
 373     //**************************************************************************
 374     // INTERFACE: SecureViewProfile
 375     //
 376     //> The SecureViewProfile object is a specialization of the SecureProfile
 377     //  object to support view-oriented security information access.
 378     //<
 379     //**************************************************************************
 380     interface SecureViewProfile : SecureProfile
 381     {
 382        //***
 383        // Authorization Information
 384        //***
 385
 386        boolean use_authorization()
 387                 raises (UCO::ProcessingFault, UCO::SystemFault);
 388
 389        //> This operation returns a true indication if the authorizaton
 390        //  is to be used for discretionary access control for
 391        //  the specified view.
 392        //<
 393
 394
 395        //***
 396        // Attribute Value Restriction Information
 397        //***
 398
 399        void  get_restricted_attribute_values
 400                  (out string        restriction)
 401                 raises (UCO::ProcessingFault, UCO::SystemFault);
 402        //> This operation returns the restricted attribute value
 403        //  string for the user relative to a specific view.
 404        //<
 405     };
 406
 407
 408     //**************************************************************************
 409     // INTERFACE: GIASProfile
 410     //
 411     //> The GIASProfile object is a specialization of the ProfileElement
 412     //  object to support users of GIAS Libraries. It contains methods and
 413     //  types specific to GIAS libraries operations.
 414     //<
 415     //**************************************************************************
 416     interface GIASProfile : ProfileElement
 417     {
 418
 419
 420        //***
 421        // Defines a profile id used to uniquely identify objects within the
 422        // user profile
 423        //***
 424        typedef string          PRID;
 425        typedef sequence <PRID> PRIDList;
 426
 427        void get_allowable_operations(out UCO::NameList operation_list)
 428                 raises (UCO::ProcessingFault, UCO::SystemFault);
 429        //> This operation returns a list of the allowable operations for
 430        //  a particular user.
 431        //<
 432
 433        boolean operation_is_allowed (in string operation)
 434            raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 435        //> This operation returns TRUE if the specified manager is
 436        //  accessible by the user, otherwise FALSE is returned.
 437        //<
 438
 439        typedef string                   FolderTree;
 440        // string defined as: \folder1\folder2\folder3\etc...
 441        //   An empty string or '\' denotes the root folder.
 442
 443        struct FolderLocation
 444        {
 445           string      volume;
 446           FolderTree  folder;
 447        };
 448
 449        struct VolumeInfo
 450        {
 451           boolean            default_volume;
 452           string             volume;
 453           boolean            read_permission;
 454           boolean            write_permission;
 455           boolean            create_delete_permission;
 456        };
 457
 458        typedef    sequence < VolumeInfo > VolumeInfoList;
 459        typedef    sequence < FolderLocation> FolderLocationList;
 460
 461        enum  FolderItemType
 462        {
 463           SAVED_QUERY,
 464           SUBMITTED_QUERY,
 465           SUBMITTED_QUERY_AND_HIT_COUNT,
 466           STANDING_QUERY,
 467           SAVED_ORDER,
 468           SUBMITTED_ORDER,
 469           STANDING_ORDER,
 470           SUBMITTED_CREATE,
 471             SUBMITTED_HIT_COUNT,
 472           RESULTS_DIGEST,
 473           SESSION,
 474           ALL
 475        };
 476
 477        struct FolderItem
 478        {
 479           PRID                item_id;
 480           FolderLocation      location;
 481           string              name;
 482           string              description;
 483           FolderItemType      type;
 484           UCO::AbsTime        creation_time;
 485           UCO::AbsTime        last_accessed_time;
 486           UCO::AbsTime        last_modified_time;
 487           string              owner_name;
 488           string              user_created_name;
 489           string              user_last_accessed_name;
 490           string              user_last_modified_name;
 491           UCO::Rectangle      area_of_interest_mbr;
 492        };
 493
 494        typedef sequence < FolderItem >   FolderItemList;
 495
 496        //***
 497        // FolderItem holds one of the following:
 498        //   SubmittedQuery
 499        //   SubmittedQueryAndHitCount
 500        //   SubmittedOrder
 501        //   SubmittedCreate
 502        //   StandingQuery
 503        //   StandingOrder
 504        //   SavedQuery
 505        //   SavedOrder
 506        //   ResultsDigest
 507        //   SavedSession
 508        //***
 509        typedef any FolderContent;
 510        typedef sequence <FolderContent> FolderContentList;
 511
 512        enum SearchDepth
 513        {
 514           SINGLE_FOLDER,
 515           FOLDER_TREE
 516        };
 517
 518        //***
 519        // Return a list of available volumes
 520        //***
 521        void list_volumes(
 522              out VolumeInfoList volume_list)
 523                 raises (UCO::ProcessingFault, UCO::SystemFault);
 524
 525        //***
 526        // Creates a new folder in the location specified
 527        //***
 528        void new_folder (
 529              in FolderLocation folder)
 530           raises (
 531  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 532
 533        //***
 534        // Moves a folder's location
 535        //***
 536        void update_folder (
 537              in FolderLocation folder,
 538              in FolderLocation new_location)
 539           raises (
 540  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 541
 542        //***
 543        // Removes an empty folder
 544        //***
 545        void remove_folder (
 546              in FolderLocation folder)
 547           raises (
 548  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 549
 550        //***
 551        // Return a list of folders in a specific folder
 552        //***
 553        void list_folders (
 554              in  FolderLocation      folder,
 555              out FolderLocationList  query_items)
 556           raises (
 557  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 558
 559        //***
 560        // Update a specific folder item in the profile
 561        //***
 562        void update_folder_item (
 563              in PRID             item_id,
 564              in FolderLocation   location,
 565              in string           name,
 566              in string           description,
 567              in UCO::Rectangle   area_of_interest_mbr)
 568           raises (
 569  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 570
 571        //***
 572        // Returns the contents of a folder item
 573        // N.B. Some folder item types may override this operation.
 574        //***
 575        void get_entry (
 576              in  PRID             item_id,
 577              out FolderContent    entry)
 578           raises (
 579  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 580
 581        //***
 582        // Removes a folder item
 583        //***
 584        void remove_entry (
 585              in  PRID             item_id)
 586           raises (
 587  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 588
 589        //***
 590        // Returns a list of folder contents of a given type.
 591        // Can search just in a given folder or recursively search the folder
 592        // tree starting at a given folder location.
 593        // N.B. This call may not be useful for some folder item types.
 594        //***
 595        void list_entries (
 596              in  FolderItemType   type,
 597              in  FolderLocation   starting_point,
 598              in  SearchDepth      depth,
 599              out FolderContentList entries)
 600           raises (
 601  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 602
 603        //***
 604        // Returns a list of folder information for a given folder item type.
 605        // Can search just in a given folder or recursively search the folder
 606        // tree starting at a given folder location.
 607        //***
 608        void list_entry_items (
 609              in  FolderItemType   type,
 610              in  FolderLocation   starting_point,
 611              in  SearchDepth      depth,
 612              out FolderItemList   entry_items)
 613           raises (
 614  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 615
 616
 617        //***********************************************************************
 618        // Submitted Queries
 619        //
 620        //> These are queries that have been submitted to a Library, but the
 621        //  client has not yet completed the retrieval of the query results.
 622        //  This is useful when queries are time-consuming.
 623        //<
 624        //***********************************************************************
 625        struct SubmittedQuery
 626        {
 627           FolderItem                       item_info;
 628           GIAS::SubmitQueryRequest         request;
 629        };
 630        typedef sequence<SubmittedQuery> SubmittedQueryList;
 631
 632
 633 //***********************************************************************
 634        // Submitted Queries and Hit Count
 635        //
 636        //> These are queries that have been submitted to a Library, but the
 637        //  client has not yet completed the retrieval of the query results.
 638        //  This is useful when queries are time-consuming.
 639        //<
 640        //***********************************************************************
 641        struct SubmittedQueryAndHitCount
 642        {
 643           FolderItem                       item_info;
 644           GIAS::SubmitQueryRequest         request;
 645             GIAS::RequestList                    hit_count_requests;
 646        };
 647        typedef sequence<SubmittedQueryAndHitCount> SubmittedQueryAndHitCountList;
 648
 649        PRID new_submitted_query (
 650              in FolderLocation             folder,
 651              in string                     name,
 652              in string                     description,
 653              in UCO::Rectangle             area_of_interest_mbr,
 654              in GIAS::SubmitQueryRequest   request)
 655           raises (
 656  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 657
 658         PRID new_submitted_query_and_hitcount (
 659             in FolderLocation             folder,
 660             in string                     name,
 661             in string                     description,
 662             in UCO::Rectangle             area_of_interest_mbr,
 663             in GIAS::SubmitQueryRequest   request,
 664                 in GIAS::RequestList             hit_count_requests)
 665          raises ( UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 666
 667
 668 struct SubmittedHitCount
 669       {
 670          FolderItem                       item_info;
 671          GIAS::HitCountRequest            request;
 672       };
 673       typedef sequence<SubmittedHitCount> SubmittedHitCountList;
 674
 675
 676
 677
 678  PRID new_submitted_hitcount (
 679              in FolderLocation             folder,
 680              in string                     name,
 681              in string                     description,
 682              in UCO::Rectangle             area_of_interest_mbr,
 683              in GIAS::HitCountRequest      request)
 684           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 685        //***********************************************************************
 686        // Submitted Orders
 687        //
 688        //> These are orders that have been submitted to a Library, but the
 689        //  user has not yet deleted.  A user may need to keep orders around
 690        //  if they take a long time to complete.
 691        //<
 692        //***********************************************************************
 693        struct SubmittedOrder
 694        {
 695           FolderItem                       item_info;
 696           GIAS::OrderRequest               request;
 697        };
 698        typedef sequence<SubmittedOrder> SubmittedOrderList;
 699
 700        PRID new_submitted_order(
 701              in FolderLocation     folder,
 702              in string             name,
 703              in string             description,
 704              in UCO::Rectangle     area_of_interest_mbr,
 705              in GIAS::OrderRequest order)
 706           raises (
 707  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 708
 709        //***********************************************************************
 710        // Submitted Creates
 711        //
 712        //> These are creates that have been submitted to a Library, but the
 713        //  user has not yet deleted.  A user may need to keep these around
 714        //  if they take a long time to complete.
 715        //<
 716        //***********************************************************************
 717        struct SubmittedCreate
 718        {
 719           FolderItem                       item_info;
 720           GIAS::CreateRequest              request;
 721        };
 722        typedef sequence<SubmittedCreate> SubmittedCreateList;
 723
 724        PRID new_submitted_create(
 725              in FolderLocation      folder,
 726              in string              name,
 727              in string              description,
 728              in UCO::Rectangle      area_of_interest_mbr,
 729              in GIAS::CreateRequest create_request)
 730           raises (
 731  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 732
 733
 734        //***********************************************************************
 735        // Standing Queries
 736        //
 737        //> These are queries that get executed on a scheduled basis.  The client
 738        //  needs to be able to access the query request at any time.
 739        //<
 740        //***********************************************************************
 741        struct StandingQuery
 742        {
 743           FolderItem                       item_info;
 744           GIAS::SubmitStandingQueryRequest request;
 745        };
 746
 747        typedef sequence <StandingQuery>  StandingQueryList;
 748
 749        PRID new_standing_query (
 750              in FolderLocation                    folder,
 751              in string                            name,
 752              in string                            description,
 753              in UCO::Rectangle                    area_of_interest_mbr,
 754              in GIAS::SubmitStandingQueryRequest  request)
 755           raises (
 756  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 757
 758
 759        //***********************************************************************
 760        // Standing Orders
 761        //
 762        //> These are orders that get executed on a scheduled basis.  The client
 763        //  needs to be able to access the order request at any time.
 764        //<
 765        //***********************************************************************
 766        struct StandingOrder
 767        {
 768           FolderItem                       item_info;
 769   GIAS::QueryOrderContents                         order;
 770           GIAS::SubmitStandingQueryRequest query;
 771        };
 772
 773        typedef sequence <StandingOrder>  StandingOrderList;
 774
 775        PRID new_standing_order(
 776              in FolderLocation                   folder,
 777              in string                           name,
 778              in string                           description,
 779              in GIAS::QueryOrderContents                         order,
 780              in UCO::Rectangle                   area_of_interest_mbr,
 781              in GIAS::SubmitStandingQueryRequest query)
 782           raises (UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 783
 784
 785        //***********************************************************************
 786        // Saved Queries
 787        //
 788        //>
 789        //<
 790        //***********************************************************************
 791        struct SavedQuery
 792        {
 793           FolderItem        item_info;
 794           GIAS::Query       bqs;
 795           UCO::FileLocation thumbnail_location;
 796           boolean           browse_image_returned_flag;
 797           UCO::NameList     result_attributes;
 798           GIAS::SortAttributeList     sort_attributes;
 799           string            geographic_datum;
 800           UCO::AbsTime      last_submitted_date;
 801        };
 802
 803        typedef sequence < SavedQuery >  SavedQueryList;
 804
 805
 806
 807        //***
 808        // Save the query information to the specified folder.
 809        //***
 810        PRID new_saved_query (
 811              in FolderLocation          folder,
 812              in string                  name,
 813              in string                  description,
 814              in GIAS::Query             bqs,
 815              in boolean                 browse_image_returned_flag,
 816              in UCO::NameList           result_attributes,
 817                      in GIAS::SortAttributeList     sort_attributes,
 818              in string                  geographic_datum,
 819              in UCO::AbsTime            last_submitted_date,
 820              in UCO::Rectangle          area_of_interest_mbr)
 821   raises ( UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 822
 823        //***
 824        // Update a specified query from the profile
 825        //***
 826        void update_saved_query (
 827              in PRID               saved_query_id,
 828              in string             name,
 829              in string             description,
 830              in GIAS::Query        bqs,
 831              in boolean            browse_image_returned_flag,
 832              in UCO::NameList      result_attributes,
 833              in GIAS::SortAttributeList     sort_attributes,
 834              in string             geographic_datum,
 835              in UCO::AbsTime       last_submitted_date,
 836              in UCO::Rectangle     area_of_interest_mbr)
 837           raises (
 838  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 839
 840
 841
 842
 843        //***********************************************************************
 844        // Saved Orders
 845        //
 846        //>
 847        //<
 848        //***********************************************************************
 849        struct SavedOrder
 850        {
 851           FolderItem    item_info;
 852              GIAS::OrderContents      order;
 853        };
 854
 855        typedef sequence < SavedOrder > SavedOrderList;
 856
 857        PRID new_saved_order (
 858              in FolderLocation   folder,
 859              in string           name,
 860              in string           description,
 861              in UCO::Rectangle   area_of_interest_mbr,
 862              in GIAS::OrderContents         order)
 863           raises (
 864  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 865
 866        void update_saved_order(
 867              in PRID             saved_order_id,
 868              in string           name,
 869              in string           description,
 870              in UCO::Rectangle   area_of_interest_mbr,
 871              in GIAS::OrderContents         order)
 872           raises (
 873  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 874
 875
 876        //***********************************************************************
 877        // Results Digests
 878        //
 879        //>
 880        //<
 881        //***********************************************************************
 882        struct ResultsDigest
 883        {
 884           FolderItem     item_info;
 885        };
 886
 887        typedef sequence < ResultsDigest >  ResultsDigestList;
 888
 889        //***
 890        // Save the results digest to the specified folder... the
 891        // server will ftp get the digest from the specified file
 892        // location.
 893        //***
 894        PRID new_results_digest (
 895              in FolderLocation    folder,
 896              in string            name,
 897              in string            description,
 898              in UCO::Rectangle    area_of_interest_mbr,
 899              in UCO::FileLocation digest_location)
 900           raises (
 901  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 902
 903        //***
 904        // Update the specified results digest in the profile
 905        //***
 906        void update_results_digest(
 907              in PRID               results_digest_id,
 908              in string             name,
 909              in string             description,
 910              in UCO::Rectangle     area_of_interest_mbr,
 911              in UCO::FileLocation  digest_location)
 912           raises (
 913  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 914
 915        //***
 916        // Get the results digest for the specified ID... the server
 917        // will ftp put the digest to the specified file location.
 918        //***
 919        void get_results_digest (
 920              in PRID              query_id,
 921              in UCO::FileLocation destination_file)
 922           raises (
 923  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 924
 925
 926        //***********************************************************************
 927        // Saved Sessions
 928        //
 929        //>
 930        //<
 931        //***********************************************************************
 932        struct SavedSession
 933        {
 934           FolderItem      item_info;
 935           string          session_text;
 936        };
 937
 938        typedef sequence < SavedSession >  SavedSessionList;
 939
 940        //***
 941        // Save the session to the specified folder... the
 942        // server will ftp get the session from the specified file
 943        // location.
 944        // ***
 945        PRID new_saved_session (
 946              in FolderLocation        folder,
 947              in string                name,
 948              in string                description,
 949              in UCO::Rectangle        area_of_interest_mbr,
 950              in UCO::FileLocation     session_location)
 951           raises (
 952  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 953
 954        //***
 955        // Update the specified saved session in the profile
 956        //***
 957        void update_saved_session(
 958              in PRID              saved_session_id,
 959              in string            name,
 960              in string            description,
 961              in UCO::Rectangle    area_of_interest_mbr,
 962              in UCO::FileLocation session_location)
 963           raises (
 964  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 965
 966        //***
 967        // Get the saved session for the specified ID... the server
 968        // will ftp put the session to the specified file location.
 969        //***
 970        void get_saved_session (
 971              in PRID               query_id,
 972              in UCO::FileLocation destination_file)
 973           raises (
 974  UCO::InvalidInputParameter, UCO::ProcessingFault, UCO::SystemFault);
 975
 976     }; // end interface GIASProfile
 977
 978  };
 979 #endif