pl.edu.icm.unity.engine.api.attributes

Interface AttributeSupport

public interface AttributeSupport

This interface collect engine's operations related to attributes. Those operations doesn't check for authorization therefore their usage should be limited by a wrapping code, the operations must not be exposed directly.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method and Description
pl.edu.icm.unity.types.basic.AttributeExt	getAttributeByMetadata(pl.edu.icm.unity.types.basic.EntityParam entity, String group, String metadataId) Returns attribute which has the given metadata set.
Map<String,pl.edu.icm.unity.types.basic.AttributeType>	getAttributeTypesAsMap()
List<pl.edu.icm.unity.types.basic.AttributeType>	getAttributeTypeWithMetadata(String metadataId) Returns all attribute types which have the given metadata set.
pl.edu.icm.unity.types.basic.AttributeType	getAttributeTypeWithSingeltonMetadata(String metadataId) Returns attribute type which has the given metadata set.

Method Detail

getAttributeTypeWithSingeltonMetadata

pl.edu.icm.unity.types.basic.AttributeType getAttributeTypeWithSingeltonMetadata(String metadataId)
                                                                          throws pl.edu.icm.unity.exceptions.EngineException

Returns attribute type which has the given metadata set. The metadata must be singleton, otherwise unchecked exception is thrown. If there is no attribute type with this metadata, then null is returned.

Parameters:

metadataId -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

getAttributeTypeWithMetadata

List<pl.edu.icm.unity.types.basic.AttributeType> getAttributeTypeWithMetadata(String metadataId)
                                                                       throws pl.edu.icm.unity.exceptions.EngineException

Returns all attribute types which have the given metadata set.

Parameters:

metadataId -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

getAttributeByMetadata

pl.edu.icm.unity.types.basic.AttributeExt getAttributeByMetadata(pl.edu.icm.unity.types.basic.EntityParam entity,
                                                                 String group,
                                                                 String metadataId)
                                                          throws pl.edu.icm.unity.exceptions.EngineException

Returns attribute which has the given metadata set. If there is no attribute type with this metadata, then null is returned. The metadata must be singleton, otherwise unchecked exception is thrown.

Parameters:

entity -

group -

metadataId -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

getAttributeTypesAsMap

Map<String,pl.edu.icm.unity.types.basic.AttributeType> getAttributeTypesAsMap()
                                                                       throws pl.edu.icm.unity.exceptions.EngineException

Returns:

all attribute types as map. Not authorized anyhow

Throws:

pl.edu.icm.unity.exceptions.EngineException