com.capitalone.dashboard.service.TeamService 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.Team;
import org.bson.types.ObjectId;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

import java.util.List;

public interface TeamService {
    /**
     * Retrieves all unique teams
     *
     * @return A data response list of type Scope containing all unique scopes
     */
    Iterable getAllTeams();

    /**
     * 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 teamId
     *            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 getTeam(ObjectId componentId, String teamId);

    List getTeamsByCollector(ObjectId collectorId);

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

}