org.openksavi.sponge.restapi.model.RestActionMeta Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016-2018 The Sponge authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openksavi.sponge.restapi.model;

import java.util.List;
import java.util.Map;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(value = "ActionMeta", description = "Represents a Sponge action metadata")
public class RestActionMeta {

    private String name;

    private String displayName;

    private String description;

    private RestKnowledgeBaseMeta knowledgeBase;

    private Map meta;

    private List argsMeta;

    private RestActionResultMeta resultMeta;

    public RestActionMeta() {
        //
    }

    public RestActionMeta(String name, String displayName, String description, RestKnowledgeBaseMeta knowledgeBase,
            Map meta, List argsMeta, RestActionResultMeta resultMeta) {
        this.name = name;
        this.displayName = displayName;
        this.description = description;
        this.knowledgeBase = knowledgeBase;
        this.meta = meta;
        this.argsMeta = argsMeta;
        this.resultMeta = resultMeta;
    }

    @ApiModelProperty(value = "The action name", required = true)
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @ApiModelProperty(value = "The action display name", required = false)
    public String getDisplayName() {
        return displayName;
    }

    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }

    @ApiModelProperty(value = "The action description", required = false)
    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    @ApiModelProperty(value = "The action knowledge base", required = true)
    public RestKnowledgeBaseMeta getKnowledgeBase() {
        return knowledgeBase;
    }

    public void setKnowledgeBase(RestKnowledgeBaseMeta knowledgeBase) {
        this.knowledgeBase = knowledgeBase;
    }

    @ApiModelProperty(value = "The action metadata", required = true)
    public Map getMeta() {
        return meta;
    }

    public void setMeta(Map meta) {
        this.meta = meta;
    }

    @ApiModelProperty(value = "The action arguments metadata", required = false)
    public List getArgsMeta() {
        return argsMeta;
    }

    public void setArgsMeta(List argsMeta) {
        this.argsMeta = argsMeta;
    }

    @ApiModelProperty(value = "The action result metadata", required = false)
    public RestActionResultMeta getResultMeta() {
        return resultMeta;
    }

    public void setResultMeta(RestActionResultMeta resultMeta) {
        this.resultMeta = resultMeta;
    }
}