Package com.storedobject.ai

Class Topic

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Name

com.storedobject.ai.Topic

All Implemented Interfaces:

Displayable, HasName, StringFiller, HasId

public final class Topic
extends Name

Represents a specific topic and associated knowledge logic. This is used by the ChatConnector to provide AI chat capabilities via SO Connector API.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.Name

name

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Topic()	Constructs a new, empty instance of the Topic class.

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()	Retrieves an array of column definitions for the topic entity.
boolean	casAccess(SystemUser user)	Determines whether the specified SystemUser has access to the topic.
static void	columns(Columns columns)	Adds required column definitions for the `Topic` class to the given Columns object.
static void	customizeMetadata(UIFieldMetadata md)	Customizes the metadata of a UI field.
static Topic	get(String name)	Retrieves a Topic instance by its name.
Class<? extends Knowledge>	getKnowledgeLogicClass()	Retrieves the knowledge logic class associated with this topic.
String	getLogic()	Retrieves the logic associated with this topic.
String	getTopicName()	Retrieves the name of the topic.
static ObjectIterator<Topic>	list(SystemUser user)	Retrieves an iterator of Topic objects that the specified SystemUser has access to.
static ObjectIterator<Topic>	list(String name)	Retrieves an iterator of Topic objects that match the specified name.
void	setLogic(String logic)	Sets the logic associated with the topic.
void	validateData(TransactionManager tm)	Validates the data integrity and ensures all required properties of the Topic are properly set.

Methods inherited from class com.storedobject.core.Name

getName, getUniqueCondition, indices, setName, toString

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, migrateLink, migrateLink, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Topic

public Topic()

Constructs a new, empty instance of the Topic class. This default constructor is used to create an uninitialized object of Topic.

Method Details

columns

public static void columns(Columns columns)

Adds required column definitions for the `Topic` class to the given Columns object.

Parameters:

columns - the Columns object to which the column definitions will be added

browseColumns

public static String[] browseColumns()

Retrieves an array of column definitions for the topic entity.

Returns:

An array of strings representing the column definitions, mapping database column names to user-friendly names. For example, "Name AS Topic" and "Logic AS Knowledge Logic".

get

public static Topic get(String name)

Retrieves a Topic instance by its name.

Parameters:

name - the name of the topic to retrieve

Returns:

the Topic instance with the specified name, or null if not found

list

public static ObjectIterator<Topic> list(String name)

Retrieves an iterator of Topic objects that match the specified name.

Parameters:

name - the name of the topics to be listed

Returns:

an iterator of Topic objects that match the specified name

getTopicName

public String getTopicName()

Retrieves the name of the topic.

Returns:

The name of the topic as a String.

setLogic

public void setLogic(String logic)

Sets the logic associated with the topic.

Parameters:

logic - the logic to be associated with this topic; typically represents a class name or identifier related to knowledge logic functionality.

getLogic

@Column(order=200,
        caption="Knowledge Logic")
public String getLogic()

Retrieves the logic associated with this topic.

Returns:

the logic as a String, representing the associated knowledge logic for this topic.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Validates the data integrity and ensures all required properties of the Topic are properly set. If the associated knowledge logic class cannot be resolved, an exception is thrown.

Overrides:

validateData in class Name

Parameters:

tm - the TransactionManager instance used for handling transactional operations

Throws:

Exception - if the KnowledgeLogic class is not set or valid

getKnowledgeLogicClass

public Class<? extends Knowledge> getKnowledgeLogicClass()

Retrieves the knowledge logic class associated with this topic. If the class has already been resolved, it returns the cached class. Otherwise, it attempts to resolve the class using the logic field. If the class is abstract or any error occurs during resolution, it returns null.

Returns:

the Class<?> representing the knowledge logic class, or null if the logic class cannot be resolved or is abstract.

customizeMetadata

public static void customizeMetadata(UIFieldMetadata md)

Customizes the metadata of a UI field. Updates the caption of the metadata if the field name matches specific criteria.

Parameters:

md - the metadata of the UI field to be customized

casAccess

public boolean casAccess(SystemUser user)

Determines whether the specified SystemUser has access to the topic. If the user's ID matches the current ID, the stored access status is returned. Otherwise, the access permission is recalculated based on the user's ability to access the associated knowledge logic class.

Parameters:

user - the SystemUser whose access is being checked; may be null

Returns:

true if the user has access to the topic, false otherwise

list

public static ObjectIterator<Topic> list(SystemUser user)

Retrieves an iterator of Topic objects that the specified SystemUser has access to. It filters the topics based on the user's access permissions.

Parameters:

user - the SystemUser whose access permissions are used to filter the topics; may be null

Returns:

an iterator of Topic objects that the user has access to