All Classes

Class Description
AbstractActionBasedWorkflowActivity<M extends Model>
Default base class for implementing ActionBasedWorkflowActivity
AbstractDefaultingHashMap<K,​V>
Identical to HashMap, except a call to AbstractDefaultingHashMap.get(Object) for a nonexistent key will call AbstractDefaultingHashMap.newDefaultValue(Object) and put() the resulting value, then return that.
AbstractGroovyServerTest
Base class for server-tests written in Groovy.
AbstractInboundProcessor
Simplified base class for implementing InboundProcessor.
AbstractPolicyHierarchyDef
A Policy Hierarchy determines the path of "parents" to navigate through when fetching a policy value for a model.
AbstractServerTest
Tests which run within the container should extend AbstractServerTest and use the naming convention *ServerTest.
AbstractServerUITest
Base class for UI Tests which should execute inside the Platform server (via Cactus).
AbstractSqlResultHandler
Convenient base class for implementing SqlResultHandler.
AbstractStatelessSessionBean
You generally should not need to use EJBs in platform applications; this is provided primarily for backward compatibility.
AbstractTableListener
Convenient base class for implementing TableListener.
AbstractTaskPerformer
Abstract implementation of TaskPerformer which is recommended as the base for all clients.
AbstractTaskType  
AbstractTaskWriter
Recommended base class for implementations of TaskWriter.
AbstractTimeBasedWorkflowActivity
Default base class for implementing ActionBasedWorkflowActivity
AbstractUIContext  
AbstractUITest
Base class for selenium-based "UITest" classes.
AbstractUnitTest
Tests which run outside the container should extend AbstractUnitTest and use the naming convention *UnitTest.
Achievement
Captures an individual user's progress toward a specific Achievement on a specific day, week or month.
AchievementConfig
Configurations to establish rules for achievements within the organization.
AchievementConfigUser
Java class for AchievementConfigUser complex type.
AchievementEvent
Captures a single event of progress toward an Achievement.
AckAwaitConfig
An AckAwaitConfig represents wait on queue/interface/version pair with the final destination and total time out duration.
AckAwaitConfigs
An AckAwaitConfigs represents the await relationship between the waiting queue/interface/version pair and the list of wait on queue/interface/version pairs.
AckRequest
An AckRequest(Acknowledgment Request) represents a message that waits Acknowledgment from receiving Platform Instance(AckRequestedFrom) confirming delivery to the Final Platform Instance(FinalDestination)
AckResponse
An AckResponse represents a Message with it's Final Platform Instance(FinalDestination) and Acknowledgment requester(AckSendTo).
ActionBasedWorkflowActivity<M extends Model>
Interface for an activity in an action-based workflow (a workflow initiated by executing a write action on a Model).
ActionBasedWorkflowContext<M extends Model>
Describes the execution context for an activity in an action-based workflow.
ActionListAsyncThresholdComputation
Implement this interface to enforce asynchronous execution of Action list, i.e.
ActionPermissionRequest
Helper class containing action information to apply custom model permissions during write operation
Address
An international Address, consisting of a Country and a collection of components (see AddressComponent).
AddressComponent
A single component of an Address.
AddressComponentType
Enumeration of types of components which can go into an Address.
AddressFieldChange
Represents a single field change suggested by an AddressValidation request
AddressImpl
Stub for AddressImpl to compile platform-api code.
AddressService
Service for working with Address objects.
AddressTriggerField
Represents an instance of One.form.AddressTriggerField.
AddressValidationResult
Represents the result from a AddressValidation request.
AddressValidationService
AddressValidationService is used to acquire a AddressValidator based on its fully qualified class name or alias.
AddressValidator
AddressValidator represents an address validation service and an API key to that service.
Alert
An Alert is persisted when an Issue is flagged by an Issue Computation in studio, and a user has an IssueSubscription which requests "System" delivery.
AlertDigestDeliverySchedule
Captures the schedule for which the system can send out digests of alert emails (instead of individual emails).
Anonymizer
Provides API for Anonymizer implementation.
AnonymizerOverride
This model is used override the choice of anonymization strategy for a particular field in a particular model.
Arc
An Arc connects two Nodes in a NetworkMessage.
AsyncAction
Tracks the status of a user-initiated asynchrounous action execution through UI
AttachedNote
Represents a single note attached to a Model.
AttachedNotes
Represents the collection of all notes attached to a Model.
AttachedNoteService
Factory for creating AttachedNote-related objects.
Attachment
Represents a document attached to a Model, for example a Word or Excel document.
AttachmentService
Service to create and manipulate Model Attachments.
AttachmentsField
Represents an instance of One.form.AttachmentsField.
Attribute
A very generic model to hold the name and value pair for any model in the entire system.
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.
AttributeValue
The value of a field which may be one of several data types.
AutocompleteField
Represents an instance of One.form.AutocompleteField.
BaseCustomModelPermissionPolicy
Base implementation for CustomModelPermissionPolicy.
BaseEDIOutboundGenerator
Base class for Outbound Interfaces which generate EDI.
BaseFixLenOutboundGenerator
Base class for implementing an Outbound Interface which generates a Fixed Length file using "model-based" input.
BaseGrid
Base class for Grid component.
BaseIDocOutboundGenerator
Base class for implementing an Outbound Interface which generates an IDoc using "model-based" input.
BaseInboundFixLenProcessor
Implement this class to process an inbound fixed-length format file.
BaseInboundProcessingListener
Base class which defines event handlers for the events inside the InboundProcessor; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
BaseIXMEngineFactory
Base class for implementing IXMEngineFactory.
BaseModelLinkField
Base class for ModelLinkField component APIs.
BaseModelResourceListener
Base class which defines event handlers for the events inside the ModelResource; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
BaseNetChangeEDIOutboundGenerator
Base class for Outbound Interfaces which generate EDI for NetChange-based outbound.
BaseNetChangeFixLenOutboundGenerator
Base class for implementing an Outbound interface which generates fixed length format file using a "net-change" strategy.
BaseNetChangeIDocOutboundGenerator
Base class for implementing an Outbound Interface which generates an IDoc using a "net-change" strategy.
BaseOAGISOutboundGenerator
Base class for implementing an Outbound Interface which generates an OAGIS using "model-based" input.
BaseOutboundProcessingListener
Base class which defines event handlers for the events inside the outbound MessageHandler; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
BasePivotTable
TODO complete the class documentation
BaseProblemResourceListener
Base class which defines hook points within ProblemResource to allow modules to filter and modify responses to be sent to the client.
BaseReportResourceListener
A class which defines event handlers that will be called at different stages of the construction of report metadata.
BaseReportResourceListener.ReportExecutionContext  
BaseResource
Base class for a JAX-RS based RESTful web services.
BaseSOAPService
It is recommended that all SOAP Service implementations extend this base class.
BaseSysIdFixLenOutboundGenerator  
BaseTemplate
Ties together a ModelLevelType and JS class.
BaseTemplateResourceListener
Base class which defines event handlers for the events inside the TemplateResource; all of the methods in this class have default implementations, so a subclass only needs to implement the methods it needs.
BaseTimelineViewListener
A listener class for Timeline that will be called at different stages: After Timeline view is executed successfully and the response is created After a Timeline export process is done and the excel Workbook is created.
BaseTLV
Base class for TLV component APIs.
BaseTLVEditHandler
Base class for handlers which implement save operations on a Timeline View.
BeanService
Bean factory which leverages Spring bean definitions.
BizLogger
BizLogger (short for "Business Logger") is used by modules to send textual messages and other structured data to a NoSQL data store which can be searched by a business user later.
BizLogger.Level
Enum for log level.
BizLoggerDimensions
Captures standard, widely-recognized dimensions against a BizLoggerDocument.
BizLoggerDoc
A BizLoggerDoc (short for "Business Logger Document") captures all the freeform text and structured data to be logged using BizLogger.
BlockRelationship
Model captures the information about an organization which is blocking other organizations from sending partner invitations.
BooleanField
Represents an instance of either Ext.form.Checkbox or One.form.BooleanField, depending on the markup present.
Box
Represents an instance of Ext.BoxComponent.
Bucket
An individual Bucket (or cell) within a DataMeasure.
Bucketization
Bucketization types
BucketizedValue
A BucketizedValue represents a single row in DB
BucketTransformer
Interface to be implemented by functions which aggregate and/or disaggregate raw data across multiple bucket types.
Buffer
Java class for Buffer complex type.
BufferLane
A buffer lane represents a transportation lane along which a particular item is transported from one site to another.
Button
Represents an instance of Ext.Button.
CalendarUtil
Utility class for Calendar and TimeZone related operations
Callback<M extends Model>
Interface for callbacks registered in the module or spt for actions defined in an mpt.
ChainEngineCondition
Stores various conditions which needs to be checked before starting execution of scheduled ChainEngine.
ChainEngineConditionLine
Represents a pre-condition for a scheduled ChainEngine.
ChainEngineConfig
Specifies order of engine runs for engine chaining.
ChainEngineConfigLine
Specifies order of engine runs for engine chaining.
ChainEngineRun
This model provides mapping between the ChainEngineConfig and GridJob models.
Charge
To charge a credit or a debit card, you create a Charge object.
ChargeAccount
ChargeAccount objects allow you to perform recurring charges and track multiple charges that are associated with the same ChargeAccount.
ChatWindow
Represents a window that contains all of the Chat Containers.
CheckboxGroupEnumField
Represents an instance of One.form.EnumCheckboxGroup.
ClassLoaderService
Class loader service for SPT
ClobProperty
A very generic model to hold the name and CLOB value pair for any model in the entire system.
Collaboration
Used to coordinate the execution of tasks across organizations.
Collaboration
Represents Selenium component for Workbench Collaboration
CollaborationLine
Java class for CollaborationLine complex type.
ColumnJSONObject
A JSONObject used by reports to describe a column in the report's table
CommandCenter
Used to interact with the Command Center, performing actions such as logging in with a given username/password and opening menu items.
Comp<M extends Model>
A computation (Issue, Valication, etc) which can be invoked in the context of an action-based workflow.
ComplexSchedule
A complex schedule, composed of ComplexScheduleElements.
ComplexScheduleElement
A complex schedule element, composed of optional parts for month, day of month, day of week hour of day and minute of hour.
Component
This is the base class for all classes in this package; it is also the base class for any component fetched using UIContext.createComponent(String, WebElement) (which is driven by its internal componentMap).
CompositeField
Represents an instance of One.form.CompositeField.
ConcurrencyVersionRetrieval
Used to form the concurrencyVersion retrieval clause of a Model query.
Condition<T>
Utility allowing one to "await" a certain "condition" to occur.
Condition.Supplier<T>
Function used to compute a value in a Condition.
Condition.Test<T>
Function used to validate a value in a Condition.
ConfigurationService
Provides insight into server configuration paths and URLs.
ContactInformation
Java class for ContactInformation complex type.
Container
This class represents an instance of Ext.Container.
ContextResolver
Resolver class to resolve the context to process an inbound message.
Country
Interface for a Country referenced by an Address.
CountryCodes
Contains static variables for Country instances, and a method for getting a Country from its string representation.
CrossReference
This model represents an external system and field, and it is intended to be used in conjunction with CrossReferenceValue to maintain a set of value mappings between the external system/field and the internal ONE representation.
CrossReferenceValue
This model represents a mapping between an external system's value and the internal ONE value for a specific CrossReference instance.
CsvConsolidatedValidationErrorsFormatter
This is used in conjunction with ConsolidateValidationErrors flag of CsvModelWriteProcessor related to InboundInterface CsvConsolidatedValidationErrorsFormatter can be used to format consolidated errors for CSV according to implementation of format()
CsvRow
Represents a row of values parsed from a CSV (comma-separated values) file.
CsvService
Service for converting between CSV and Model objects.
CsvTransformContext
Provides contextual information around the current CSV Transformation, for example what user/role is executing the transformation.
CsvTransformer
Interface to be implemented by clients who wish to transform a row of Comma-Separated Values.
CsvTransformException
Exception which can be thrown from CsvTransformer#transform(CsvRow) to indicate that a row could not be transformed properly.
CurrencyCode
Three-letter currency code.
CurrencyConversionAPI
This is used only by those who implement currency conversion around new third-party services.
CurrencyConversionAPIUnavailableException
Thrown when Currency Conversion API is not available.
CurrencyConversionFactor
This model is used when the API of a CurrencyConverter is "Data".
CurrencyConversionService
Service for converting a monetary amount from one currency to another, at a given point in time, using a specific currency "API".
CurrencyConverter
This model is used to define a converter for an Org - it identifies the underlying API (data-driven, external web service driven, etc.).
CustomEmailTemplate
Captures the custom email templates for an Organization to be used by the Alerts email
CustomModelPermissionPolicy
Implement this interface to enforce custom model permissions on top of framework read/write permissions.
Dashboard
Represents an instance of a Dashboard.
DataAccess
Indicates that the annotated class is a data access object.
DataMeasure
A DataMeasure represents a single row in a view of a Timeline.
DataSink
One node of a DataSink tree that contains data read from a Flat File.
DataSinkDef
One node of a DataSinkDef tree that defines data to be read from a Flat File.
DataSinkService
Used to register and retrieve DataSinkDefs.
DataSource
One node of a DataSource tree that holds data to be written to a Flat File.
DataSourceDef
One node of a DataSourceDef tree that defines data to be written to a Flat File.
DataSourceService
Used to generate bindings for a tree of DataSources.
DataTemplateService
API for loading data from a template file similar to LoadData.xml.
DateRange
Interface representing a Date range, using Calendar objects.
DateRangeField
Represents an instance of One.form.DateRange.
DateRangeValue
The default implementation of DateRange.
DateTimeField
Represents an instance of One.form.DateTimeField.
DefaultingHashMap<K,​V>
Default implementation of AbstractDefaultingHashMap which will create a new Value object using the default constructor of a given class.
DefaultModelActions
The following actions are generated by default for all models.
DelimiterTransform
Use this transform to write the payload with a custom delimiter instead of the delimiter specified on the interface for outbound messages and for inbound messages, use this transform to convert the payload with a custom delimiter to the one specified on the interface.
Difference
Captures difference between values of field in two Model instances.
DimensionsField
Represents an instance of DimensionField
DisplayField
Represents an instance of either of the following: Ext.form.DisplayField One.form.FieldTypeDisplayField
DMSaveException
This exception can be thrown to indicate an error occurred during DM write invocation.
DocTypePerm
A set of rules governing the ability of a user to read/write a doc type based on their role type and how their role's orgs align with the parent transaction's orgs.
DocumentType
Represents a type of document which is associated to a "parent" transaction (like a Shipment or Order), and is either generated on-demand, or uploaded and attached by a user's action or a server process.
Domain
Indicates that the annotated class manages the "domain" of a particular model.
DoNotWriteException
RuntimeException that can be thrown from BaseModelResourceListener.beforeActionExecuted() to bypass the default functionality of the ModelResource (which is to write the Model).
DurationField
Represents an instance of One.form.DurationField.
DurationValue
This will be used to provide the duration value for an attribute.
DynaFieldComp
Child model of DynaFieldDef which persists components in the DynaField.
DynaFieldDef
Data model for dynamic field componets.
DynamicChunkingContext
Stores the context for a DynamicCsvChunker
DynamicCsvChunker
Interface used to dynamically chunk a large integration file into smaller pieces.
DynamicLoad
This class provides a safe way to invoke Class.forName and loader.loadClass
DynaTriggerField
Represents an instance of One.form.DynaTriggerField.
DynKPIFamilyDef
A DynamicKPIFamilyDef is similar to a KPIFamilyDef, in that it can be referenced by a KPIDef and used to generate KPI.
EDI824ErrorDef
A type of ErrorDef which is exclusively used to capture the error details for EDI 824.
EDI824Service
The EDI824Service class has common methods to help create 824 transaction set create 824 envelope create generic EDI824ErrorDef create EDI824ErrorDef when business error occurs
EdiConfig
EDI configuration details like identifiers and delimiters for a partner
EDIConfigService
EDIConfigService is used to manage EDIConfig records and their relationship with Partners.
EDIConstants
TODO complete the class documentation
EDIDelimiters
EDI Delimiters
EDIEnvelopeInfo
Contains ISA,GS, ST control numbers and delimiters required by EDI Envelope.
EDIErrorDef
This class captures EDI errors
EdiForward
Used to forward a copy of an EDI message to a given queue, any time it matches specific criteria (like sender/receiver).
EDIFwdListener
Listener for EdiForward to facilitate customizing of forwarding rules and payload content
EdiInboundRoute
Defines which EDI mapper to pick for Incoming EDI transactions based on the Transaction Set and Sender and Receiver GS IDs.
EDIMapper
Abstract class for EDIMapper providing various methods for processing and creating EDI messages.
EDIMessage
A container of both EDI Envelope and its corresponding Message.
EdiMessageQueue
Captures information for all inbound and outbound EDI Messages (as well as SAP IDocs) received or sent by the Platform.
EdiMessageTransform
Can be used to transform/massage an inbound or outbound Message (EDI messages only) prior to processing
EDIMessagingContext
EDI Messaging Context contains the current messaging context details pertaining to an EDI.
EdiMonitorPartnerOverride
Overrides EdiMonitorSettings with custom rules per partner pair.
EdiMonitorSettings
Defines rules for validating that EDI messages have been properly processed/acknowledged/etc.
EdiMQTransRef
Captures multiple transaction reference numbers (shipment numbers, order numbers) associated with a single EdiMessageQueue record.
EdiOutboundRoute
Defines which EDI mapper to pick for Outgoing EDI transactions based on the Transaction Set and From and To Organizations.
EDIService
EDIService is used when generating and processing EDI messages.
EDITransactionSetFactory
Platform wrapper around OBOE TransactionSetFactory.
EINTypeAvailability
This model will be used to add/udpate EIN Type for countries.
EmailAttachment
Describes an Attachment which can be added to an EmailNotification.
EmailNotification
Sends an email when given to NotificationService.
EncryptionService
Provides APIs for encrypting or decrypting a string if encryption is enabled otherwise it's a no-op.
Enterprise
Entire business group comprising of all local and international main and sub offices or organizations.
EnterpriseEINs
This model will be used to add/udpate EINType/EINValue combinations for an enteprise.
EnterpriseObject
Generic model to support the enterprise level modeling in the EPT
EntityGroupRoleAssoc
Associates entity groups with roles
EntQueueSubsPerm
This model provides mapping metadata for IntegrationSubscription generation process.
EntRoleType
A model for capturing enterprise specific role type information.
EntRoleTypeBase
Captures the role types on which this enterprise specific role type is based on.
EntRoleTypeExclusion
A model for capturing all the exclusions (menus, menu actions, actions and global screen elements) for enterprise role types.
EntRoleTypeInclusion
A model for capturing all the inclusions(menus, menu actions, actions and global screen elements) for enterprise role types.
EnumConversionDef
EnumConversionDef defines the "Base Unit" which is used as the pivot point for converting between enumeration values
EnumConversionFactor
EnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent EnumConversionDef's BaseUnit
EnumDependency
Model to specify the relationship between a "child" enumeration whose valid values are constrained by the selection in an earlier "parent" enumeration.
EnumFieldDependency
Specifies an instance of an enumeration which appears on a particular model and ties it to another field on that model.
EnumPreferences
Defines preferences for enterprise specific enumeration, i.e.
EPTContextListener
Reload event messages for EPTs.
EquipmentType
Various forms of conveyances for goods movement.(Ex., van, flatbed, reefer, etc.)
ErrorDef
TODO complete the class documentation
ExecutiveDashboard
The ExecutiveDashboard model is used to capture the "higher level" executive dashboard under which different board groups are stored.
ExternalReference
General-purpose lookup table for mapping external values to internal.
ExternalReferenceService
Service to get external or local values from the PLT.ExternalReference model.
FeatureSubscription
A model for subscribing features for an enterprise.
FetchParam
Used to specify what levels of a Model should be fetched when calling populateCurrentFromDatabase(ActionBasedWorkflowContext, FetchParam...).
FetchType
Enumeration of fetch options used by FetchParam when getting the current state of a Model from the database.
Field
Captures field meta-data including id, type, etc.
FieldErrorDef
ErrorDef for EDI field level errors
FieldId
Uniquely identifies a field by its level ("table") and name ("column").
FieldService
Service for instantiating Field and FieldId instances.
FieldType
Marker interface for the data types associated with Field objects.
FieldTypes
List of all available FieldType as static constants.
Files
Utility class for File related operations
FileSizeUnit
Represents various File size units.
FilterJSONObject
A JSONObject used by reports to contain form field configs for report filters
FilterOverlay
Represents an instance of One.filter.FilterOverlay.
FixLenDef
Stub for FixLenDef to compile platform-api code.
FixLenField
Java class used to represent a field value parsed from a fixed-length format file.
FixLenFieldDef
Stub for FixLenFieldDef to compile platform-api code.
FixLenRow
Represents a row of values in a fixed-length format file
FixLenService
FixLenService is used when processing fixed length messages.
FMConditionalFormatWindow
TODO complete the class documentation
FMFilterLabelView
TODO complete the class documentation
FMFiltersSubview
TODO complete the class documentation
FMFilterTable
TODO complete the class documentation
FMFilterValuesView
TODO complete the class documentation
FMFilterWindow
TODO complete the class documentation
FormatValues
FormatValues is used for encapsulating date-time formatting data, such as the AM/PM symbols used for date-time formatting.
FormJSONObject
a JSONObject used by reports to describe available filters
FormPanel
Represents an instance of Ext.form.FormPanel
ForwardingRemoteRunner
Remote-capable JUnit4 test runner that takes responsibility of sending remote run requests, but on server side delegates actual test execution to separately configured runner instance.

By default, this runner will delegate to the basic JUnit4 test runner.
Frame
This class represents a frame within the page.
GenericModelLinkField
Represents an instance of One.form.GenericModelLinkField.
Geo
Geographic information associated with a single Node.
GeoLanePattern
A Geo Lane Pattern represents a From Region (a GeoPatternList) and a To Region (a GeoPatternList).
GeoLanePermission
Defines permissibility for Roles based on Geo Lanes.
GeoPattern
A Geographical(Geo) Pattern defines a very specific geographical area.
GeoPatternList
A Geograhpical(Geo) Pattern List groups a set of Geo Patterns, each of which defines a specific geographic area.
GeoPermission
Java class for GeoPermission complex type.
GlobalScreenElement
interface implemented by Operation object
GlobalScreenElementService
Provides APIs for reading GlobalScreenElement.
GlobalSearch
Represents an instance of TMS.QuickSearchPanel, TMS.form.QuickSearchPanelMenu.
GlobalSearchContainer
Represents an instance of TMS.form.QuickSearchPreferencesPanel which is part of GlobalSearch component.
Grid
Represents an instance of Ext.grid.EditorGridPanel.
GridIE
Grid component class to handle IE browser specific APIs.
GridJob
In-memory representation of a Grid Job (a collection of related Grid Tasks).
GridJobListener
A listener class for GridJob that will be called at different stages during its life-cycle.
GridJobWaitException
TODO complete the class documentation
GridService
Service for working with the Computational Grid, including APIs to work with GridTask and GridJob objects.
GridTask
In-memory representation of a Grid Task.
GridTaskContext
Provides contextual information about a GridTask to an AbstractTaskPerformer.
GridTaskWaitException
Exception thrown when GridService.await(Long, long, long) is taking more then the given wait time to finish.
HeatMapDef
Identifies a HeatMap which can be executed in the ONE Executive Dashboard.
Helper
Indicates that the annotated class is a helper object.
HierEnumConversionConfig
Config class for conversion of UOM defined in HierEnumConversionDef.
HierEnumConversionData
Data class for conversion of UOM defined in HierEnumConversionDef.
HierEnumConversionDef
HierEnumConversionDef defines the "Base Unit" and scope which is used as the pivot point for converting between enumeration values
HierEnumConversionFactor
HierEnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent HierEnumConversionDef's BaseUnit and Scopes
HomePagePlugin
This plugin is executed upon Command Center visit and is used to inject js/html/css into the home page.
HomePagePluginRegistry
Provides methods to register and retrieve HomePagePlugins
Hyperlink
Represents a hyperlink within the markup.
IDesktop
This interface needs to be implemented by NeoDesktop CommandCenter and declares the common methods in both the classes
IDoc
Represents an instance of an SAP IDoc.
IDocDef
Stub for IDocDef to compile platform-api code.
IDocElement
Base class for an element of an IDoc.
IDocField
An individual field in an IDocSegment.
IDocFieldDef
Stub for IDocFieldDef to compile platform-api code.
IDocMapper
Abstract class for an IDoc integration mapper.
IDocSegment
A segment within an IDoc.
IDocSegmentDef
Stub for IDocSegmentDef to compile platform-api code.
IDocService
IDocService is used when processing IDoc messages.
Image
Image is used to capture an uploaded image, a set of "edits" to make it make it more display-friendly, and its association another data model (like User)
InboundCsvTransformer
Base class for all CsvTransformers, extending this class allows us to add more methods without breaking backward compatibility.
InboundProcessingEvent
Interface for handling events in the lifecycle of the Message
InboundProcessor
Interface for processing inbound Messages.
IntegMapping
General-purpose lookup table for mapping external value to ONE value and vice versa.
IntegMappingService
Service to get external or ONE values from the PLT.IntegMapping model based on the parameters.
IntegrationConnection
Holds properties for specific types of integration connections: SFTP, AS2, VAN etc.
IntegrationContext
Context for parameterizing the behavior of various integration services.
IntegrationSubscription
IntegrationSubscription allows Enterprises to subscribe to events on models or define scheduled execution and send outbound integrations based on those events.
IntegrationSubscriptionQueue
Java class for IntegrationSubscriptionQueue complex type.
InteractiveSimulation
An "interactive simulation" is a series of steps used for demonstration purposes, where rather than executing actual UI actions, a user can click "Run" on each step to simulate the end user UI actions in the backend
InteractiveSimulationStep
Java class for InteractiveSimulationStep complex type.
InteractiveStepHandler
Base class for InteractiveSimulation
InterchangeInfo
Bean which captures interchange ids and qualifiers for sender and receiver.
InterfaceListener
Allows developers to execute tasks during the life cycle of inbound and outbound message processing.
InterModuleAPI
Marks a class as an "Inter-Module API".
Invoice
An invoice is a document issued by Invoicer(Seller) to the Invoicee(buyer), indicating the products, quantities, and agreed prices for products or services the Invoicer has provided to Invoicee.
InvoiceHold
An InvoiceHold is used by Accounts Payable to flag errors on an Invoice and its Invoice Lines, and thereby prevent Payment of the Invoice until the holds are cleared.
InvoiceLine
Java class for InvoiceLine complex type.
InvoiceLineDetail
Java class for InvoiceLineDetail complex type.
IPerspective
Interface to represents the frame WebElement in the Neo UI
IsolatedServerTest
Server Test runner variant that sends separate execution requests for each test method.
Issue
Interface for an Issue which can added to a Model to turn the Issue on and off in the database.
IssuePersistentProperties
Utility class to support additional properties on the Issue object which can be stored in the database.
IssueProblemRole
This specifies what roles will be allowed to view problems that Issue Subscriptions generate when alerts are fired by the system.
IssueService
Service to facilitates the execution of issue computations through time-based workflows.
IssueSeverity
Describes the desired severity of an Issue.
IssueState
Describes the desired state of an Issue.
IssueSubscription
Captures a "subscription" of a user to a particular Issue, including user-provided filters to refine the circumstances under which the Issue should be considered for Alert creation.
IssueSubscriptionFilter
Captures the data for an individual filter within a user's Issue Subscription.
IssueSubscriptionHelper
Utility class for IssueSubscription
Item
Any object or a 'thing'
ItemSubstitution
Used to specify item substitution characteristics such as start/end dates, type of substitution.
ItemTaxCode
Captures item-specific codes used by Tax Provider services for calculating sales and other taxes.
IXMEngine
Implements the core algorithm for a given IXM Engine.
IXMEngineArgs
JSONObject extended to support values of types Date and List
IxmEngineConfig
This model is used to configure the deployment of an IXM engine at a cluster-wide level
IXMEngineFactory
Each IXM Engine implements this factory interface to create objects required for plan execution.
IXMEngineJmxService
This Interface provides the name and type of the parameters that are necessary to invoke the engine using a JMX MBean.
IxmEngineNodeConfig
This model is used to configure the deployment of an IXM engine at a specific node level
IXMEngineTaskGenerator
Generates TaskInfo objects, one for each task required for the given task filters.
IXMEngineTaskWorker
Provides a hook for responding to failed engine runs.
IXMException
This exception can be thrown to indicate an error occurred during IXM Engine invocation.
IXMHooks
Datasets may optionally provide a subclass of IXMHooks called sptname.sptversion.customAPI.ixm.CustomIXMHooks.
IXMPlanParameters
Marker Interface for plan parameters given to an engine for execution.
IXMPlanResult
Captures the results of an IXM Engine run.
IXMService
Service for Interactive eXecution Manager (IXM) engines.
IxmTaskGeneratorSchedule
Used to customize the schedules under which a particular engine can run
JobState
Describes all possible values of GridJob.getState().
JoinedIssueSubscription
Allows users to join the IssueSubscription published by other users in the same enterprise.
JsonHelper
A helper class for working with JSON data.
JSONService
Service for converting between JSON and Model Objects.
JsonTransformer
Interface to be implemented by clients who wish to transform a JSONObject.
JsonTransformerContext
Transformer Context for a JSON transformation
JsonTransformException
Exception which can be thrown from CsvTransformer#transform(CsvRow) to indicate that a row could not be transformed properly.
JsUtils
TODO complete the class documentation
KeyedJSONArray
JSONArray subclass which allows any Object added which implements Identifiable
KPI
Stores a computed KPI value.
KPIDef
A KPIDef is meta-data which qualifies a KPIFamilyDef (defined in the module or EPT) with runtime parameters, UI parameters and boundary qualifiers.
KPIHistory
Captures historical values for the parent KPI, if available.
ListParam
A named parameter with multiple values.
ListUtil
Utilities for List manipulation.
Matchers
Hookpoint class enabling use of org.hamcrest Matchers in test framework.
Example usage:
MDFs
"Module-Defined Fields" marker interface.
Menu
Represents and instance of Ext.menu.Menu.
MenuAction
MenuAction is a MenuElement which will open a tab (or execute some other action) when clicked.
MenuDefinition
This interface represents the full set of menus that will be rendered on the UI for a particular User.
MenuElement
Base class for any menu element.
MenuFolder
"Folder" containing multiple MenuElements (including nested MenuFolders).
MenuPanelOptions
Configuration for opening a javascript "panel" with configuration options from a menu.
MenuResourceListener
Clients can subclass to modify Menu contents at runtime.
MenuService
Provides methods to use in order to register and use custom MenuResourceListener object.
Message
A model containing the metadata related to message, the payload itself is stored in the MessageStorageService.
Message
A message which can be stored in a Platform message queue.
MessageAlreadyEnqueuedException
Thrown in the event when the message is already enqueued - in other words, there is already a Message with the same Sender and Id stored in the system.
MessageBox
Represents a div within the ChatPanel.
MessageBundle
Source for internationalized messages.
MessageBundleFactory
Factory for MessageBundle instances.
MessageDestination
Captures a destination to which an outbound message can be routed, for example a filesystem or SFTP server
MessageDestination
Interface to be used by the OutboundMessageHandler during routing to send a Message to a destination.
MessageDetail
The MessageDetail model captures additional "record-level" information for integration messages to go along with the "message-level" information captured in the Message model.
MessageDetailLevel
Message detail levels which can be used for processing messages according to that into message detail table
MessageDetailService
Each Message can contain potentially contain thousands or even millions of records.
MessageHandler
Interface for classes which will process ("dequeue") a message
MessagePanel
Represents an instance of One.MessagePanel.
MessagePanel.MessageType
Enumeration of SUCCESS, ERROR and WARNING
MessageQueue
Describes the metadata for various Inbound and outbound Message Queues.
MessageQueueService
Allows for the enqueuing of new Messages, and the pausing/unpausing of existing queues.
MessageQueueServiceException
Base exception thrown when enqueue/dequeue or other messaging operations fail
MessageRoute
Routes outbound Messages to different MessageDestinations based on interface/queue/etc
MessageSource
Defines a "source" from which Messages can be "polled" by MessageSourcePolls and enqueued into an Inbound Queue.
MessageSourcePoll
Defines rules by which Messages are "polled" from a MessageSource and enqueued into an Inbound Queue.
MessageTransform
Can be used to transform an inbound or outbound Message prior to processing
MessageTransform
Extend this base class to transform a message payload during enqueue or dequeue of a Message.
MessageTransformContext
Provides contextual information around the Transformation
MessageTransformFailedException
Exception which can be thrown when message transformation fails during dequeue and task should be failed instead of retrying.
MessageWaitException
Exception thrown when Message#await(Long, long, long) is taking more then the given wait time to finish.
MissingRequiredParameterException
Since JAX-RS cannot enforce requiredness for http parameters, this exception can used to represent a missing parameter to a REST resource method.
MLModel
The machine learning model that contains the model id, version and an attachment to the trained model.
MLPlugPoint
A MLPlugpoint registered against the MPT to be picked which helps of identify the correct pipeline and finally the required trained model to perform the prediction.
Model
Common interface implemented by all Model objects.
ModelAPI
Interface for processing model rest resource.
ModelAPIPlugin
Interface for processing model rest resource.
ModelAttachment
Represents a document which can be attached to a Model.
ModelAudit<M extends Model>
Captures an audit entry for a Model.
ModelCsvTransformer
Interface to be implemented by clients who wish to transform a List of models to row of Comma-Separated Values.
ModelDataService
Provides APIs for reading and writing Models.
ModelDiffConfig
Class representing configurable options for finding out differences between two Model objects.
ModelFilter
Used to form the "WHERE" clause of a Model query.
ModelFormJSONObject
TODO complete the class documentation
ModelId
Utility class to hold a surrogate id and ModelLevelType.
ModelJsonCsvTransformer
Base class for all Model based CsvTransformers, and Model based Json transformer
ModelJsonTransformer
Interface to be implemented by clients who wish to transform a List of models to JSON objects.
ModelLinkAttributeValue
This will be used to provide the ModelLink value for an attribute.
ModelLinkAttributeValue.ModelLinkComponent
Java class for anonymous complex type.
ModelLinkComponent
A single component in a ModelLinkKey, with a name and value.
ModelLinkField
Represents an instance of One.form.ModelLinkField.
ModelLinkFieldIE
ModelLinkField component class to handle IE browser specific APIs.
ModelLinkKey
A ModelLink is a field on a Model which references ("links") another Model.
ModelList
TODO complete the class documentation
ModelList<M extends Model>
Contains a list of Models to be used in conjunction with the write* methods of ModelDataService.
ModelOutboundCsvTransformer Deprecated.
ModelOutboundGenerator
Model-based outbound generator which generates outbound data based on model objects given as input.
ModelOutboundInterfaceWriteRequest
Request to generate outbound data based on in-memory Model objects.
ModelOutboundProcessingContext
Processing context to generate outbound data based on in-memory Model objects.
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.
ModelQueryComponent
Marker interface for components of a query which reads Models.
ModelReference
Utility class to hold a surrogate id and ModelLevelType (i.e.
ModelResourceListener
Allows you to register a listener for a model for the ModelResource.
ModelRetrieval
Used to define the "SELECT" clause of a Model query.
ModelSort
Used to form the sort clause ("ORDER BY") of a Model query.
ModelValidationConfig
ModelValidationConfig is used to configure ValidationContexts to be used with ValidationService.
ModelWriteRequest<M extends Model>
Detailed request for writing Models, which includes parameters for changing natural keys, returning processed records, etc.
Module
Represents an SDK Module which is currently deployed in Platform.
ModuleContextListener
Startup and shutdown event messages for Modules.
ModuleInstanceConfig
marker interface
ModuleIntegrationService
Used for inter-module communication without introducing compile-time dependencies.
ModulePrivate
A marker annotation added to the getter/setter fields of a "private" field in a model.
ModulePublic
A marker annotation to identify a method as part of a Module's public api.
ModuleService
Provides information about currently deployed SDK Modules.
Movement
The movement forms the basic unit of transporation execution.
MovementStop
Movement Stop represents a stop that Carrier will be taking in movement move.
MovementStopLine
Movement Stop line represents all the details of Movement Stop like status and stop Number.
MsgProcessingContext
Model to resolve the user context either using ResolverClass or by fields pattern matching against message, to process the inbound message.
MsgQueueDependency
Declares dependency relationships, such that Queue 1 will not be dequeued while Queue 2 still has messages.
NamedMacro
A named macro for use with SqlService, taking the form ${name:param1,param2,etc}.
NeoAction
This Component deals with action button
NeoAddressMenu
This class represents the NeoAddress popup element of the react UI
NeoAddressTriggerField
This class represents the NeoAddressTrigger Field of the React UI
NeoAdvancedTable
Represents an instance of NeoAdvanced Tabulator table
NeoAlertInboxSlideout
Represents an instance of the Alert Inbox Perspective of Neo UI
NeoAlertWidget
Represents an instance of Alert widget popup from the Global sidebar TODO add support for filters and ComboFields
NeoAnalyticReport
Defines a "report" which is executed against a single Fact.
NeoAttachmentsField
This class represents the Attachments field component of react which can be used to upload files
NeoAutocompleteField
This field represents the AutocompleteFeild react Component
NeoBooleanField
Represents an instance of the Boolean fields on the NEO UI
NeoButton
Represents an instance of button field for Neo UI screens
NeoCheckBoxGroupField
Represents an instance of the checkboxgroup field on the NEO UI
NeoComboField
TODO complete the class documentation
NeoComponent  
NeoCompositeField
Represent an instance of composite field on the NEO UI
NeoContainer  
NeoCustomWidget
Defines a custom widget which has been added by the user.
NeoDashboard
Java class for NeoDashboard complex type.
NeoDashboard
This class represents the Dashboard container for the Neo UI.
NeoDashboardSubscr
Represents NeoDashboards subscribed by User.
NeoDateRangeField
Represents the date range react components.
NeoDateTimeField
This represents the NeoDateTimeField React Component
NeoDesktop
Used to interact with the NeoDesktop UI, performing actions such as logging in with a given username/password and opening menu items, favorites, User setting etc.
NeoDisplayField
This class represents the NeoDisplay Field.
NeoDurationField
Represents an instance of duration field for Neo UI screens
NeoFilterPanel
This class represents the NeoFilterPanel React component
NeoFrame  
NeoGenericModelLinkField
Class to represent NeoGenericModelLinkField react component
NeoGlobalSearch
This class represents the NeoGlobalSearch popup widget that is used to perform Global Search
NeoGlobalSidebar
Represents an instance of the Global sidebar of the NEO UI
NeoHyperlink
TODO complete the class documentation
NeoKPIConfig
Allows the override of TargetValues and ValueBands at the level of a NeoKPIDef plus one or more scopes.
NeoKPIDefConfig
This model allows runtime configuration of NeoKPIDefs, including filters and datasources.
NeoKPIValue
This model sits in OLTP (not DW) and stores pre-computed KPI values for NeoKPIDefs which use the Materialized option.
NeoLegacyPerspective
Represents an implementation of Frame class to represents older legacy components like TLV, Report etc
NeoMenuSearch
This class represents the NeoMenuSearch component used to perform Menu Search
NeoMessagePanel
Represents an instance of the Message panel on the NEO UI
NeoMessagePanel.NeoMessageType  
NeoModelLinkField
Class to represent NeoModelLinkField react component TODO implement methods like setMultipleValueInExact and select value from picker
NeoNotification
Model to support notifications.
NeoNotificationService
Service for publishing NeoNotifications.
NeoPerspective
Represents an individual perspective within the Neo Desktop.
Neophyte
A Neophyte is a small engine which will automatically find problems, look for any available Neo Prescriptions, and invoke those Prescriptions on a schedule.
NeoPrescription
Captures a prescription generated by Neo which can be used to solve a problem, either automatically or through directed user action.
NeoPrescriptionHandler
Interface to be implemented by handler class for NeoPrescription.
NeoProblemDetails
Represents an instance of Problem summary row.
NeoProblemSummary
Represents an instance of Problem summary.
NeoProblemWidget
Represents an instance of Problem widget popup from the Global sidebar TODO add support for filters, ComboFields and Model Link Field
NeoRadioGroupField
Represents an instance of radio group field for Neo UI screens
NeoReport
TODO complete the class documentation
NeoTabbedPane
Represents an instance of tab on the Neo UI screen
NeoTable
An object representation for the Web element Table used in the NEO UI
NeoTextAreaField
Represents an instance of the textarea field on the NEO UI
NeoTextField
Represents an instance of the input text fields on the NEO UI
NeoToggleField
Represents an instance of the Toggle field on the NEO UI
NeoUIContext  
NeoUserProfile
Represents an instance of User slide out popper providing direct access to functionalities like logout, switch User, Navigate to user settings view.
NeoWidget
This class represents an instance of NeoWidgets that are present on the Neo Dashboard
NeoWidgetFilter
Represents an instance of Neo widget filter window
NeoWindow
This represents element of NeoWindow component that generally refers to the pop-ups screens/windows
NetChangeOutboundGenerator
NetChange-based outbound generator which generates outbound data based on a date range.
NetChangeOutboundProcessingContext
Processing context to generate outbound data based on a net change query.
NetworkMessage
Top-level message which can be consumed by the NetworkWidget command center component.
Node
Represents a single node in a network of nodes connected by Arcs.
NodeDetail
This class is used to store node details on which current driver is running as a JSON Object
NodeExecHistory
Java class for NodeExecHistory complex type.
NoteOperation
Operations which can be performed on a note during a Model write.
NotePriority
Priority for an AttachedNote - high, medium or low.
Notification
Mark interface for different types of Notifications.
NotificationComp<M extends Model>
A computation for sending Notifications to users which can be invoked in the context of an action-based workflow.
NotificationService
Service for sending Notifications.
NotifierButton
Represents a special instance of Ext.Button.
NullConstants
These constants should be used in write APIs to signal that a value in the DB should be forcibly set to null.
OAGISMapper
Abstract class for an OAGIS integration mapper.
OAGISService
OAGISService is used when processing OAGIS messages.
OAuthIBClientApp
Where ONE is the Resource Server, OAuthIBClientApp is used to store client app ids given to external OAuth Client Applications by ONE.
OAuthIBToken
Where ONE is the Resource Server, an OAuthIBToken is granted to a Client App to make calls on behalf of a Resource Owner.
OAuthIBTokenReq
This model is used to store information relevant to the authorization *request* made by an external Client Application to ONE as Resource Server.
OAuthOBClientApp
Where ONE is the Client App, OAuthOBClientApp is used to store client app ids given to ONE by external Resource Servers.
OAuthOBService
Services related to "outbound" OAuth-based authorization, i.e.
OAuthOBToken
Where ONE is the Client App, OAuthOBToken is used to store tokens granted to ONE by a Resource Owner using an external Resource Server.
OAuthOBTokenReq
This model is used to store information relevant to the authorization *request* made by ONE as Client Application to the Resource Server.
OBFixlenFieldFormat
Defines the format of the fields that compose a record in a flat file.
OBFixlenInterfaceFmt
Roughly corresponds to a "flat file" to be sent outbound.
OBFixlenRecordFormat
Defines the format of a single record in a flat file.
OBFLRecordGroup
An ordered collection of OBFixlenRecordFormats that define the format of a flat file.
OBFLRecordGroupEntry
Primarily servers two purposes: 1) Decouple OBFixlenRecordFormats from OBFixlenInterfaceFmt so that they can be defined independently and reused.
OnboardingProgram
Program used for Onboarding.
OnceOnlySchedule
A schedule which will run exactly once, at the given date & time.
OnServerRunWith
Configuration annotation for forwarding remote test runners.
Order
Can refer to an order written as a requisition request to sell goods to a customer (sales order) or purchase goods from a supplier (purchase order).
OrderedAs<T>
Matchers to test if object is ordered in a particular way compared to the actual object.
OrderedAs.Kind  
OrderedAs.NaturalOrdering<U>  
OrderedUITest
You can optionally add the @OrderedUITest annotation to your UITest class methods to control the order in which they are run.
OrderForecast
An order forecast represents a prediction of what will need to be ordered for a given item at a site in the future.
OrderLineItem
Java class for OrderLineItem complex type.
OrderSchedule
Java class for OrderSchedule complex type.
Organization
Each Enterprise can contain one or more Organizations to describe different divisions/etc within the company.
OrgCode
A numeric, or alphanumeric, representation of text for exchanging commonly used information.
OrgEnumDependency
Model to specify the relationship between a "child" enumeration whose valid values are constrained by the selection in an earlier "parent" enumeration for an Organization.
OrgEnumPreferences
Defines preferences for organization specific enumeration, i.e.
OrgHierarchy
Identifies named hierarchies for orgs.
OrgHierarchyEntry
Provides the actual parent/child relationship for the orgs within a hierarchy.
OrgHierarchyService
Provides APIs for the Organization Hierarchy.
OrgListPerm
OrgListPerm is used to associate one or more Organizations with a model such as an Item or Shipment.
OutboundCsvTransformContext Deprecated. 
OutboundInterfaceWriteRequest
Encapsulates request parameters required to generate outbound data using a SQL Query without specific input like Model objects or surrogate ids.
OutboundMessageService
Service for generating outbound data using outbound interfaces from studio.
OutboundProcessingContext
Base class for the context provided to outbound processors.
OutboundProcessingEvent
Interface for handling events in the lifecycle of the Message
Page
Represents a screen within Command Center that displays a set of read-only or editable fields; if editable fields are present, an action button is also shown.
PageAction
Java class for PageAction complex type.
PageFlow
A set of Pages that work together to provide a full lifecycle of creating and modifying a model instance (e.g.
PageRelatedModel
Related model level to Page.
PageRoutingGuide
The Page Routing Guide is all the rules for routing to specific Page Flow.
PagingToolbar
Represents a CC 2.0 paging toolbar on a Report
Pair<X,​Y>
A simple container class for a typed pair of objects.
Param
A named parameter with a single value.
Partner
A uni-directional partnership, where one Enterprise specifies another Enterprise as its partner.
PartnerEDIConfig
The EDI configuration properties for a partner to override any default configurations.
PartnerInvitation
An organization can invite any other organization in the network to be its partner.
PartnerSite
Similar to Partner, Partner Site allows an Organization to reference another Organization's Sites using its own set of names.
PartnerTypeConfig
Java class for PartnerTypeConfig complex type.
Payment
Payment is a model to capture all payment details for an Invoice.
PaymentGatewayException
PaymentGatewayException captures errors raised by payment gateway API libraries.
PaymentGatewayService
Provides APIs for interacting with a Payment Gateway such as stripe.com.
PermissionContext
Helper class for custom model permission policy to set the permission context.
PermissionQueryContribution
A SQL fragment to be added to the where clause of a query to apply permissions
PermissionRequest
Abstract base class to apply custom model permission policies
Person
A Person is defined underneath a PersonSpace within an Enterprise.
PersonalizedIssueComp<E>
A computation for detecting an issue for which a user is subscribed.
PersonalizedIssueCompContext<T>
Contains the data required to compute a personalized issue.
PersonalizedIssueCompContext.SubscriptionUserInfo  
PersonIdentityMapping
A PersonIdentityMapping indicates that a Person within one PersonSpace is "the same" human as a Person from another PersonSpace in another Enterprise.
PersonSpace
A PersonSpace defines a namespace under which an Enterprise can store Persons.
PersonSpacePermission
By default, PersonSpaces are only accessible within an Enterprise.
Pipeline
A pipeline model is used to store information to automatically generate a series of sequentially executed tasks.
PipelineExecHistory
A PipelineExecHistory model is used to store execution information of pipeline.
PivotFieldsWindow  
PlatformELFunction
Stub for PlatformELFunction to compile platform-api code.
PlatformEvent
Simple event which is published/subscribed through PlatformEventService.
PlatformEventListener
Listener interface executed when an event is fired.
PlatformEventService
Service for publishing events and subscribing to events.
PlatformInstance
A PlatformInstance represents a deployed platform instance with name, url, authorization info and state defining inMaintenanceModeUntil field.
PlatformLevel
Introduces three new log levels beyond the log4j defaults: PlatformLevel.DEBUG_SQL, PlatformLevel.DEBUG_MEDIUM and PlatformLevel.DEBUG_DETAILED.
PlatformLogger
Platform logger (based on log4j) which adds convenience methods for additional log levels introduced by PlatformLevel.
PlatformRestClient
Simple REST client for calling Platform REST APIs.
PlatformUserContext
PlatformUserContext describes an end-user, and includes both their user information and their current role.
PlatformUserProfile
PlatformUserProfile represents the entirety of what is stored in an HttpSession for a given user.
PolicyHierarchyContext
Context pojo for AbstractPolicyHierarchyDef
PolicyService
Service used to read policy values.
PolicyValue
Model to hold the policies defined in MPT
Portlet
Represents intance of Portlet within a dashboard
PortletMenuResourceListener
Clients can subclass to modify Dashboard Portlet Menu behavior at runtime.
ProblemDetail
Represents Selenium component for Workbench problem detail
ProblemList
Represents Selenium component for workbench problem list.
ProductGroup
A group of products with similar characteristics, often used in production planning (or sales and operations planning).
ProductGroupLevel
Product Group Level Hierarchy.
PublicProfile
Profile of the organization which will shown to all other organizations
PushRecipient
Marker interface for creating recipients of push notification
PushRequest
Detailed request for sending push messages.
PushService
Convenience API for pushing notifications to the push server.
PushServiceException
Base exception thrown when push service operations fail
QueryRequest
Encapsulates a request to execute a SQL query, parameters bound and optional paging constraints.
QueueRef
Natural Key-based reference to a Message Queue.
ReadByKeyParams
Encapsulates all parameters which go into invoking read by key model resource programmatically
ReaderFieldJSONObject
a JSONObject which describes one field of the record definition
ReflectionSecurity
This class ensures only whitelisted list of classnames are allowed to be intantiated using reflection
RelatedModelAction
Java class for RelatedModelAction complex type.
RemoteCapableRunner
Base class for JUnit 4 test runners that execute tests on remote JVM.

It is assumed that client and server machine have same test classes and, to a certain extent, same runner implementations.
RemoteTestExecutor
Interface that describes an entity capable of executing JUnit tests on remote machine.

Exact mechanism of such test execution are deliberately unspecified, to allow more flexibility.
RepeatingSchedule
A schedule which repeats every N seconds.
Report
Represents an instance of One.Report, so it has the capability to support both views and reports.
ReportAPIResourceListener
An interface which defines event handlers that will be called at different stages of the construction of ReportAPIResource metadata.
ReportJSONObject
A JSONObject which contains all the metadata (and possibly data) for a report
ReportOutboundInterfaceWriteRequest
Request to generate outbound data based on a report favorite.
ReportPermissionRequest
Helper class containing report information to apply custom model permissions during report read
ReportRequest
Encapsulates all parameters need to execute a Report.
ReportSummaryHandler
Can be used to customize the behavior of the "summary" rows which can be attached to the end of a report to aggregate data within or across pages.
ReportSummaryRequest
POJO class for ReportSummaryHandler parameters
ReportSummaryRow
Stub for ReportSummaryRow to compile platform-api code.
ReportSummaryRow.SummaryCell
Stub for ReportSummaryRow.SummaryCell
RequestedRescheduleException
Exception to be thrown in the event task generator request reschedule for the task.
ResourceException
An exception which can be thrown from a resource and will result in a json message the client can consume with a user-friendly error message.
ResourceListener
Allows you to register a listener for a specific REST Resource.
ResourceListenerFactory
This class is used by a module to help make a REST Resource more extensible through the use of a listener pattern.
ResourceResponse
Resource response object which is specifically useful in the context of Platform UI components.
RestEnumeration
Used to document all enumerations used by the REST APIs of a module.
RestException
Any exception thrown by a REST API which includes this annotation will set the supplied errorCode and message as properties on a JSON in the HTTP 500 response.
RestFooter
Used to append documentation at the end of the generated HTML REST documentation.
RestObjectProperty
Used to document request or response body properties, i.e.
RestParam
Used to document QueryParam, PathParam or FormParam.
Cannot be used alone.
RestRequest
Used to describe the Request Body for REST resources which accept input using the entire body without specifically indexed parameter names.
RestResponse
Used to describe the Response Body for a REST resource.
Rider
Interface for creating transient 'rider' objects on top of models during action/workflow execution.
Role
Each User in the system can play one or more Roles.
RunInTransaction
Test rule that executes the test inside a transaction.
This rule is designed to be used for tests that execute inside a running container (i.e.
Sanitize
Utilities used to "sanitize" user input to prevent issues like XSS, SQL Injection, etc.
SAST
This class was built to help clean up SAST false positives and other issues
Scenario
Stub for Scenario to compile platform-api code.
ScenarioBuilder
Base class for building scenario baseline data from "real" data, and building scenario data from baseline data
ScenarioService
New public API for clients to create Scenarios and Scenario data
Schedule
Marker interface for all varieties of schedule.
ScheduleEntry
Captures all metadata related to a Scheduled job.
SchedulerService
Allows for the scheduling/cancellation of batch jobs.
Scope
Scope identifies a context within which the UOM service converts values.
ScreenshotOnErrorStatement
Testing framework statement that instructs runners to take a screenshot whenever internal statement throws exception.
SearchPageContext
Represents an instance of One.PagingToolbar.
SearchParams
Encapsulates all parameters which go into invoking generic search for model rest resource programmatically
SegmentErrorDef
This class captures EDI Segment errors
SeleniumRemoteWebDriver
Custom implementation for RemoteWebDriver
ServerTest
JUnit4 test executor that executes test on a remote server.
Service
Marker interface for stateless services.
ServiceLocator
Factory for acquiring instances of Platform services.
ServiceLocatorRegistry
Central registry for the ServiceLocator instance to be used at runtime.
Services
Provides a convenient static method for acquiring a service: Services.get(Class) is a shortcut for ServiceLocatorRegistry.getServiceLocator().getService(clazz).
SetUtil
Utilities for Set manipulation.
SharedDashPref
This model shows dashboards that are shared with other users
SharedFilesystemService Deprecated.
Use SharedStorageService to store files without client worrying about underlying storage.
SharedStorageService
A cluster of Platform nodes always shares a common file storage.
SharedStorageServiceResource
Represents a resource stored on common file storage.
SharedStorageServiceResourceHelper
Helper for manipulating SharedStorageServiceResource
Shipment
The Shipment model is used to represent the transfer of goods from one party to another.
ShipmentLine
Shipment Line represents the Goods' physical dimension in terms on Weight, Volume, Quantity etc.
Singleton
Singleton represents an individual item with a unique identifier.
SingletonLine
The Singleton Line is used to model non-serialized items which are part of the main Singleton.
Site
A physical location, owned by an Organization.
SiteGroup
Java class for SiteGroup complex type.
SiteGroupLevel
Java class for SiteGroupLevel complex type.
SiteLane
A site lane represents a transportation lane along which items can be transported from one site to another.
SiteRsrc
Location where the actual physical receipt of the purchased material from the carrier occurs.
SiteRsrcReservation
Site Resource Reservation represents the details of the pick up and delivery appointments created on shipment.
SlcFileCache
Model to store the mapping of attachment and cached file name with relative path on SLC(Sandboxed Lambda Cluster).
SMSNotificationProvider
To be implemented by those integrating with an alternate SMS gateway.
SMSNotificationRequest
POJO which contains request details for SMS sent
SMSNotificationResponse
POJO which contains response details about SMS sent
SMSNotificationService
Service for sending short message (SMS) to mobile phones.
SortDirection
Sort direction - ascending or descending.
SortingJSONObject
A JSONObject which contains data for sorting in reports
Spacer
A "spacer" provides a sizable space in a layout.
SplitPayloadTransform
SplitPayloadTransform splits a large payload and enqueue the smaller chunks.
SqlConstants
Constants relevant to SQL queries.
SqlDef
Stub for SqlDef to compile platform-api code.
SqlDefCsvTransformer  
SqlDefOutboundCsvTransformer Deprecated.
use SqlDefCsvTransformer
SqlDefQueryRequest
Encapsulates a request to execute a SQL query which is stored in a SqlDef.
SqlParams
Used to pass SQL parameter values when executing a query with SqlService.
SqlParams.Binding
Captures a DaoDataType + value.
SqlQueryRequest
Encapsulates a request to execute a SQL query, including the query to be executed, parameters bound and optional paging constraints.
SqlResult
SqlResult is an in-memory collection of SqlRows fetched from the database.
SqlResultHandler
Event handler which receives notifications during the executing of a query.
SqlResultHandlerException
Can be thrown by SqlResultHandler to abort processing of query results
SqlResultMeta
Describes the metadata related to a SqlResult.
SqlRow
Contains the result of a query executed through SqlService.
SqlService
SqlService can be used to execute adhoc queries, stored procedures, reports, and otherwise access the database directly.
StatusMessage
A Model status message - severity may be Error or Warning, based on the context in which it is used.
Streams
Utility class for manipulating java streams and other I/O classes.
StreamService
Service for Kafka stream processing
StrictEncodingJSONFormatter
Make an JSON text of JSONObject or JSONArray.
StringEnumerationField
Represents an instance of One.form.EnumComboBox.
StringUtils
Basic utilities for manipulating Strings.
SubscribedFeaturesService
FeatureService is an api that verify if a the feature enabled for a given user context.
SyntheticModel
This class represents a synthetic 1-to-1 relationship between 2 models.
SyntheticModelListener
This interface is intended to be implemented and provided when calling UserDefinedPageService#registerSynthetic1to1(String, Class, Class, String, SyntheticModelListener).
SysIdOutboundGenerator
SysId-based outbound generator to generate outbound data based on surrogate ids of models.
SysIdOutboundInterfaceWriteRequest
Request to generate outbound data based on surrogate id of models.
SysIdOutboundProcessingContext
Processing context to generate outbound data based on surrogate ids of models.
Tab
Represents an individual tab within Command Center.
Table
Interface for a Table with multiple rows/columns.
TableColumnsField
Represents an instance of TableColumnsField
TableJSONObject
A JSONObject used by reports to describe the table of the report including the record definition.
TableListener
Listener which can provided to an API which "constructs" a table (for example in ReportService) to allow for streaming management of table data, rather than bringing all into memory at once.
TableListenerException
Can be thrown by TableListener to abort processing of query results
TableMetaData
Captures information about the table's columns.
TableRow
Captures the values for a particular table row.
TabPanel
Represents a tab panel within a page (not to be confused with a top-level command center Tab
Tags
Can be used to annotate tests with additional "tags" for analytic purposes.
TakeScreenshotOnError
JUnit Method Rule which will take screenshot whenever a test fails.
By default, Assumption violations are not considered test "failures", so no screenshot will be taken.
If you want to take screenshots on failed assumptions, construct this rule using: {@code TakeScreenshotOnError.{@link #includingAssumptionViolations()};
Task
A Task which can be managed in ONE's Dashboard and may have dependency relationships with other Tasks.
TaskAwareScheduledRunnable
When implemented by a Runnable which is executed by the scheduler, the setGridTask() method will be called, supplying the GridTask which is being used to execute the schedule.
TaskGeneratorFilters
Filters given to the task generator to refine the tasks to be created.
TaskInfo
Encapsulates the information necessary to create task for invoking IXM Engines.
TaskPerformer
Classes implementing the TaskPerformer interface are created and called by the Grid Dispatcher to perform a task of the type returned by TaskPerformer.getTaskType().
TaskPerformerConfig
Describes the TaskPerformerConfig associated with a particular task type.
TaskPerformerThread
Interface implemented by threads used to run TaskPerformers.
TaskReqmt
Indicates a dependency between two Tasks.
TaskResult
At the end of task execution, a TaskPerformer returns a TaskResult to indicate whether the task succeeded or failed, if it failed then why, and finally whether a retry should be attempted.
TaskState
Describes all possible values of GridTask.getState().
TaskWriter
Use this instead of IXMEngineTaskGenerator for high-volume task generation.
TaxProvider
A TaxProvider encapsulates the logic required to make a request to some service (either internal or external) to determine the amount of tax due on a transaction.
TaxRequest
Represents a request to a TaxProvider for how much tax is due on a transaction.
TaxRequestLine
Represents a single line of a transaction that needs the tax due determined by a TaxProvider.
TaxResponse
A response to a TaxRequest.
TaxResponseLine
Contains a response for a single line of a TaxRequest.
TaxService
TaxService is used to acquire a TaxProvider based on its fully qualified class name or alias.
Template
This model is used to store information about a template, which helps change the display of a UI page based on the user that is viewing it.
TemplateDisplay
Represents an instance of One.tpl.TemplateDisplay.
TemplateDisplay.MenuOption
Represents available items from Manage Template Menu
TemplatePermission
This level is used to store information on a template's permissibility; it allows additional organizations to access a template, aside from the template owners.
TemplateResourceListener
Allows you to register a listener for a model for the TemplateResource.
TextAreaField
Represents an instance of Ext.form.TextArea.
TextField
Represents an instance of Ext.form.TextField.
Threads
Utility class for manipulating Threads.
TimeBasedWorkflowActivity
Interface for an activity in a time-based workflow (a workflow initiated by a schedule).
TimeBasedWorkflowContext
Describes the execution context for an activity in a time-based workflow.
Timeline
A Timeline is composed of one or more DataMeasure objects, scoped by a date range.
TimelineBuilder
Used by TimelineCalculator implementations to specify a Timeline (a sequence of buckets) at runtime.
TimelineCalculator
TimelineCalculator is used to override fixed buckets size for PreDefinedMixedBucketization in TLV.
e.g.
TimelineDefinition
Defines the overall bucketization for a Timeline View.
TimelineService
Various utility functions to manipulate Timeline generation.
TLV
Represents an instance of a TLV report.
TLV.DnDOperation  
TLV.TLV_CUSTOMIZATION_LEVEL  
TlvIE
TLV component class to handle IE browser specific APIs.
ToDo
To DO concept is a SINGLE USER CONCEPT.Will show all current user's ToDos
TransactionalServerTest
Annotate a ServerTest class with this and each test method will run in a transaction which is automatically rolled back at the end of the test.
TransactionErrorDef
This class captures EDI Transaction errors
TransactionSupport
This class supports executing code blocks with different transaction semantics than the default of "Required".
Transformer
Marker interface for for any kind of transformer.
TransformerContext
Base context for various transformers (including CSV, JSON, etc)
TreePanel
Represents an ext TreePanel, with expand/collapse available at each node.
UIContext
This class is best described as the "backbone" for Platform's Selenium API.
UIContext.Listener
Clients can register instances of this interface to receive notifications when UIContext objects are created.
UITablePrefJSONObject
JSON presentation of UITablePreferences & UITablePrefConstr models
UITablePrefJSONObject.ColumnPrefJSONObject
JSON presentation of UITablePreferences -> ColumnPreferences level
UITablePrefJSONObject.UITablePrefConstrJSONObject
JSON presentation of UITablePrefConstr model
UITablePrefJSONObject.UITablePrefConstrJSONObject.EnterpriseJSONObject
JSON presentation of Enterprise model
UITask
A simple interface with a run() method which can throw a checked exception.
UITestRunner
JUnit Runner which will take screenshots of undisposed selenium contexts before tearDown of a failed test method.
UndefinedConversionFactorException
This RuntimeException is thrown when a client requests a UOM conversion from UOMService but a suitable conversion factor is not defined.
UnsafeJsonpException  
UOMService
Provides APIs for the conversion of unit-of-measure values.
User
A user of the OneNetwork Platform.
UserABAC
UserABAC will be used to associate an user and ABAC
UserABACValue
Java class for UserABACValue complex type.
UserAssociation
Used to grant Roles to Users.
UserContextService
Service for acquiring and manipulating PlatformUserContext and PlatformUserProfile objects.
UserDefinedBucketizationFilter
Represents an instance of Timeline filter panel in FilterOverlay of User Defined Bucketization TLVs.
UserDefinedConstant
Holds the enterprise specific user defined constants to be used in the TLV computed expressions.
UserDefinedPageService
Service interface which allows you to register features for use within User-defined Pages.
UserGroup
A named group of Users.
UserGroupMember
Java class for UserGroupMember complex type.
UserRecipient
PushRecipient that uses user name and enterprise name as the identifier.
UserRequest
Used to request the addition of new users and other actions which a user needs administrator assistance to complete.
UserTermsAndConditions
Captures the terms and conditions which user should accept (if enabled using ExternalReference) before login to the system.
UserTermsAndConditionsSelector
Class to select UserTermsAndConditions appropriate for a given user
ValidatedFieldState
Represents the state of a model's field after validation rules are applied.
ValidatedModelState
Represents the state of a model after validation rules are applied.
ValidationCompilationRequest
Captures all information required to compile one or more ValidationPackages.
ValidationCompilationResponse
Captures the outcome of a ValidationCompilationRequest.
ValidationConstants
Constants used for model validation
ValidationContext
Describes a validation "context" (e.g.
ValidationEnterpriseLookupHandler
Used in conjunction with ModelValidationConfig.
ValidationFailureHandler
Interface for handling validation failures when registered through ModelValidationConfig.
ValidationPackage
Groups a ValidationRule with its associated ValidationRuleIf and ValidationRuleThen entries.
ValidationRequest
Captures all information required to execute one or more ValidationPackages.
ValidationResponse
Captures the outcome of a ValidationRequest.
ValidationRule
Defines a validation rule which can be run in a specific "context".
ValidationRuleIf
When *all* ValidRuleIfs evaluate to true, ValidRuleThens execute to perform the validation.
ValidationRulePart
Interface capturing the commonality between ValidationRuleThen and ValidationRuleThen.
ValidationRuleTest
Rules Test Model contains sample data for the context and subcontexts to test against the specified criteria to test if rules evaluate to correct results for the set of ValidationRuleIf and ValidationRuleThen for the rule
ValidationRuleThen
If *any* ValidRuleThen evaluates to false, the ValidRule as a whole is said to be invalid.
ValidationService
Use to register validation "contexts" (e.g.
ValidationSubContext
Describes a validation "subcontext".
ValidationWBProblemPopulator
Used in conjunction with ModelValidationConfig.
ValueBand
ValueBands are used to capture a set of value ranges and associated "status".
ValueBands
ValueBands are used to capture a set of value ranges and associated "status".
ValueChain
ValueChain is the top-level entity under which all other Models reside.
ViewPermissionRequest
Helper class containing view information to apply custom model permissions during read operation
ViewRequest<T extends Model>
Encapsulates all parameters which go into invoking a Model view programmatically.
WBGeo
This model is used to hold the Geo information for WBProblem for the referenced models, i.e.
WBProblem
This is contains specific problems to be displayed in the Workbench.
WBProblemAddtlModelRef
This model holds the additional ModelRef along with primary ModelRef available on WBProblem to reference problem to multiple entities For example, if WBProblem references both Shipment and Movement, Shipment will be persisted to WBProblem and Movement will be persisted on this model.
WBProblemDimension
Conceptually this is a child model of WBProblem, but it is kept as a related model instead since it may at times have high somewhat cardinality.
WBProblemHandler
Interface to be implemented by handler class for WBProblem.
WBProblemIssue
WBProblemIssue defines the linkage between classic, transactional Issue computations in Platform with the new Problem model.
WBProblemLine
This model links an additional ESG room and users to a problem.
WBProblemLineMember
Tracks invited users to the problem line.
WBProblemNote
This represents a note written for a problem.
WBProblemRole
An optional child of WBProblem used to limit access to the problem to specific role instances.
WBProblemRoleType
Only RoleTypes with rows underneath the parent WBProblemType are allowed to view WBProblems of that type.
WBProblemSharedOrg
This model stores the information of the WBProblem and the Organization of the owner's partners with which the problem has been shared.
WBProblemType
Describes a Problem Type for use within the Workbench.
WebHelper
Web helper
WhereClauseContribution
A SQL fragment to be added to the where clause of a query to apply in ModelAPIPlugin and ModelAPI
Window
Represents an instance of Ext.Window.
Workflow
Indicates that the annotated class is a workflow object.
WorkflowActivity
Marker interface for workflow activities.
WorkflowContext
Base for all flavors of workflow context.
WorkflowController
Indicates that the annotated class is a stateless "workflow coordinator", meaning a component to which one or more workflows delegate the bulk of their processing.
WorkflowService
Service which facilitates the implementation of action-based and time-based workflow activities.
WriteParams
Encapsulates all parameters which go into invoking write action for model rest resource programmatically
XMLService
Service for converting between XML and Java Objects.