Interface BusinessDataInfo<T>
-
- Type Parameters:
T
- the business data value type
public interface BusinessDataInfo<T>
Information about a business data value in the
BusinessDataRepository
.- Since:
- 6.3.0
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Date
getCreatedAt()
Date and time when the business data was createdlong
getCreatedByAppId()
Application id of the application that created this business dataString
getCreatedByUserName()
Username of the logged in user who created this business dataString
getId()
Get the unique identifier of the Business Data value.Date
getModifiedAt()
Date and time of the last time this business data was modifiedlong
getModifiedByAppId()
Application id of the application that modified this business data the last timeString
getModifiedByUserName()
Username of the logged in user who modified this business data lastString
getRawValue()
Returns the raw value in a serialized JSON format as stored in the repositoryClass<T>
getType()
Type of the business data valueString
getTypeName()
Full qualified name of the business data value typelong
getVersion()
Version of this Business Data value, incremented on each change that is saved.
-
-
-
Method Detail
-
getId
String getId()
Get the unique identifier of the Business Data value.
The maximum length of the identifier is 100 characters.
- Returns:
- the unique identifier
- API:
- This public API is available in IvyScript and Java. It has the visibility NOVICE.
-
getVersion
long getVersion()
Version of this Business Data value, incremented on each change that is saved. Used to handle concurrent modification and prevent data loss (optimistic locking), seeBusinessDataRepository.save(Object)
andBusinessDataRepository.overwrite(Object)
The initial version is 1- Returns:
- the actual version at the time the data was loaded
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getTypeName
String getTypeName()
Full qualified name of the business data value type- Returns:
- full qualified name
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getType
Class<T> getType()
Type of the business data value- Returns:
- type
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getCreatedAt
Date getCreatedAt()
Date and time when the business data was created- Returns:
- date and time
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getCreatedByUserName
String getCreatedByUserName()
Username of the logged in user who created this business data- Returns:
- username
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getCreatedByAppId
long getCreatedByAppId()
Application id of the application that created this business data- Returns:
- application id
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getModifiedAt
Date getModifiedAt()
Date and time of the last time this business data was modified- Returns:
- date and time
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getModifiedByUserName
String getModifiedByUserName()
Username of the logged in user who modified this business data last- Returns:
- username
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getModifiedByAppId
long getModifiedByAppId()
Application id of the application that modified this business data the last time- Returns:
- application id
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getRawValue
String getRawValue()
Returns the raw value in a serialized JSON format as stored in the repository
References and recursions are not resolved. To get the flat JSON (with resolved references) use the converter
IBusinessDataManager.toSearchIndexJson(String)
, which returns the search optimized JSON.- Returns:
- the raw value as stored in the repository
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
-