Interface DerivedRelationTypeApi
public interface DerivedRelationTypeApi
Contains all public API operations for handling Derived Relation Types.
-
Method Summary
Modifier and TypeMethodDescriptionAdds a new Derived Relation Type.Changes a Derived Relation Type.booleanReturnstrueif a Derived Relation Type with the given id exists.Finds Derived Relation Types matching the given search input.Returns the Derived Relation Type for the given UUID.getDerivedRelationTypeByPublicId(String publicId) Returns the Derived Relation Type identified by the given public id.voidRemoves the Derived Relation Type with the given id.
-
Method Details
-
getDerivedRelationType
Returns the Derived Relation Type for the given UUID.- Parameters:
id- the UUID of the Derived Relation Type- Returns:
- the Derived Relation Type
-
getDerivedRelationTypeByPublicId
Returns the Derived Relation Type identified by the given public id.- Parameters:
publicId- the public id of the Derived Relation Type- Returns:
- the Derived Relation Type
-
exists
Returnstrueif a Derived Relation Type with the given id exists.- Parameters:
id- the id of the Derived Relation Type- Returns:
trueif a Derived Relation Type with the given id exists,falseotherwise
-
addDerivedRelationType
Adds a new Derived Relation Type.- Parameters:
request- the request to add a Derived Relation Type- Returns:
- the created Derived Relation Type
-
changeDerivedRelationType
Changes a Derived Relation Type.- Parameters:
request- the request to change a Derived Relation Type- Returns:
- the changed Derived Relation Type
-
removeDerivedRelationType
Removes the Derived Relation Type with the given id.- Parameters:
id- the id of the Derived Relation Type
-
findDerivedRelationTypes
PagedResponse<DerivedRelationType> findDerivedRelationTypes(FindDerivedRelationTypesRequest request) Finds Derived Relation Types matching the given search input.- Parameters:
request- the request to find Derived Relation Types- Returns:
- the found Derived Relation Types
-