cz.ues.platform.sysc.entitytype

Interface UESEntityType

@UESComponent
@EnableScriptAPI
@WebServiceAccessible(wspHandlerChain="ues/platform/sysc/entitytype/UESEntityTypeHandlerChain.xml")
public interface UESEntityType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ET_ENTITY_TYPE_CODE Code of entity type entity.
static UESURI	ET_ENTITY_TYPE_URI URI of entity type entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESEntityTypeAttributes	getAttributes(UESURI entityType) Reads Entity Type attributes according to given UESURI.
UESEntityTypeAttributes	getEntityTypeAttributes(UESURI entityType) Deprecated. Use UESEntityType.getAttributes(UESURI)
UESURI	getEntityTypeUri(UESURI entity) Returns UESURI of Entity Type for given object.
UESResultList<UESEntityTypeAttributes,UESEntityTypeGetChildrenList>	getChildrenList(UESURI entityType, UESEntityTypeGetChildrenList criteria) Returns children of given entity type.
boolean	isAssignableFrom(UESURI mainEntityType, UESURI testedEntityType) Checks if Entity Type is assignable from other Entity Type.
boolean	isInstanceOf(UESURI testedEntity, UESURI testedEntityType) Checks if some object is instance of given Entity Type.

Field Detail

ET_ENTITY_TYPE_CODE

static final ET_ENTITY_TYPE_CODE

Code of entity type entity.

Since:

UES7-10

See Also:

Constant Field Values

ET_ENTITY_TYPE_URI

static final ET_ENTITY_TYPE_URI

URI of entity type entity.

Since:

UES7-10

Method Detail

getEntityTypeUri

UESURI getEntityTypeUri(UESURI entity)
throws UESEntityTypeRTException

Returns UESURI of Entity Type for given object.

Parameters:

entity - UESURI of object for which to get Entity Type

Returns:

UESURI of Entity Type

Throws:

UESEntityTypeRTException - In case obtaining of BE Type UESURI fails

Since:

UES7-00

getEntityTypeAttributes

@Deprecated

UESEntityTypeAttributes getEntityTypeAttributes(UESURI entityType)
throws UESEntityTypeRTException

Deprecated. Use UESEntityType.getAttributes(UESURI)

Reads Entity Type attributes according to given UESURI. If there is no Entity Type with given UESURI, null is returned.

Parameters:

entityType - UESURI of Entity Type to be loaded

Returns:

Loaded Entity Type or null if no such Entity Type exists

Throws:

UESEntityTypeRTException - In case reading of BE Type fails

Since:

UES7-00

getAttributes

UESEntityTypeAttributes getAttributes(UESURI entityType)
throws UESEntityTypeRTException

Reads Entity Type attributes according to given UESURI. If there is no Entity Type with given UESURI, null is returned.

Parameters:

entityType - UESURI of Entity Type to be loaded

Returns:

Loaded Entity Type or null if no such Entity Type exists

Throws:

UESEntityTypeRTException - In case reading of BE Type fails

Since:

UES7-10

isAssignableFrom

boolean isAssignableFrom(UESURI mainEntityType,
UESURI testedEntityType)
throws UESEntityTypeRTException

Checks if Entity Type is assignable from other Entity Type. If either of Entity Types does not exist, false is returned.

Parameters:

mainEntityType - UESURI of main Entity Type (parent)

testedEntityType - UESURI of tested Entity Type (child)

Returns:

True if tested Entity Type is assignable from main Entity Type, false if not

Throws:

UESEntityTypeRTException - In case check fails.

Since:

UES7-00

isInstanceOf

boolean isInstanceOf@MainEntity(optional=true)
(
UESURI testedEntity,
UESURI testedEntityType)
throws UESEntityTypeRTException

Checks if some object is instance of given Entity Type. If given object or Entity Type does not exist, false is returned.

Parameters:

testedEntity - UESURI of object to be tested

testedEntityType - UESURI of expected Entity Type

Returns:

True if tested object is instance of given Entity Type, false if not

Throws:

UESEntityTypeRTException - In case check fails.

Since:

UES7-00

getChildrenList

UESResultList<UESEntityTypeAttributes,UESEntityTypeGetChildrenList> getChildrenList(UESURI entityType,
UESEntityTypeGetChildrenList criteria)
throws UESEntityTypeRTException

Returns children of given entity type.

Parameters:

entityTypeUri - UESURI of main Entity Type (parent)

UESEntityTypeGetChildrenList - Criteria for filtering of result

Returns:

List of children (sorted by level and parent). Null if given parent entity does not exist.

Throws:

UESEntityTypeRTException - In case obtaining of children fails

Since:

UES7-10