Package com.onenetwork.platform.data.model

APIs for reading and writing Models developed with the SDK.

See ModelDataService for details on how to read and write Models.

  • Interface Summary 
    Interface Description
    ActionListAsyncThresholdComputation
    Implement this interface to enforce asynchronous execution of Action list, i.e.
    AttachmentService
    Service to create and manipulate Model Attachments.
    AttributeService
    Service interface which converts back-and-forth between strongly-typed attribute value objects (like Double or Calendar) and strings which can be stored generically in the database.
    CustomModelPermissionPolicy
    Implement this interface to enforce custom model permissions on top of framework read/write permissions.
    EncryptionService
    Provides APIs for encrypting or decrypting a string if encryption is enabled otherwise it's a no-op.
    Issue
    Interface for an Issue which can added to a Model to turn the Issue on and off in the database.
    MDFs
    "Module-Defined Fields" marker interface.
    Model
    Common interface implemented by all Model objects.
    ModelAttachment
    Represents a document which can be attached to a Model.
    ModelDataService
    Provides APIs for reading and writing Models.
    ModelLinkComponent
    A single component in a ModelLinkKey, with a name and value.
    ModelLinkKey
    A ModelLink is a field on a Model which references ("links") another Model.
    ModelQueryComponent
    Marker interface for components of a query which reads Models.
    ModuleInstanceConfig
    marker interface
    OrgHierarchyService
    Provides APIs for the Organization Hierarchy.
    Rider
    Interface for creating transient 'rider' objects on top of models during action/workflow execution.
    StatusMessage
    A Model status message - severity may be Error or Warning, based on the context in which it is used.
    SyntheticModelListener
    This interface is intended to be implemented and provided when calling UserDefinedPageService#registerSynthetic1to1(String, Class, Class, String, SyntheticModelListener).
    UserDefinedPageService
    Service interface which allows you to register features for use within User-defined Pages.
  • Class Summary 
    Class Description
    BaseCustomModelPermissionPolicy
    Base implementation for CustomModelPermissionPolicy.
    ConcurrencyVersionRetrieval
    Used to form the concurrencyVersion retrieval clause of a Model query.
    DefaultModelActions
    The following actions are generated by default for all models.
    Difference
    Captures difference between values of field in two Model instances.
    IssuePersistentProperties
    Utility class to support additional properties on the Issue object which can be stored in the database.
    ModelAudit<M extends Model>
    Captures an audit entry for a Model.
    ModelDiffConfig
    Class representing configurable options for finding out differences between two Model objects.
    ModelFilter
    Used to form the "WHERE" clause of a Model query.
    ModelList<M extends Model>
    Contains a list of Models to be used in conjunction with the write* methods of ModelDataService.
    ModelPaging
    Used to define the "Paging" clause of a Model query.
    ModelQuery
    Meant to be imported statically to provide methods for creating filter, sort and retrieval criteria to be used with ModelDataService.read() to read Models from the database.
    ModelRetrieval
    Used to define the "SELECT" clause of a Model query.
    ModelSort
    Used to form the sort clause ("ORDER BY") of a Model query.
    ModelWriteRequest<M extends Model>
    Detailed request for writing Models, which includes parameters for changing natural keys, returning processed records, etc.
    NullConstants
    These constants should be used in write APIs to signal that a value in the DB should be forcibly set to null.
    PermissionContext
    Helper class for custom model permission policy to set the permission context.
    SyntheticModel
    This class represents a synthetic 1-to-1 relationship between 2 models.
    ViewRequest<T extends Model>
    Encapsulates all parameters which go into invoking a Model view programmatically.
  • Enum Summary 
    Enum Description
    IssueSeverity
    Describes the desired severity of an Issue.
    IssueState
    Describes the desired state of an Issue.