Package pl.edu.icm.unity.engine.api
Interface AttributeTypeManagement
public interface AttributeTypeManagement
Attribute types management API.
- Author:
- K. Benedyczak
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a new attribute type.getAttributeType
(String name) String[]
void
removeAttributeType
(String id, boolean deleteInstances) Removes attribute type by id.void
Updates an existing attribute type.
-
Method Details
-
getSupportedAttributeValueTypes
- Returns:
- identifiers of all attribute value types which are supported by server. The list is constant for the lifetime of the server as is constructed from the available implementations.
- Throws:
EngineException
-
addAttributeType
Adds a new attribute type.- Throws:
EngineException
-
updateAttributeType
Updates an existing attribute type. Fails if the change break constraints of attributes already having this attribute set.- Throws:
EngineException
-
removeAttributeType
Removes attribute type by id.- Parameters:
deleteInstances
- if false then operation will succeed only if no attributes of this type are defined. If true then also all instances of this type are removed.- Throws:
EngineException
-
getAttributeTypes
- Returns:
- all attribute types
- Throws:
EngineException
-
getAttributeTypesAsMap
- Returns:
- all attribute types map with names as keys
- Throws:
EngineException
-
getAttributeType
- Parameters:
name
- attribute name- Returns:
- attribute type with a given name
- Throws:
EngineException
-