com.botronsoft.cmj.spi.appdata

Interface AppDataObject

@PublicSpi
public interface AppDataObject

Represents an app's object.

See Also:

AppDataObjectEnumerator

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getName()
String	getObjectId() Returns the id of the app's object.
String	getTypeId() Returns the id of the app's object type that this object is associated with.

Method Detail

getTypeId

@NotNull
String getTypeId()

Returns the id of the app's object type that this object is associated with.

Returns:

the id of the app's object type.

getObjectId

@NotNull
String getObjectId()

Returns the id of the app's object. The id of the object must be unique within its type. A list of the selected objects' ids with their types' ids will be provided to the app's handler in AppDataHandler.exportData(Map, ExportContext) AppDataHandler#exportData(Map<String, List<String>> selectedObjectIds, ExportContext exportContext)}.

Returns:

the id of the app's object.

See Also:

AppDataHandler

getName

@NotNull
String getName()

Returns:

the name of the object.

getDescription

@Nullable
String getDescription()

Returns:

the description of the object.