/*
 * Copyright 2017 Red Hat Inc.
 *
 * 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 io.enmasse.address.model.types;

import java.util.Optional;

/**
 * Represents an EnMasse Plan
 */
public interface Plan {
    /**
     * Get the CLI-friendly name of the plan.
     *
     * @return The name
     */
    String getName();

    /**
     * Get the human-friendly name of the plan (used in the GUI).
     *
     * @return The display name
     */
    String getDisplayName();

    /**
     * Get a longer description of the plan.
     *
     * @return A textual description
     */
    String getDescription();

    /**
     * Get the UUID of this plan.
     *
     * @return the uuid
     */
    String getUuid();

    /**
     * Get template config for this plan if it has one.
     *
     * @return the template config wrapped in an Optional
     */
    Optional<TemplateConfig> getTemplateConfig();
}

/*
 * Copyright 2017 Red Hat Inc.
 *
 * 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 io.enmasse.address.model.types;

import java.util.Optional;

/**
 * Represents an EnMasse Plan
 */
public interface Plan {
    /**
     * Get the CLI-friendly name of the plan.
     *
     * @return The name
     */
    String getName();

    /**
     * Get the human-friendly name of the plan.
     *
     * @return The display name
     */
    String getDisplayName();

    /**
     * Get a longer description of the plan.
     *
     * @return A textual description
     */
    String getDescription();

    /**
     * Get the UUID of this plan.
     *
     * @return the uuid
     */
    String getUuid();

    /**
     * Get template config for this plan if it has one.
     *
     * @return the template config wrapped in an Optional
     */
    Optional<TemplateConfig> getTemplateConfig();
}

Fix comment