Index (Kokos SDK Entity 6.2.0 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractEntity - Class in com.smeup.kokos.sdk.entity.model: The model of generic entity
AbstractEntity() - Constructor for class com.smeup.kokos.sdk.entity.model.AbstractEntity
AbstractEntityBuilder<E> - Class in com.smeup.kokos.sdk.entity.model.builder
AbstractEntityBuilder(E) - Constructor for class com.smeup.kokos.sdk.entity.model.builder.AbstractEntityBuilder
Action - Annotation Interface in com.smeup.kokos.sdk.entity.annotations
ActionDescriptor - Record Class in com.smeup.kokos.sdk.entity.model.descriptors: Describes a single Action from the Action annotation metadata of an entity class.
ActionDescriptor(String, String, String, String) - Constructor for record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Creates an instance of a ActionDescriptor record class.
ATTRS - Static variable in annotation interface com.smeup.kokos.sdk.entity.annotations.SmeupOav

B

BOOL - Static variable in class com.smeup.kokos.sdk.entity.model.types.SmeupTypes
build() - Method in class com.smeup.kokos.sdk.entity.model.builder.AbstractEntityBuilder
BuildableEntity<B> - Interface in com.smeup.kokos.sdk.entity.model.builder: Interface for entities that can be converted to a builder.
buildTooltipContent(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_203_07

C

ClassAndRepository(Class<? extends AbstractEntity>, EntityRepository<?>) - Constructor for record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Creates an instance of a ClassAndRepository record class.
code() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Returns the value of the code record component.
COLUMN_ID_TITLE - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
COLUMN_OBJ - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
com.smeup.kokos.sdk.entity - package com.smeup.kokos.sdk.entity
com.smeup.kokos.sdk.entity.annotations - package com.smeup.kokos.sdk.entity.annotations
com.smeup.kokos.sdk.entity.exception - package com.smeup.kokos.sdk.entity.exception
com.smeup.kokos.sdk.entity.model - package com.smeup.kokos.sdk.entity.model
com.smeup.kokos.sdk.entity.model.builder - package com.smeup.kokos.sdk.entity.model.builder
com.smeup.kokos.sdk.entity.model.descriptors - package com.smeup.kokos.sdk.entity.model.descriptors
com.smeup.kokos.sdk.entity.model.types - package com.smeup.kokos.sdk.entity.model.types
com.smeup.kokos.sdk.entity.repository - package com.smeup.kokos.sdk.entity.repository
com.smeup.kokos.service - package com.smeup.kokos.service
com.smeup.kokos.service.utils - package com.smeup.kokos.service.utils

D

decodeObject(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_202_02A: Decodes one object and returns: code, existence flag, description and object class.
deleteById(EntityRepositoryContext, String) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Deletes an entity by its id.
describeOavs(Class<? extends AbstractEntity>) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Returns the OAV metadata descriptors for the given entity class, derived purely from the SmeupOav and Id annotations on its declared fields.
description() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.Action
description() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.SmeupOav
description() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns the value of the description record component.
description() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the description record component.
Description - Annotation Interface in com.smeup.kokos.sdk.entity.annotations
DescriptionReadException - Exception Class in com.smeup.kokos.sdk.entity.exception: Thrown when AbstractEntity cannot read the value of a Description using reflection.
DescriptionReadException(Throwable) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.DescriptionReadException

E

EMPTY - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
entityClass() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Returns the value of the entityClass record component.
EntityManager - Class in com.smeup.kokos.sdk.entity: Global, singleton entry-point to retrieve EntityRepository instances.
EntityManagerConfig - Class in com.smeup.kokos.sdk.entity: Builder used at program initialization to register all EntityRepository implementations and produce a fully configured EntityManager singleton.
EntityManagerConfig() - Constructor for class com.smeup.kokos.sdk.entity.EntityManagerConfig
EntityManagerInitException - Exception Class in com.smeup.kokos.sdk.entity.exception: Thrown when EntityManager cannot be initialized — for example when a repository class discovered during package scanning cannot be instantiated.
EntityManagerInitException(String, Throwable) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.EntityManagerInitException
EntityNotFoundException - Exception Class in com.smeup.kokos.sdk.entity.exception: Thrown when EntityRepository cannot find an entity by its id
EntityNotFoundException(String) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.EntityNotFoundException
EntityRepository<T> - Interface in com.smeup.kokos.sdk.entity.repository: The interface of generic repository for entities.
EntityRepositoryContext - Class in com.smeup.kokos.sdk.entity.repository: Carries query parameters passed to EntityRepository methods.
EntityRepositoryContext() - Constructor for class com.smeup.kokos.sdk.entity.repository.EntityRepositoryContext
EntityServiceConstants - Class in com.smeup.kokos.service.utils: Shared string constants used by entity-backed services.
EntityServiceSupport - Class in com.smeup.kokos.service.utils: Shared helper methods for entity-backed services.
EntityServiceSupport.ClassAndRepository - Record Class in com.smeup.kokos.service.utils: Entity class and its repository resolved together in a single lookup.
EntityServiceSupport.ResolvedObj - Record Class in com.smeup.kokos.service.utils: Resolved entity coordinates extracted from a FunObject.
equals(Object) - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Indicates whether some other object is "equal to" this one.
exec() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.Action
exec() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns the value of the exec record component.

F

FALSE - Enum constant in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues
find(EntityRepositoryContext) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Reads a list of entities
findAll(EntityRepository<?>) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Returns an iterator over all entities in the given repository.
findById(EntityRepository<?>, String) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Finds an entity by id using the provided repository, suppressing unchecked warnings
findById(EntityRepositoryContext, String) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Reads a single entity by its id.
FLAG_TRUE - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
fromAnnotation(SmeupOav) - Static method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor

G

get(String) - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the given attribute by name.
getActions() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the list of Action descriptors for this entity, derived purely from the Action annotations on its declared methods.
getDescriptionValue() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the value of the field annotated with @Description, otherwise it fallbacks on the getId() method.
getEntity() - Method in class com.smeup.kokos.sdk.entity.model.builder.AbstractEntityBuilder
getEntityClassName() - Method in exception class com.smeup.kokos.sdk.entity.exception.RepositoryNotFoundException: Returns the fully-qualified name of the entity class whose repository was not found.
getEntityGrid(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_202_01B: Return the object details editable
getId() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
getInstance() - Static method in class com.smeup.kokos.sdk.entity.EntityManager: Returns the globally shared EntityManager instance.
getOavFields(boolean) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the list of fields annotated with @SmeupOav, optionally including those also annotated with @Id.
getOavFields(Class<? extends AbstractEntity>, boolean) - Static method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the list of fields annotated with @SmeupOav for the given entity class, optionally including those also annotated with @Id.
getOavs() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the list of OAV descriptors for this entity, derived purely from the SmeupOav and Id annotations on its declared fields.
getOavs(Class<? extends AbstractEntity>) - Static method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the list of OAV descriptors for this entity, derived purely from the SmeupOav and Id annotations on its declared fields.
getOavValue(String) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Gets back the value of the field annotated with @SmeupOav with the given id.
getObjectDetails(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_202_01B: Return the object details
getObjectDetailsDeprecated(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_202_01B
getParameter() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
getRegisteredEntityClasses() - Method in class com.smeup.kokos.sdk.entity.EntityManager: Returns the set of all entity classes that have a registered repository.
getRepository(Class<T>) - Method in class com.smeup.kokos.sdk.entity.EntityManager: Returns the repository registered for the given entity class.
getType() - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
getValue() - Method in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues
GRID_FUN_METHOD - Static variable in class com.smeup.kokos.service.KS_202_01B

H

hashCode() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns a hash code value for this object.
hashCode() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns a hash code value for this object.
hashCode() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Returns a hash code value for this object.
hashCode() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Returns a hash code value for this object.

I

icon() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.Action
icon() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns the value of the icon record component.
id() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.Action
id() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.SmeupOav
id() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns the value of the id record component.
id() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the id record component.
Id - Annotation Interface in com.smeup.kokos.sdk.entity.annotations
init(EntityManagerConfig) - Static method in class com.smeup.kokos.sdk.entity.EntityManager: Initializes the singleton from the supplied configuration.
isDescription() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the isDescription record component.
isId() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the isId record component.
isIdField(Field, SmeupOav, String) - Static method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Determines if the given field is the id field, either by being annotated with @Id or by having an OAV id matching the default id.
isTooltipEnabled() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Determines whether a tooltip is necessary for this entity, based on the types of its OAVs.

K

KokosEntity - Annotation Interface in com.smeup.kokos.sdk.entity.annotations: Marks a class as a Kokos entity and binds it to a Smeup object type+parameter pair.
KS_202_01B - Class in com.smeup.kokos.service: Entity detail service.
KS_202_01B() - Constructor for class com.smeup.kokos.service.KS_202_01B
KS_202_01E - Class in com.smeup.kokos.service: Entity list service.
KS_202_01E() - Constructor for class com.smeup.kokos.service.KS_202_01E
KS_202_02A - Class in com.smeup.kokos.service: Decodes a single entity into a compact matrix response.
KS_202_02A() - Constructor for class com.smeup.kokos.service.KS_202_02A
KS_203_07 - Class in com.smeup.kokos.service: Builds tooltip matrix data (OAV values + action buttons) for a single entity.
KS_203_07() - Constructor for class com.smeup.kokos.service.KS_203_07

L

LEGACY_ROW_FUN_METHOD - Static variable in class com.smeup.kokos.service.KS_202_01B
Lifecycle - Search tag in class com.smeup.kokos.sdk.entity.EntityManager: Section
listObjectsDefault(Fun, ExecutionContext) - Method in class com.smeup.kokos.service.KS_202_01E: Returns entities for the given Smeup type+parameter combination.

M

MATRIX - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants

N

NULL - Enum constant in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues

O

OavDescriptor - Record Class in com.smeup.kokos.sdk.entity.model.descriptors: Describes a single OAV (Object Attribute Value) from the SmeupOav annotation metadata of an entity class.
OavDescriptor(String, String, String, String, boolean, boolean) - Constructor for record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Creates an instance of a OavDescriptor record class.
OBJ1_VALUE_FROM_INPUT_KEY - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants

P

PARAM_OG_ENTITY_CLASS - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
parameter() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.KokosEntity: Optional Smeup object parameter (e.g.
parameter() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.SmeupOav
parameter() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the parameter record component.
parameter() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Returns the value of the parameter record component.

R

readFieldValue(Field) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity: Reads the value of the given field from this entity instance, returning it as a String.
register(Class<T>, EntityRepository<T>) - Method in class com.smeup.kokos.sdk.entity.EntityManagerConfig: Explicitly registers a repository instance for the given entity class.
Registration - Search tag in class com.smeup.kokos.sdk.entity.EntityManager: Section
repository() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Returns the value of the repository record component.
RepositoryNotFoundException - Exception Class in com.smeup.kokos.sdk.entity.exception: Thrown when no EntityRepository is registered for the requested entity class.
RepositoryNotFoundException(Class<?>) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.RepositoryNotFoundException
RepositoryNotFoundException(String) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.RepositoryNotFoundException
RepositoryReadException - Exception Class in com.smeup.kokos.sdk.entity.exception: This exception is thrown when an error occurs while performing a read operation on a EntityRepository, such as when fetching an entity by ID or listing entities.
RepositoryReadException(String) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.RepositoryReadException
RepositoryReadException(String, Throwable) - Constructor for exception class com.smeup.kokos.sdk.entity.exception.RepositoryReadException
resolveClassAndRepository(String, String) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Resolves both the entity class and its repository in a single pass, avoiding two separate calls to EntityManager.
ResolvedObj(String, String, String) - Constructor for record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Creates an instance of a ResolvedObj record class.
resolveEntityClass(String, String) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Resolves the entity class registered for the given Smeup type and parameter.
resolveRepository(EntityServiceSupport.ResolvedObj) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Resolves the repository associated with the provided resolved object coordinates.
resolveRepository(String, String) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Resolves the repository associated with the provided type and parameter.
resolveTypeParameterCode(FunObject) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Resolves entity type, parameter and code from a FunObject, handling the two standard FUN conventions: Case 1 – OG form: 1(OG;;CNCOL) or 1(OG;;OKAHD) where type + parameter are packed in K and code is empty. Case 2 – direct T;P;K: 1(CN;COL;BONMAI) where T is type, P is parameter, K is code.
Role in the SDK - Search tag in annotation interface com.smeup.kokos.sdk.entity.annotations.KokosEntity: Section

S

save(EntityRepositoryContext, T) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Creates a new entity and returns the created entity with its generated id.
setId(String) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
setParameter(String) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
setType(String) - Method in class com.smeup.kokos.sdk.entity.model.AbstractEntity
SmeupOav - Annotation Interface in com.smeup.kokos.sdk.entity.annotations: Annotation to mark a field as an OAV (Object Attribute Value) in the context of the Kokos SDK.
SmeupTypes - Class in com.smeup.kokos.sdk.entity.model.types: This class contains the constants for the types of the Smeup entities.
SmeupTypes() - Constructor for class com.smeup.kokos.sdk.entity.model.types.SmeupTypes
SmeupTypes.SmeupBooleanValues - Enum Class in com.smeup.kokos.sdk.entity.model.types
STRING - Static variable in class com.smeup.kokos.sdk.entity.model.types.SmeupTypes

T

toBuilder() - Method in interface com.smeup.kokos.sdk.entity.model.builder.BuildableEntity
toString() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.ActionDescriptor: Returns a string representation of this record class.
toString() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns a string representation of this record class.
toString() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ClassAndRepository: Returns a string representation of this record class.
toString() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Returns a string representation of this record class.
TREE - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
TRUE - Enum constant in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues
type() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.KokosEntity: Mandatory 2-character Smeup object type (e.g.
type() - Element in annotation interface com.smeup.kokos.sdk.entity.annotations.SmeupOav
type() - Method in record class com.smeup.kokos.sdk.entity.model.descriptors.OavDescriptor: Returns the value of the type record component.
type() - Method in record class com.smeup.kokos.service.utils.EntityServiceSupport.ResolvedObj: Returns the value of the type record component.
TYPE_OG - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
TYPE_PARAMETER_CODE - Static variable in class com.smeup.kokos.service.utils.EntityServiceConstants
Type and parameter - Search tag in annotation interface com.smeup.kokos.sdk.entity.annotations.KokosEntity: Section

U

updateById(EntityRepositoryContext, String, T) - Method in interface com.smeup.kokos.sdk.entity.repository.EntityRepository: Updates an existing entity and returns the updated entity.
Usage - Search tag in annotation interface com.smeup.kokos.sdk.entity.annotations.KokosEntity: Section

V

valueOf(String) - Static method in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.smeup.kokos.sdk.entity.model.types.SmeupTypes.SmeupBooleanValues: Returns an array containing the constants of this enum class, in the order they are declared.

W

writeObjectNotFoundMessage(KokosService, EntityServiceSupport.ResolvedObj) - Static method in class com.smeup.kokos.service.utils.EntityServiceSupport: Writes a warning message to the service output indicating that the specified object was not found.

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form