Interface RelationApi
-
public interface RelationApi
Contains all api operations for handling relations.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Relation
addRelation(AddRelationRequest addRelationRequest)
Adds a new relation according to the parameters present in the request.List<Relation>
addRelations(List<AddRelationRequest> addRelationRequests)
Adds new relations according to the list of parameters present in the requests.Relation
changeRelation(ChangeRelationRequest changeRelationRequest)
Changes a relation according to the parameters present in the request.List<Relation>
changeRelations(List<ChangeRelationRequest> changeRelationRequests)
Changes multiple relations according to the parameters presents in the list of the requests.boolean
exists(UUID relationId)
Returns true if a relation with given ID exists.CursorPagedResponse<Relation>
findRelations(FindRelationsRequest findRelationsRequest)
Finds the relations according to the given request object.Relation
getRelation(UUID relationId)
Returns the relation identified by given ID.void
removeRelation(UUID relationId)
Removes the relation identified by given ID.void
removeRelations(List<UUID> relationIds)
Removes the relations with the given relation IDs.
-
-
-
Method Detail
-
addRelation
Relation addRelation(AddRelationRequest addRelationRequest)
Adds a new relation according to the parameters present in the request.- Parameters:
addRelationRequest
- the parameters that will determine the new relation- Returns:
- the newly created relation
-
addRelations
@SecurityAuditMethod(resultFormatter=com.collibra.audit.formatter.CollectionFormatter.class) List<Relation> addRelations(List<AddRelationRequest> addRelationRequests)
Adds new relations according to the list of parameters present in the requests.- Parameters:
addRelationRequests
- the list of parameters that will determine the new relations- Returns:
- the newly created relations
-
changeRelation
Relation changeRelation(ChangeRelationRequest changeRelationRequest)
Changes a relation according to the parameters present in the request.- Parameters:
changeRelationRequest
- the parameters to change the relation.- Returns:
- the changed relation
-
changeRelations
@SecurityAuditMethod(resultFormatter=com.collibra.audit.formatter.CollectionFormatter.class) List<Relation> changeRelations(List<ChangeRelationRequest> changeRelationRequests)
Changes multiple relations according to the parameters presents in the list of the requests.- Parameters:
changeRelationRequests
- the list of parameters to change the relations- Returns:
- the changed relations
-
getRelation
Relation getRelation(UUID relationId)
Returns the relation identified by given ID.- Parameters:
relationId
- the ID of the relation- Returns:
- the found relation
-
findRelations
@SecurityAuditMethod(resultFormatter=PagedResponseFormatter.class) CursorPagedResponse<Relation> findRelations(FindRelationsRequest findRelationsRequest)
Finds the relations according to the given request object.- Parameters:
findRelationsRequest
- the request object- Returns:
- A PagedResponse of Relations
-
exists
boolean exists(UUID relationId)
Returns true if a relation with given ID exists.- Parameters:
relationId
- the ID of the issue- Returns:
- true if a relation with given ID exists,
false
otherwise
-
removeRelation
void removeRelation(UUID relationId)
Removes the relation identified by given ID.- Parameters:
relationId
- the ID of the relation to remove
-
removeRelations
void removeRelations(List<UUID> relationIds)
Removes the relations with the given relation IDs.- Parameters:
relationIds
- the list of IDs of the relations to remove
-
-