001package org.hl7.fhir.utilities.graphql;
002
003import java.util.List;
004
005/*
006  Copyright (c) 2011+, HL7, Inc.
007  All rights reserved.
008  
009  Redistribution and use in source and binary forms, with or without modification, 
010  are permitted provided that the following conditions are met:
011    
012   * Redistributions of source code must retain the above copyright notice, this 
013     list of conditions and the following disclaimer.
014   * Redistributions in binary form must reproduce the above copyright notice, 
015     this list of conditions and the following disclaimer in the documentation 
016     and/or other materials provided with the distribution.
017   * Neither the name of HL7 nor the names of its contributors may be used to 
018     endorse or promote products derived from this software without specific 
019     prior written permission.
020  
021  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
022  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
023  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
024  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
025  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
026  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
027  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
028  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
029  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
030  POSSIBILITY OF SUCH DAMAGE.
031  
032 */
033
034
035import org.hl7.fhir.exceptions.FHIRException;
036import org.hl7.fhir.instance.model.api.IBaseBundle;
037import org.hl7.fhir.instance.model.api.IBaseReference;
038import org.hl7.fhir.instance.model.api.IBaseResource;
039
040public interface IGraphQLStorageServices {
041
042  /**
043   * given a reference inside a context, return what it references (including resolving internal references (e.g. start with #)
044   */
045  ReferenceResolution lookup(Object appInfo, IBaseResource context, IBaseReference reference) throws FHIRException;
046
047  /**
048   * just get the identified resource
049   */
050  IBaseResource lookup(Object appInfo, String type, String id) throws FHIRException;
051
052  /**
053   * list the matching resources. searchParams are the standard search params.
054   * this instanceof different to search because the server returns all matching resources, or an error. There instanceof no paging on this search
055   */
056  void listResources(Object appInfo, String type, List<Argument> searchParams, List<IBaseResource> matches) throws FHIRException;
057
058  /**
059   * just perform a standard search, and return the bundle as you return to the client
060   */
061  IBaseBundle search(Object appInfo, String type, List<Argument> searchParams) throws FHIRException;
062
063  class ReferenceResolution {
064    private IBaseResource targetContext;
065    private IBaseResource target;
066
067    public ReferenceResolution(IBaseResource targetContext, IBaseResource target) {
068      super();
069      this.targetContext = targetContext;
070      this.target = target;
071    }
072
073    public IBaseResource getTargetContext() {
074      return targetContext;
075    }
076
077    public IBaseResource getTarget() {
078      return target;
079    }
080
081
082  }
083}