jaegonkim | 6a7b524 | 2018-09-12 23:09:42 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.workflow.api; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.JsonNode; |
| 19 | import java.net.URI; |
| 20 | |
| 21 | |
| 22 | /** |
| 23 | * interface for workflow description. |
| 24 | */ |
| 25 | public interface WorkflowDescription { |
| 26 | |
| 27 | /** |
| 28 | * Workflow workplace field name. |
| 29 | */ |
| 30 | String WF_WORKPLACE = "workplace"; |
| 31 | |
| 32 | /** |
| 33 | * Workflow ID field name. |
| 34 | */ |
| 35 | String WF_ID = "id"; |
| 36 | |
| 37 | /** |
| 38 | * Workflow data field name. |
| 39 | */ |
| 40 | String WF_DATA = "data"; |
| 41 | |
| 42 | /** |
| 43 | * Gets workplace name. |
| 44 | * @return workplace name |
| 45 | */ |
| 46 | String workplaceName(); |
| 47 | |
| 48 | /** |
| 49 | * Gets workflow ID. |
| 50 | * @return workflow ID |
| 51 | */ |
| 52 | URI id(); |
| 53 | |
| 54 | /** |
| 55 | * Gets workflow context name. |
| 56 | * @return workflow context name |
| 57 | */ |
| 58 | String workflowContextName(); |
| 59 | |
| 60 | /** |
| 61 | * Gets workflow data model. |
| 62 | * @return workflow data model |
| 63 | */ |
| 64 | JsonNode data(); |
| 65 | |
| 66 | /** |
| 67 | * Gets json of workflow description. |
| 68 | * @return json of workflow description |
| 69 | */ |
| 70 | JsonNode toJson(); |
| 71 | } |