One Network Platform - Server API

API specification for the One Network Platform Server.

The One Network Platform Server APIs facilitates the development of modular, multi-party networks. The API is divided into the following areas:

commonCommon, shared persistent models and related objects
dataServices for reading and writing data from the database, including both low-level SQL access and high-level Model reads and writes
envDescribes the operating environment, including what modules are deployed, a service locator, access to a shared filesystem, etc.
gridGrid computing infrastructure for parallel task execution
integIntegration support, including REST, asynchronous messaging and notifications
ixmIncremental eXecution Management engine for horizontally scalable planning algorithms
toolsMiscellaneous tools for development and deployment
workflowSupports the implementation of workflows to manage the lifecycle of Models
Packages 
Package Description
com.onenetwork.platform.anon  
com.onenetwork.platform.common
Contains models which are common to nearly all Platform applications, including User, Role and others.
com.onenetwork.platform.common.address
Support for a generic, international Address.
com.onenetwork.platform.common.addressvalidation  
com.onenetwork.platform.common.attachednotes
Allows one to attach an arbitrary number of "notes" to a Model, similar to a discussion thread on a forum.
com.onenetwork.platform.common.currency
Service and interface for currency conversion.
com.onenetwork.platform.common.date
Types and utilities related to Date handling.
com.onenetwork.platform.common.enums
Contains enumerations available in enumerated field types for all models.
com.onenetwork.platform.common.event
Provides a simple pub/sub mechanism, allowing Modules to collaborate in a synchronous, loosely-coupled fashion.
com.onenetwork.platform.common.exchangeframework  
com.onenetwork.platform.common.field
Standard interfaces for representing a "Field": a typed, named piece of data.
com.onenetwork.platform.common.issue  
com.onenetwork.platform.common.menu
Services and interfaces for manipulating menus in the user interface.
com.onenetwork.platform.common.module
Contains utilities used in Module development.
com.onenetwork.platform.common.neo  
com.onenetwork.platform.common.notification.sms  
com.onenetwork.platform.common.paymentgateway
Contains services for interacting with a "payment gateway" for charging customers (for example: stripe.com).
com.onenetwork.platform.common.paymentgateway.model
Contains data models which support PaymentGatewayService.
com.onenetwork.platform.common.screen
Service and interface for filtering global screen elements from UI.
com.onenetwork.platform.common.table
Standard interfaces for manipulating tabular data.
com.onenetwork.platform.common.task
Supporting classes related to the "Task" and "TaskReqmt" models.
com.onenetwork.platform.common.tax
Contains services for interacting with a "tax provider" which computes appropriate taxes based on government regulations.
com.onenetwork.platform.common.uom
Service and interface for converting between different units of measure.
com.onenetwork.platform.common.user  
com.onenetwork.platform.common.usercontext
Objects to represent and manipulate user credentials and preferences.
com.onenetwork.platform.common.wbproblem  
com.onenetwork.platform.data.model
APIs for reading and writing Models developed with the SDK.
com.onenetwork.platform.data.model.perm
Interfaces and helper classes for implementing customized permission policies on Models.
com.onenetwork.platform.data.model.policy
Services and supporting classes for the persistence and retrieval of module "policies" which drive application behavior.
com.onenetwork.platform.data.scenario  
com.onenetwork.platform.data.sql
Services for ad-hoc querying and other lower-level database access.
com.onenetwork.platform.data.template
Interface for loading data using a template file and variable bindings.
com.onenetwork.platform.data.tlv
"tlv" is short for TimeLine View - this package contains interfaces into the data fetched for a Timeline view in the user interface.
com.onenetwork.platform.data.validation
Provides services which allow end-users to define "validation rules" with Excel-like function syntax.
com.onenetwork.platform.env
Provides information about the environment into which Platform is deployed.
com.onenetwork.platform.env.bean
Provides services and annotations for dependency-injection support with Spring.
com.onenetwork.platform.env.bean.stereotype
Provides reusable annotations for commonly used Component variants.
com.onenetwork.platform.env.ept
Event message for Enterprise Process Template.
com.onenetwork.platform.env.home  
com.onenetwork.platform.env.module
APIs used to introspect SDK Modules.
com.onenetwork.platform.env.servicelocator
Simple service locator for acquiring instances of Platform service interfaces.
com.onenetwork.platform.features  
com.onenetwork.platform.grid
Interface into One Network's Computational Grid for parallel, dependency-aware task execution.
com.onenetwork.platform.grid.scheduler
Service for scheduling background jobs.
com.onenetwork.platform.integ
Common interfaces and utilities for used in integration.
com.onenetwork.platform.integ.csv
Supports the manipulation of CSV data - typically used in the context of inbound integration.
com.onenetwork.platform.integ.edi
Used for parsing, processing and generating EDI messages in X12 and/or EDIFACT format.
com.onenetwork.platform.integ.fixlen
Service for parsing "fixed-length format" files, i.e.
com.onenetwork.platform.integ.json
Service for converting between JSON and Model objects.
com.onenetwork.platform.integ.module
Provides classes for interacting with other Modules in a loosely-typed way (without adding explicit compile-time dependencies).
com.onenetwork.platform.integ.msg
APIs for using Platform's message queuing system.
com.onenetwork.platform.integ.notify
Services for sending email notifications.
com.onenetwork.platform.integ.oagis  
com.onenetwork.platform.integ.oauth
Service for integrating to external services through OAuth.
com.onenetwork.platform.integ.push
Push technology describes a style of Internet-based communication where the request for a given transaction is initiated by the server, not by the client.
com.onenetwork.platform.integ.rest
Infrastructure for implementing REST-ful web services using JAXRS.
com.onenetwork.platform.integ.rest.annotation
REST annotations, used primarily for documentation purposes when running the "rest-doc" target in ant.
com.onenetwork.platform.integ.rest.json
Standard JSON value objects passed in REST calls in standard Platform components, such as the the Report panel.
com.onenetwork.platform.integ.rest.model
Helper classes related to the Model Create/Detail framework, providing support for manipulating model view/action invocation results prior to returning to the client layer.
com.onenetwork.platform.integ.rest.network
Helper classes related to the "Network Widget" component in Command Center.
com.onenetwork.platform.integ.rest.problem
Helper classes related to Problems, providing support for manipulating problem-related queries prior to returning to the client layer.
com.onenetwork.platform.integ.rest.report
Helper classes related to the Report framework, providing support for manipulating report invocation results prior to returning to the client layer.
com.onenetwork.platform.integ.rest.template
Helper classes related to the Model Templates feature, providing support for manipulating template invocation results prior to returning to the client layer.
com.onenetwork.platform.integ.sap
Used for parsing, processing and generating SAP "IDoc" files.
com.onenetwork.platform.integ.soap
Infrastructure for implementing SOAP-based web services using JAXWS.
com.onenetwork.platform.integ.xml
Service for converting between XML and Java Objects.
com.onenetwork.platform.ixm
Interface into One Network's Intelligent eXecution Manager - leverages the Grid architecture to implement incremental planning algorithms.
com.onenetwork.platform.neonotification  
com.onenetwork.platform.report.summary  
com.onenetwork.platform.restapi  
com.onenetwork.platform.stream  
com.onenetwork.platform.tools.collections
Utilities for creating & manipulating java collections.
com.onenetwork.platform.tools.ejb
Classes for implementing Stateless Session Beans in Platform.
com.onenetwork.platform.tools.el  
com.onenetwork.platform.tools.i18n
Provides access to internationalized messages.
com.onenetwork.platform.tools.io
Utilities for manipulating java streams and other I/O classes.
com.onenetwork.platform.tools.log
Extensions of log4j used for logging in Platform.
com.onenetwork.platform.tools.test
Classes for implementing automated unit and functional test cases (both inside and outside the container).
com.onenetwork.platform.tools.test.junit4
Support for running JUnit4 tests in style of older Cactus Server tests.

This package consists of two client-facing classes: ServerTest IsolatedServerTest All other classes in this package are abstract and built to enable extensions.
com.onenetwork.platform.tools.test.junit4.rule
Custom JUnit4 test rules.

Includes following rules: RunInTransaction
com.onenetwork.platform.tools.test.matcher
Utilities supplementing the Hamcrest testing framework.
com.onenetwork.platform.tools.test.ui
Classes which are used for writing UI tests; they utilize the Selenium API to help interact with pages written with ExtJS and OneJS.
com.onenetwork.platform.tools.test.ui.components
A library of classes representing widgets in a Command Center user interface.
com.onenetwork.platform.tools.test.ui.components.ext.base  
com.onenetwork.platform.tools.test.ui.components.ie  
com.onenetwork.platform.tools.test.ui.neo  
com.onenetwork.platform.tools.test.ui.neo.components  
com.onenetwork.platform.tools.test.ui.neo.components.flexmonster  
com.onenetwork.platform.tools.test.ui.rule  
com.onenetwork.platform.tools.time
Utilities related to time and calendars.
com.onenetwork.platform.tools.util  
com.onenetwork.platform.workflow
Services to facilitate the implementation of model workflows.