com.hpe.adm.nga.sdk.manualtests.TestStepList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-src Show documentation
The newest version!
/*
 * Copyright 2016-2023 Open Text.
 *
 * The only warranties for products and services of Open Text and
 * its affiliates and licensors (“Open Text”) are as may be set forth
 * in the express warranty statements accompanying such products and services.
 * Nothing herein should be construed as constituting an additional warranty.
 * Open Text shall not be liable for technical or editorial errors or
 * omissions contained herein. The information contained herein is subject
 * to change without notice.
 *
 * Except as specifically indicated otherwise, this document contains
 * confidential information and a valid license is required for possession,
 * use or copying. If this work is provided to the U.S. Government,
 * consistent with FAR 12.211 and 12.212, Commercial Computer Software,
 * Computer Software Documentation, and Technical Data for Commercial Items are
 * licensed to the U.S. Government under vendor's standard commercial license.
 *
 * 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 com.hpe.adm.nga.sdk.manualtests;

import com.hpe.adm.nga.sdk.network.OctaneHttpClient;

/**
 * An object that enables getting or updating (or creating) test steps using the SDK
 *
 * @see Create Manual Test Steps
 */
public class TestStepList {

    private final OctaneHttpClient octaneHttpClient;
    private final String scriptUrl;

    /**
     * The constructor.  The test id HAS to refer to a manual_test otherwise the API call will fail
     *
     * @param octaneHttpClient The client to use
     * @param baseDomain       The base domain from which the URL will be constructed
     * @param testId           Has to be a manual test ID otherwise the API will fail
     */
    public TestStepList(OctaneHttpClient octaneHttpClient, String baseDomain, final String testId) {
        this.octaneHttpClient = octaneHttpClient;
        this.scriptUrl = baseDomain + "tests/" + testId + "/script";
    }

    /**
     * Returns an instance of {@link GetTestSteps} in order to see test steps
     *
     * @return the instance
     */
    public GetTestSteps get() {
        return new GetTestSteps(octaneHttpClient, scriptUrl);
    }

    /**
     * Returns an instance of {@link UpdateTestSteps} in order to update or create test steps
     *
     * @return the instance
     */
    public UpdateTestSteps update() {
        return new UpdateTestSteps(octaneHttpClient, scriptUrl);
    }
}