Interface ComplexRelationTypeApi
public interface ComplexRelationTypeApi
Provides functionality for the Complex Relation Types.
-
Method Summary
Modifier and TypeMethodDescriptionAdds a new Complex Relation Type.Changes the Complex Relation Type with the information that is present in the request.boolean
Returns true if a Complex Relation Type with givenid
exists.Finds the Complex Relation Types matching the given criteria.Deprecated.getComplexRelationType
(UUID complexRelationTypeId) Returns the Complex Relation Type identified by the given UUID.void
removeComplexRelationType
(UUID complexRelationTypeId) Removes the Complex Relation Type identified by given id.
-
Method Details
-
addComplexRelationType
Adds a new Complex Relation Type.- Parameters:
request
- parameters of the Complex Relation- Returns:
- the created Complex Relation Type
-
changeComplexRelationType
Changes the Complex Relation Type with the information that is present in the request. Only properties that are specified in this request and do not havenull
values are updated. All other properties are ignored.- Parameters:
request
- the properties of the Complex Relation Type to be changed- Returns:
- the changed Complex Relation Type
-
getComplexRelationType
Returns the Complex Relation Type identified by the given UUID.- Parameters:
complexRelationTypeId
- the UUID of the Complex Relation Type- Returns:
- the Complex Relation Type
-
findComplexRelationTypes
@SecurityAuditMethod(resultFormatter=com.collibra.dgc.core.api.internal.security.audit.formatter.PagedResponseFormatter.class) PagedResponse<ComplexRelationType> findComplexRelationTypes(FindComplexRelationTypesRequest request) Finds the Complex Relation Types matching the given criteria.- Parameters:
request
- the request object containing the criteria- Returns:
- a pagedResponse of Complex Relation Types
-
getAllComplexRelationTypes
@Deprecated @SecurityAuditMethod(resultFormatter=com.collibra.audit.formatter.CollectionFormatter.class) List<ComplexRelationType> getAllComplexRelationTypes()Deprecated.Returns all Complex Relation Types.- Returns:
- all the Complex Relation Types
-
exists
Returns true if a Complex Relation Type with givenid
exists.- Parameters:
complexRelationTypeId
- theid
of the Complex Relation Type- Returns:
- true if a Complex Relation Type with given
id
exists,false
otherwise
-
removeComplexRelationType
Removes the Complex Relation Type identified by given id.- Parameters:
complexRelationTypeId
- theid
of the Complex Relation Type
-
findComplexRelationTypes(FindComplexRelationTypesRequest)