Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / viewandinspect / services / VisualizationService.java
1 /**
2  * ============LICENSE_START===================================================
3  * SPARKY (AAI UI service)
4  * ============================================================================
5  * Copyright © 2017 AT&T Intellectual Property.
6  * Copyright © 2017 Amdocs
7  * All rights reserved.
8  * ============================================================================
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  *      http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  * ============LICENSE_END=====================================================
21  *
22  * ECOMP and OpenECOMP are trademarks
23  * and service marks of AT&T Intellectual Property.
24  */
25 package org.onap.aai.sparky.viewandinspect.services;
26
27
28 import org.onap.aai.restclient.client.OperationResult;
29 import org.onap.aai.sparky.viewandinspect.entity.QueryRequest;
30
31 public interface VisualizationService {
32
33           /**
34            * Analyze query request body.
35            *
36            * @param queryRequestJson the query request json
37            * @return the query request
38            */
39
40           QueryRequest analyzeQueryRequestBody(String queryRequestJson);
41
42           /**
43            * Builds the visualization using generic query.
44            *
45            * @param queryRequest the query request
46            * @return the operation result
47            */
48           OperationResult buildVisualizationUsingGenericQuery(QueryRequest queryRequest);
49
50           void shutdown();
51
52 }