Interface ResponsibilityApi
-
public interface ResponsibilityApi
Contains all api operations for handling responsibilities.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<Responsibility>
addResponsibilities(List<AddResponsibilityRequest> addResponsibilityRequests)
Adds multiple Responsibilities in one go.Responsibility
addResponsibility(AddResponsibilityRequest addResponsibilityRequest)
Adds a responsibility.boolean
exists(UUID responsibilityId)
Returns true if a responsibility with given ID exists.PagedResponse<Responsibility>
findResponsibilities(FindResponsibilitiesRequest findResponsibilitiesRequest)
Finds the responsibilities that match the given input.Responsibility
getResponsibility(UUID responsibilityId)
Returns the responsibility with the given ID.void
removeResponsibilities(List<UUID> responsibilityIds)
Remove the responsibilities with the given ids.void
removeResponsibility(UUID responsibilityId)
Remove the responsibility identified by given ID.
-
-
-
Method Detail
-
addResponsibility
Responsibility addResponsibility(AddResponsibilityRequest addResponsibilityRequest)
Adds a responsibility.- Parameters:
addResponsibilityRequest
- the information required to add a responsibility.- Returns:
- the created responsibility
-
addResponsibilities
@SecurityAuditMethod(resultFormatter=com.collibra.audit.formatter.CollectionFormatter.class) List<Responsibility> addResponsibilities(List<AddResponsibilityRequest> addResponsibilityRequests)
Adds multiple Responsibilities in one go.- Parameters:
addResponsibilityRequests
- the list of requests for adding responsibilities- Returns:
- the list of created responsibilities
-
getResponsibility
Responsibility getResponsibility(UUID responsibilityId)
Returns the responsibility with the given ID.- Parameters:
responsibilityId
- the ID of the responsibility- Returns:
- the found responsibility
-
findResponsibilities
@SecurityAuditMethod(resultFormatter=PagedResponseFormatter.class) PagedResponse<Responsibility> findResponsibilities(FindResponsibilitiesRequest findResponsibilitiesRequest)
Finds the responsibilities that match the given input.- Parameters:
findResponsibilitiesRequest
- The filter options for finding the responsibilities.- Returns:
- the found responsibilities.
-
exists
boolean exists(UUID responsibilityId)
Returns true if a responsibility with given ID exists.- Parameters:
responsibilityId
- the ID of the issue- Returns:
- true if a responsibility with given ID exists,
false
otherwise
-
removeResponsibility
void removeResponsibility(UUID responsibilityId)
Remove the responsibility identified by given ID.- Parameters:
responsibilityId
- the UUID of the responsibility to remove
-
removeResponsibilities
void removeResponsibilities(List<UUID> responsibilityIds)
Remove the responsibilities with the given ids.- Parameters:
responsibilityIds
- the list of IDs of the responsibilities to remove
-
-