com.hp.octane.integrations.services.entities.EntitiesService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrations-sdk Show documentation
There is a newer version: 2.24.3.5
/**
 * Copyright 2017-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.hp.octane.integrations.services.entities;

import com.hp.octane.integrations.OctaneSDK;
import com.hp.octane.integrations.dto.entities.ResponseEntityList;
import com.hp.octane.integrations.services.rest.RestService;
import com.hp.octane.integrations.dto.entities.Entity;

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

public interface EntitiesService {

	/**
	 * Service instance producer - for internal usage only (protected by inaccessible configurer)
	 *
	 * @param configurer  SDK services configurer object
	 * @param restService Rest Service
	 * @return initialized service
	 */
	static EntitiesService newInstance(OctaneSDK.SDKServicesConfigurer configurer, RestService restService) {
		return new EntitiesServiceImpl(configurer, restService);
	}

	List postEntities(Long workspaceId, String entityCollectionName, List entities);

	List postEntities(Long workspaceId, String entityCollectionName, List entities, Collection fields);

	List postEntities(Long workspaceId, String entityCollectionName, List entities, Collection fields, Map serviceArgument);

	List postEntities(Long workspaceId, String entityCollectionName, String jsonData);

	List postEntities(Long workspaceId, String entityCollectionName, String jsonData, Collection fields);

	List postEntities(Long workspaceId, String entityCollectionName, String jsonData, Collection fields,Map serviceArgument);

	ResponseEntityList getPagedEntities(String url);

	List getEntities(Long workspaceId, String entityCollectionName, Collection conditions, Collection fields);

	List getEntities(Long workspaceId, String entityCollectionName, Collection conditions, String orderBy, Collection fields);

	List getEntitiesByIds(Long workspaceId, String collectionName, Collection ids);

	List getEntitiesByIds(Long workspaceId, String collectionName, Collection ids, Collection fields);

	List deleteEntitiesByIds(Long workspaceId, String entityCollectionName, Collection entitiesIds);

	List deleteEntities(Long workspaceId, String entityCollectionName, Collection conditions);

	List updateEntities(Long workspaceId, String entityCollectionName, List entities);

	List updateEntities(Long workspaceId, String entityCollectionName, String jsonData);

	String buildEntityUrl(Long workspaceId, String collection, Collection conditions, Collection fields, Integer offset, Integer limit, String orderBy);

	String buildEntityUrl(Long workspaceId, String collection, Collection conditions, Collection fields, Integer offset, Integer limit, String orderBy,Map serviceArgument);

}