com.capitalone.dashboard.service.ScopeService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Hygieia Rest API Layer

There is a newer version: 3.4.53

package com.capitalone.dashboard.service;

import com.capitalone.dashboard.model.DataResponse;
import com.capitalone.dashboard.model.Scope;

import java.util.List;

import org.bson.types.ObjectId;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

public interface ScopeService {
	/**
	 * Retrieves all unique scopes
	 * 
	 * @return A data response list of type Scope containing all unique scopes
	 */
	List getAllScopes();

	/**
	 * Retrieves the scope information for a given scope source system ID
	 * 
	 * @param componentId
	 *            The ID of the related UI component that will reference
	 *            collector item content from this collector
	 * @param scopeId
	 *            A given scope's source-system ID
	 * 
	 * @return A data response list of type Scope containing all data for a
	 *         given scope source-system ID
	 */
	DataResponse> getScope(ObjectId componentId, String scopeId);

	/**
	 *
	 * @param collectorId
	 * @return scopes
	 */
	List getScopesByCollector(ObjectId collectorId);

	/**
	 * Finds paged results of scope items of a given collectorId, project name, pageable
	 *
	 * @param  collectorId
	 * @param {@link org.springframework.data.domain.Pageable} object to determine which page to return
	 * @return scope items matching the specified type
	 */
	Page getScopeByCollectorWithFilter(ObjectId collectorId, String projectName, Pageable pageable);

}