Uses of Interface
com.onenetwork.platform.data.model.Model

Packages that use Model 
Package Description
com.onenetwork.platform.common
Contains models which are common to nearly all Platform applications, including User, Role and others.
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.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.sql
Services for ad-hoc querying and other lower-level database access.
com.onenetwork.platform.data.validation
Provides services which allow end-users to define "validation rules" with Excel-like function syntax.
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.oagis  
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.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.workflow
Services to facilitate the implementation of model workflows.

  • Uses of Model in com.onenetwork.platform.common

    Classes in com.onenetwork.platform.common that implement Model 
    Modifier and Type Class Description
    class  Achievement
    Captures an individual user's progress toward a specific Achievement on a specific day, week or month.
    class  AchievementConfig
    Configurations to establish rules for achievements within the organization.
    class  AchievementConfigUser
    Java class for AchievementConfigUser complex type.
    class  AchievementEvent
    Captures a single event of progress toward an Achievement.
    class  AckAwaitConfig
    An AckAwaitConfig represents wait on queue/interface/version pair with the final destination and total time out duration.
    class  AckAwaitConfigs
    An AckAwaitConfigs represents the await relationship between the waiting queue/interface/version pair and the list of wait on queue/interface/version pairs.
    class  AckRequest
    An AckRequest(Acknowledgment Request) represents a message that waits Acknowledgment from receiving Platform Instance(AckRequestedFrom) confirming delivery to the Final Platform Instance(FinalDestination)
    class  AckResponse
    An AckResponse represents a Message with it's Final Platform Instance(FinalDestination) and Acknowledgment requester(AckSendTo).
    class  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.
    class  AlertDigestDeliverySchedule
    Captures the schedule for which the system can send out digests of alert emails (instead of individual emails).
    class  AnonymizerOverride
    This model is used override the choice of anonymization strategy for a particular field in a particular model.
    class  AsyncAction
    Tracks the status of a user-initiated asynchrounous action execution through UI
    class  Attachment
    Represents a document attached to a Model, for example a Word or Excel document.
    class  Attribute
    A very generic model to hold the name and value pair for any model in the entire system.
    class  BaseTemplate
    Ties together a ModelLevelType and JS class.
    class  BlockRelationship
    Model captures the information about an organization which is blocking other organizations from sending partner invitations.
    class  Buffer
    Java class for Buffer complex type.
    class  BufferLane
    A buffer lane represents a transportation lane along which a particular item is transported from one site to another.
    class  ChainEngineCondition
    Stores various conditions which needs to be checked before starting execution of scheduled ChainEngine.
    class  ChainEngineConditionLine
    Represents a pre-condition for a scheduled ChainEngine.
    class  ChainEngineConfig
    Specifies order of engine runs for engine chaining.
    class  ChainEngineConfigLine
    Specifies order of engine runs for engine chaining.
    class  ChainEngineRun
    This model provides mapping between the ChainEngineConfig and GridJob models.
    class  ClobProperty
    A very generic model to hold the name and CLOB value pair for any model in the entire system.
    class  Collaboration
    Used to coordinate the execution of tasks across organizations.
    class  CollaborationLine
    Java class for CollaborationLine complex type.
    class  ContactInformation
    Java class for ContactInformation complex type.
    class  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.
    class  CrossReferenceValue
    This model represents a mapping between an external system's value and the internal ONE value for a specific CrossReference instance.
    class  CurrencyConversionFactor
    This model is used when the API of a CurrencyConverter is "Data".
    class  CurrencyConverter
    This model is used to define a converter for an Org - it identifies the underlying API (data-driven, external web service driven, etc.).
    class  CustomEmailTemplate
    Captures the custom email templates for an Organization to be used by the Alerts email
    class  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.
    class  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.
    class  DynaFieldComp
    Child model of DynaFieldDef which persists components in the DynaField.
    class  DynaFieldDef
    Data model for dynamic field componets.
    class  DynKPIFamilyDef
    A DynamicKPIFamilyDef is similar to a KPIFamilyDef, in that it can be referenced by a KPIDef and used to generate KPI.
    class  EdiConfig
    EDI configuration details like identifiers and delimiters for a partner
    class  EdiForward
    Used to forward a copy of an EDI message to a given queue, any time it matches specific criteria (like sender/receiver).
    class  EdiInboundRoute
    Defines which EDI mapper to pick for Incoming EDI transactions based on the Transaction Set and Sender and Receiver GS IDs.
    class  EdiMessageQueue
    Captures information for all inbound and outbound EDI Messages (as well as SAP IDocs) received or sent by the Platform.
    class  EdiMessageTransform
    Can be used to transform/massage an inbound or outbound Message (EDI messages only) prior to processing
    class  EdiMonitorPartnerOverride
    Overrides EdiMonitorSettings with custom rules per partner pair.
    class  EdiMonitorSettings
    Defines rules for validating that EDI messages have been properly processed/acknowledged/etc.
    class  EdiMQTransRef
    Captures multiple transaction reference numbers (shipment numbers, order numbers) associated with a single EdiMessageQueue record.
    class  EdiOutboundRoute
    Defines which EDI mapper to pick for Outgoing EDI transactions based on the Transaction Set and From and To Organizations.
    class  EINTypeAvailability
    This model will be used to add/udpate EIN Type for countries.
    class  Enterprise
    Entire business group comprising of all local and international main and sub offices or organizations.
    class  EnterpriseEINs
    This model will be used to add/udpate EINType/EINValue combinations for an enteprise.
    class  EnterpriseObject
    Generic model to support the enterprise level modeling in the EPT
    class  EntityGroupRoleAssoc
    Associates entity groups with roles
    class  EntQueueSubsPerm
    This model provides mapping metadata for IntegrationSubscription generation process.
    class  EntRoleType
    A model for capturing enterprise specific role type information.
    class  EntRoleTypeBase
    Captures the role types on which this enterprise specific role type is based on.
    class  EntRoleTypeExclusion
    A model for capturing all the exclusions (menus, menu actions, actions and global screen elements) for enterprise role types.
    class  EntRoleTypeInclusion
    A model for capturing all the inclusions(menus, menu actions, actions and global screen elements) for enterprise role types.
    class  EnumConversionDef
    EnumConversionDef defines the "Base Unit" which is used as the pivot point for converting between enumeration values
    class  EnumConversionFactor
    EnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent EnumConversionDef's BaseUnit
    class  EnumDependency
    Model to specify the relationship between a "child" enumeration whose valid values are constrained by the selection in an earlier "parent" enumeration.
    class  EnumFieldDependency
    Specifies an instance of an enumeration which appears on a particular model and ties it to another field on that model.
    class  EnumPreferences
    Defines preferences for enterprise specific enumeration, i.e.
    class  EquipmentType
    Various forms of conveyances for goods movement.(Ex., van, flatbed, reefer, etc.)
    class  ExecutiveDashboard
    The ExecutiveDashboard model is used to capture the "higher level" executive dashboard under which different board groups are stored.
    class  ExternalReference
    General-purpose lookup table for mapping external values to internal.
    class  FeatureSubscription
    A model for subscribing features for an enterprise.
    class  GeoLanePattern
    A Geo Lane Pattern represents a From Region (a GeoPatternList) and a To Region (a GeoPatternList).
    class  GeoLanePermission
    Defines permissibility for Roles based on Geo Lanes.
    class  GeoPattern
    A Geographical(Geo) Pattern defines a very specific geographical area.
    class  GeoPatternList
    A Geograhpical(Geo) Pattern List groups a set of Geo Patterns, each of which defines a specific geographic area.
    class  GeoPermission
    Java class for GeoPermission complex type.
    class  HeatMapDef
    Identifies a HeatMap which can be executed in the ONE Executive Dashboard.
    class  HierEnumConversionDef
    HierEnumConversionDef defines the "Base Unit" and scope which is used as the pivot point for converting between enumeration values
    class  HierEnumConversionFactor
    HierEnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent HierEnumConversionDef's BaseUnit and Scopes
    class  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)
    class  IntegMapping
    General-purpose lookup table for mapping external value to ONE value and vice versa.
    class  IntegrationConnection
    Holds properties for specific types of integration connections: SFTP, AS2, VAN etc.
    class  IntegrationSubscription
    IntegrationSubscription allows Enterprises to subscribe to events on models or define scheduled execution and send outbound integrations based on those events.
    class  IntegrationSubscriptionQueue
    Java class for IntegrationSubscriptionQueue complex type.
    class  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
    class  InteractiveSimulationStep
    Java class for InteractiveSimulationStep complex type.
    class  InterfaceListener
    Allows developers to execute tasks during the life cycle of inbound and outbound message processing.
    class  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.
    class  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.
    class  InvoiceLine
    Java class for InvoiceLine complex type.
    class  InvoiceLineDetail
    Java class for InvoiceLineDetail complex type.
    class  IssueProblemRole
    This specifies what roles will be allowed to view problems that Issue Subscriptions generate when alerts are fired by the system.
    class  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.
    class  IssueSubscriptionFilter
    Captures the data for an individual filter within a user's Issue Subscription.
    class  Item
    Any object or a 'thing'
    class  ItemSubstitution
    Used to specify item substitution characteristics such as start/end dates, type of substitution.
    class  ItemTaxCode
    Captures item-specific codes used by Tax Provider services for calculating sales and other taxes.
    class  IxmEngineConfig
    This model is used to configure the deployment of an IXM engine at a cluster-wide level
    class  IxmEngineNodeConfig
    This model is used to configure the deployment of an IXM engine at a specific node level
    class  IxmTaskGeneratorSchedule
    Used to customize the schedules under which a particular engine can run
    class  JoinedIssueSubscription
    Allows users to join the IssueSubscription published by other users in the same enterprise.
    class  KPI
    Stores a computed KPI value.
    class  KPIDef
    A KPIDef is meta-data which qualifies a KPIFamilyDef (defined in the module or EPT) with runtime parameters, UI parameters and boundary qualifiers.
    class  KPIHistory
    Captures historical values for the parent KPI, if available.
    class  Message
    A model containing the metadata related to message, the payload itself is stored in the MessageStorageService.
    class  MessageDestination
    Captures a destination to which an outbound message can be routed, for example a filesystem or SFTP server
    class  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.
    class  MessageQueue
    Describes the metadata for various Inbound and outbound Message Queues.
    class  MessageRoute
    Routes outbound Messages to different MessageDestinations based on interface/queue/etc
    class  MessageSource
    Defines a "source" from which Messages can be "polled" by MessageSourcePolls and enqueued into an Inbound Queue.
    class  MessageSourcePoll
    Defines rules by which Messages are "polled" from a MessageSource and enqueued into an Inbound Queue.
    class  MessageTransform
    Can be used to transform an inbound or outbound Message prior to processing
    class  MLModel
    The machine learning model that contains the model id, version and an attachment to the trained model.
    class  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.
    class  com.onenetwork.platform.common.Model  
    class  ModelValidationConfig
    ModelValidationConfig is used to configure ValidationContexts to be used with ValidationService.
    class  Movement
    The movement forms the basic unit of transporation execution.
    class  MovementStop
    Movement Stop represents a stop that Carrier will be taking in movement move.
    class  MovementStopLine
    Movement Stop line represents all the details of Movement Stop like status and stop Number.
    class  MsgProcessingContext
    Model to resolve the user context either using ResolverClass or by fields pattern matching against message, to process the inbound message.
    class  MsgQueueDependency
    Declares dependency relationships, such that Queue 1 will not be dequeued while Queue 2 still has messages.
    class  NeoAnalyticReport
    Defines a "report" which is executed against a single Fact.
    class  NeoCustomWidget
    Defines a custom widget which has been added by the user.
    class  NeoDashboard
    Java class for NeoDashboard complex type.
    class  NeoDashboardSubscr
    Represents NeoDashboards subscribed by User.
    class  NeoKPIConfig
    Allows the override of TargetValues and ValueBands at the level of a NeoKPIDef plus one or more scopes.
    class  NeoKPIDefConfig
    This model allows runtime configuration of NeoKPIDefs, including filters and datasources.
    class  NeoKPIValue
    This model sits in OLTP (not DW) and stores pre-computed KPI values for NeoKPIDefs which use the Materialized option.
    class  NeoNotification
    Model to support notifications.
    class  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.
    class  NeoPrescription
    Captures a prescription generated by Neo which can be used to solve a problem, either automatically or through directed user action.
    class  NodeExecHistory
    Java class for NodeExecHistory complex type.
    class  OAuthIBClientApp
    Where ONE is the Resource Server, OAuthIBClientApp is used to store client app ids given to external OAuth Client Applications by ONE.
    class  OAuthIBToken
    Where ONE is the Resource Server, an OAuthIBToken is granted to a Client App to make calls on behalf of a Resource Owner.
    class  OAuthIBTokenReq
    This model is used to store information relevant to the authorization *request* made by an external Client Application to ONE as Resource Server.
    class  OAuthOBClientApp
    Where ONE is the Client App, OAuthOBClientApp is used to store client app ids given to ONE by external Resource Servers.
    class  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.
    class  OAuthOBTokenReq
    This model is used to store information relevant to the authorization *request* made by ONE as Client Application to the Resource Server.
    class  OBFixlenFieldFormat
    Defines the format of the fields that compose a record in a flat file.
    class  OBFixlenInterfaceFmt
    Roughly corresponds to a "flat file" to be sent outbound.
    class  OBFixlenRecordFormat
    Defines the format of a single record in a flat file.
    class  OBFLRecordGroup
    An ordered collection of OBFixlenRecordFormats that define the format of a flat file.
    class  OBFLRecordGroupEntry
    Primarily servers two purposes: 1) Decouple OBFixlenRecordFormats from OBFixlenInterfaceFmt so that they can be defined independently and reused.
    class  OnboardingProgram
    Program used for Onboarding.
    class  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).
    class  OrderForecast
    An order forecast represents a prediction of what will need to be ordered for a given item at a site in the future.
    class  OrderLineItem
    Java class for OrderLineItem complex type.
    class  OrderSchedule
    Java class for OrderSchedule complex type.
    class  Organization
    Each Enterprise can contain one or more Organizations to describe different divisions/etc within the company.
    class  OrgCode
    A numeric, or alphanumeric, representation of text for exchanging commonly used information.
    class  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.
    class  OrgEnumPreferences
    Defines preferences for organization specific enumeration, i.e.
    class  OrgHierarchy
    Identifies named hierarchies for orgs.
    class  OrgHierarchyEntry
    Provides the actual parent/child relationship for the orgs within a hierarchy.
    class  OrgListPerm
    OrgListPerm is used to associate one or more Organizations with a model such as an Item or Shipment.
    class  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.
    class  PageAction
    Java class for PageAction complex type.
    class  PageFlow
    A set of Pages that work together to provide a full lifecycle of creating and modifying a model instance (e.g.
    class  PageRelatedModel
    Related model level to Page.
    class  PageRoutingGuide
    The Page Routing Guide is all the rules for routing to specific Page Flow.
    class  Partner
    A uni-directional partnership, where one Enterprise specifies another Enterprise as its partner.
    class  PartnerEDIConfig
    The EDI configuration properties for a partner to override any default configurations.
    class  PartnerInvitation
    An organization can invite any other organization in the network to be its partner.
    class  PartnerSite
    Similar to Partner, Partner Site allows an Organization to reference another Organization's Sites using its own set of names.
    class  PartnerTypeConfig
    Java class for PartnerTypeConfig complex type.
    class  Payment
    Payment is a model to capture all payment details for an Invoice.
    class  Person
    A Person is defined underneath a PersonSpace within an Enterprise.
    class  PersonIdentityMapping
    A PersonIdentityMapping indicates that a Person within one PersonSpace is "the same" human as a Person from another PersonSpace in another Enterprise.
    class  PersonSpace
    A PersonSpace defines a namespace under which an Enterprise can store Persons.
    class  PersonSpacePermission
    By default, PersonSpaces are only accessible within an Enterprise.
    class  Pipeline
    A pipeline model is used to store information to automatically generate a series of sequentially executed tasks.
    class  PipelineExecHistory
    A PipelineExecHistory model is used to store execution information of pipeline.
    class  PlatformInstance
    A PlatformInstance represents a deployed platform instance with name, url, authorization info and state defining inMaintenanceModeUntil field.
    class  PolicyValue
    Model to hold the policies defined in MPT
    class  ProductGroup
    A group of products with similar characteristics, often used in production planning (or sales and operations planning).
    class  ProductGroupLevel
    Product Group Level Hierarchy.
    class  PublicProfile
    Profile of the organization which will shown to all other organizations
    class  RelatedModelAction
    Java class for RelatedModelAction complex type.
    class  ReportSummaryRow
    Stub for ReportSummaryRow to compile platform-api code.
    class  Role
    Each User in the system can play one or more Roles.
    class  SharedDashPref
    This model shows dashboards that are shared with other users
    class  Shipment
    The Shipment model is used to represent the transfer of goods from one party to another.
    class  ShipmentLine
    Shipment Line represents the Goods' physical dimension in terms on Weight, Volume, Quantity etc.
    class  Singleton
    Singleton represents an individual item with a unique identifier.
    class  SingletonLine
    The Singleton Line is used to model non-serialized items which are part of the main Singleton.
    class  Site
    A physical location, owned by an Organization.
    class  SiteGroup
    Java class for SiteGroup complex type.
    class  SiteGroupLevel
    Java class for SiteGroupLevel complex type.
    class  SiteLane
    A site lane represents a transportation lane along which items can be transported from one site to another.
    class  SiteRsrc
    Location where the actual physical receipt of the purchased material from the carrier occurs.
    class  SiteRsrcReservation
    Site Resource Reservation represents the details of the pick up and delivery appointments created on shipment.
    class  SlcFileCache
    Model to store the mapping of attachment and cached file name with relative path on SLC(Sandboxed Lambda Cluster).
    class  Task
    A Task which can be managed in ONE's Dashboard and may have dependency relationships with other Tasks.
    class  TaskReqmt
    Indicates a dependency between two Tasks.
    class  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.
    class  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.
    class  ToDo
    To DO concept is a SINGLE USER CONCEPT.Will show all current user's ToDos
    class  User
    A user of the OneNetwork Platform.
    class  UserABAC
    UserABAC will be used to associate an user and ABAC
    class  UserABACValue
    Java class for UserABACValue complex type.
    class  UserAssociation
    Used to grant Roles to Users.
    class  UserDefinedConstant
    Holds the enterprise specific user defined constants to be used in the TLV computed expressions.
    class  UserGroup
    A named group of Users.
    class  UserGroupMember
    Java class for UserGroupMember complex type.
    class  UserRequest
    Used to request the addition of new users and other actions which a user needs administrator assistance to complete.
    class  UserTermsAndConditions
    Captures the terms and conditions which user should accept (if enabled using ExternalReference) before login to the system.
    class  ValidationRule
    Defines a validation rule which can be run in a specific "context".
    class  ValidationRuleIf
    When *all* ValidRuleIfs evaluate to true, ValidRuleThens execute to perform the validation.
    class  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
    class  ValidationRuleThen
    If *any* ValidRuleThen evaluates to false, the ValidRule as a whole is said to be invalid.
    class  ValueBand
    ValueBands are used to capture a set of value ranges and associated "status".
    class  ValueBands
    ValueBands are used to capture a set of value ranges and associated "status".
    class  ValueChain
    ValueChain is the top-level entity under which all other Models reside.
    class  WBGeo
    This model is used to hold the Geo information for WBProblem for the referenced models, i.e.
    class  WBProblem
    This is contains specific problems to be displayed in the Workbench.
    class  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.
    class  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.
    class  WBProblemIssue
    WBProblemIssue defines the linkage between classic, transactional Issue computations in Platform with the new Problem model.
    class  WBProblemLine
    This model links an additional ESG room and users to a problem.
    class  WBProblemLineMember
    Tracks invited users to the problem line.
    class  WBProblemNote
    This represents a note written for a problem.
    class  WBProblemRole
    An optional child of WBProblem used to limit access to the problem to specific role instances.
    class  WBProblemRoleType
    Only RoleTypes with rows underneath the parent WBProblemType are allowed to view WBProblems of that type.
    class  WBProblemSharedOrg
    This model stores the information of the WBProblem and the Organization of the owner's partners with which the problem has been shared.
    class  WBProblemType
    Describes a Problem Type for use within the Workbench.
    Methods in com.onenetwork.platform.common with type parameters of type Model 
    Modifier and Type Method Description
    <M extends Model>
    void    		 ModelList.add​(M model, java.lang.String xmlns)  
    Methods in com.onenetwork.platform.common that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<javax.xml.bind.JAXBElement<? extends Model>> ModelList.getModels()  

  • Uses of Model in com.onenetwork.platform.common.exchangeframework

    Methods in com.onenetwork.platform.common.exchangeframework with parameters of type Model 
    Modifier and Type Method Description
    void DataSinkService.addFieldsFromModelToDSD​(Model model, DataSinkDef node)
    Convenience method for adding fields from a model to a DataSinkDef node.
    void DataSourceService.addFieldsFromModelToDSD​(Model model, DataSourceDef node)
    Convenience method for adding fields from a model to a DataSourceDef node.

  • Uses of Model in com.onenetwork.platform.common.field

    Method parameters in com.onenetwork.platform.common.field with type arguments of type Model 
    Modifier and Type Method Description
    Field FieldService.newField​(java.lang.Class<? extends Model> modelLevel, java.lang.String name)
    Creates a new Field by looking up the field from the model definition.
    FieldId FieldService.newFieldId​(java.lang.Class<? extends Model> modelLevel, java.lang.String name)
    Creates a new FieldId, using the given Model class as the "level"

  • Uses of Model in com.onenetwork.platform.data.model

    Classes in com.onenetwork.platform.data.model with type parameters of type Model 
    Modifier and Type Class Description
    class  ModelAudit<M extends Model>
    Captures an audit entry for a Model.
    class  ModelList<M extends Model>
    Contains a list of Models to be used in conjunction with the write* methods of ModelDataService.
    class  ModelWriteRequest<M extends Model>
    Detailed request for writing Models, which includes parameters for changing natural keys, returning processed records, etc.
    class  ViewRequest<T extends Model>
    Encapsulates all parameters which go into invoking a Model view programmatically.
    Methods in com.onenetwork.platform.data.model with type parameters of type Model 
    Modifier and Type Method Description
    <T extends Model>
    long    		 ModelDataService.count​(java.lang.Class<T> clazz, PlatformUserContext context, SqlParams params, ModelFilter... filters)
    This method is similar to ModelDataService.read(Class, PlatformUserContext, SqlParams, ModelQueryComponent...) with one key difference - it returns total count of models.
    <T extends Model>
    java.util.List<Field>    		 ModelDataService.getViewFilterFields​(ViewRequest<T> viewRequest, PlatformUserContext context)
    Returns a collection of Field objects describing the required and optional filter fields available for the given view.
    <T extends Model>
    java.util.List<T>    		 ModelDataService.read​(java.lang.Class<T> topLevelClass, PlatformUserContext context, SqlParams params, ModelQueryComponent... queryComponents)
    Reads Model objects from the database using user-provided filter, sort and retrieval criteria.
    <T extends Model>
    java.util.List<ModelAudit<T>>    		 ModelDataService.readAudit​(java.lang.Class<T> modelClass, PlatformUserContext ctx, SqlParams params, ModelQueryComponent... queryComponents)
    Reads audit records for Models from the database using user-provided filter and sort criteria.
    <T extends Model>
    T    		 ModelDataService.readById​(java.lang.Class<T> topLevelClass, java.lang.Long sysId, PlatformUserContext platformContext, ModelRetrieval... retrievals)
    Convenience method for fetching a single Model by its surrogate id.
    <T extends Model>
    java.util.Map<java.lang.Long,​T>    		 ModelDataService.readByIds​(java.lang.Class<T> topLevelClass, java.util.Collection<java.lang.Long> sysIds, PlatformUserContext platformContext, ModelRetrieval... retrievals)
    Convenience method for fetching Models by surrogate id.
    <T extends Model>
    java.util.Map<java.lang.Long,​T>    		 ModelDataService.readByIds​(java.lang.Class<T> topLevelClass, java.util.Collection<java.lang.Long> sysIds, java.util.Map<java.lang.Class<? extends Model>,​java.util.Collection<java.lang.Long>> includeChildSysIdsByModelLevelType, PlatformUserContext platformUserContext)
    Convenience method for fetching Models by ids and selecting which child model instances to fetch.
    <T extends Model>
    java.util.List<T>    		 ModelDataService.readByView​(ViewRequest<T> viewReadRequest, PlatformUserContext context)
    Allows a client to programmatically invoke a view which was defined in studio.
    <T extends Model>
    java.util.Set<java.lang.Long>    		 ModelDataService.validateReadPermission​(java.lang.Class<T> topLevelClass, java.util.Set<java.lang.Long> sysIds, PlatformUserContext platformContext)
    Given a Set of top-level model sys ids, executes a read query to check if the given context has access to those records.
    <M extends Model>
    void    		 ModelDataService.validateWritePermission​(ModelWriteRequest<M> modelWriteRequest, PlatformUserContext platformContext)
    Validates write permission for the given models without actually writing models in the DB.
    <M extends Model>
    ModelList<M>    		 ModelDataService.write​(ModelList<M> modelList, PlatformUserContext platformContext)
    Create, update or delete models using Actions defined in the MPT or SPT.
    <M extends Model>
    ModelList<M>    		 ModelDataService.write​(ModelWriteRequest<M> modelWriteRequest, PlatformUserContext platformContext)
    Create, update or delete models using Actions defined in the MPT or SPT.
    Methods in com.onenetwork.platform.data.model that return Model 
    Modifier and Type Method Description
    Model Difference.getModel1()  
    Model Difference.getModel2()  
    Methods in com.onenetwork.platform.data.model that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.Map<Model,​java.util.Set<java.lang.String>> ModelDataService.getAvailableActions​(java.util.Collection<? extends Model> models, PlatformUserContext context)
    Given a collection of fully-populated Models (i.e.
    java.lang.Class<? extends Model> SyntheticModel.getChildModelClass()
    Gets the SyntheticModel.childModelClass property.
    java.lang.Class<? extends Model> SyntheticModel.getParentModelClass()
    Gets the SyntheticModel.parentModelClass property.
    java.util.Set<java.lang.Class<Model>> ModelRetrieval.getRetrievedClasses()
    Returns all levels of the Model to be retrieved
    Methods in com.onenetwork.platform.data.model with parameters of type Model 
    Modifier and Type Method Description
    java.util.List<Difference> Model.diff​(Model m1, ModelDiffConfig cfg)
    Returns the differences found for field values in current Model and parameter Model object.
    void SyntheticModelListener.postAction​(java.lang.String actionName, Model parentModel, Model childModel, PlatformUserContext userContext)
    This method is called after an action has been executed on the childModel by the user on a User-defined Page.
    void SyntheticModelListener.preAction​(java.lang.String actionName, Model parentModel, Model childModel, PlatformUserContext userContext)
    This method is called before an action is executed on the childModel, but after the action on the parentModel has been executed by the user on a User-defined Page.
    Method parameters in com.onenetwork.platform.data.model with type arguments of type Model 
    Modifier and Type Method Description
    void ViewRequest.addFilter​(java.lang.Class<? extends Model> level, java.lang.String fieldName, java.lang.Object value)
    Adds a filter value to be used when invoking the view.
    java.util.Map<Model,​java.util.Set<java.lang.String>> ModelDataService.getAvailableActions​(java.util.Collection<? extends Model> models, PlatformUserContext context)
    Given a collection of fully-populated Models (i.e.
    java.util.List<SyntheticModel> UserDefinedPageService.getSyntheticModels​(java.lang.Class<? extends Model> parentModelClass)
    Returns a list of all SyntheticModels for the given model class.
    <T extends Model>
    java.util.Map<java.lang.Long,​T>    		 ModelDataService.readByIds​(java.lang.Class<T> topLevelClass, java.util.Collection<java.lang.Long> sysIds, java.util.Map<java.lang.Class<? extends Model>,​java.util.Collection<java.lang.Long>> includeChildSysIdsByModelLevelType, PlatformUserContext platformUserContext)
    Convenience method for fetching Models by ids and selecting which child model instances to fetch.
    void SyntheticModel.setChildModelClass​(java.lang.Class<? extends Model> childModelClass)
    Sets the SyntheticModel.childModelClass property.
    void SyntheticModel.setParentModelClass​(java.lang.Class<? extends Model> parentModelClass)
    Sets the SyntheticModel.parentModelClass property.
    Constructors in com.onenetwork.platform.data.model with parameters of type Model 
    Constructor Description
    Difference​(Model model1, Model model2, java.lang.String fieldName, java.lang.Object model1Value, java.lang.Object model2Value)  
    ModelList​(java.lang.String customModelName, java.lang.String actionName, M... models)
    Constructs a new ModelList with the given custom model name, action name & models.
    ModelList​(java.lang.String actionName, M... models)
    Constructs a new ModelList with the given action name & models.
    Constructor parameters in com.onenetwork.platform.data.model with type arguments of type Model 
    Constructor Description
    SyntheticModel​(java.lang.String name, java.lang.Class<? extends Model> parentModelClass, java.lang.Class<? extends Model> childModelClass, java.lang.String bridgeQuery, SyntheticModelListener listener)
    Constructs a SyntheticModel with the required properties.

  • Uses of Model in com.onenetwork.platform.data.model.perm

    Methods in com.onenetwork.platform.data.model.perm that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<? extends Model> ActionPermissionRequest.getModels()  
    Constructor parameters in com.onenetwork.platform.data.model.perm with type arguments of type Model 
    Constructor Description
    ActionPermissionRequest​(java.lang.String customModelName, java.lang.String actionName, java.util.List<? extends Model> models, PlatformUserContext platformUserContext)  

  • Uses of Model in com.onenetwork.platform.data.sql

    Method parameters in com.onenetwork.platform.data.sql with type arguments of type Model 
    Modifier and Type Method Description
    void ReportRequest.addFilter​(java.lang.Class<? extends Model> level, java.lang.String fieldName, java.lang.Object value)
    Adds a filter value to be used when invoking the view, using a model class as level.

  • Uses of Model in com.onenetwork.platform.data.validation

    Methods in com.onenetwork.platform.data.validation with parameters of type Model 
    Modifier and Type Method Description
    void ValidationWBProblemPopulator.addParams​(org.json.JSONObject params, Model model, PlatformUserContext ctx)
    Adds new params using model info to existing params of the WBProblem created against the model for any validation rules failure.
    void ValidationWBProblemPopulator.addSummarySection​(org.json.JSONArray summaries, Model model, PlatformUserContext ctx)
    Adds new summaries using model info to existing summaries of the WBProblem created against the model for any validation rules failure.
    void ValidationService.applyValidatedStateToModel​(ValidatedModelState validatedState, Model model)
    Apply the supplied ValidatedModelState (computed fields, default values, etc...) to the supplied model.
    java.util.List<Pair<java.lang.String,​java.lang.String>> ValidationService.createModelBindingKeyLabelKeyPairs​(Model m)
    Given a Model, get a list of pairs of field key to label key (useful in creating a ValidationSubContext for a Model)
    java.util.Map<java.lang.String,​java.lang.Object> ValidationService.createModelBindings​(Model m)
    Given a Model, bind all model fields in a Map for evaluation in a Validation context.
    java.lang.String ValidationWBProblemPopulator.getAttribute1​(Model model, PlatformUserContext ctx)
    Given a model, returns the value for attribute1 of the WBProblem created against the model for any validation rules failure.
    java.lang.String ValidationWBProblemPopulator.getAttribute2​(Model model, PlatformUserContext ctx)
    Given a model, returns the value for Attribute2 of the WBProblem created against the model for any validation rules failure.
    java.lang.String ValidationWBProblemPopulator.getAttribute3​(Model model, PlatformUserContext ctx)
    Given a model, returns the value for Attribute3 of the WBProblem created against the model for any validation rules failure.
    java.util.Calendar ValidationWBProblemPopulator.getExpiryDate​(Model model, PlatformUserContext ctx)
    Given a model, returns the expiry date of the WBProblem created against the model for any validation rules failure.
    java.lang.Long ValidationWBProblemPopulator.getOwnerId​(Model model, PlatformUserContext ctx)
    Given a model, returns the owner id of the WBProblem created against the model for any validation rules failure.
    java.lang.String ValidationWBProblemPopulator.getPriority​(Model model, PlatformUserContext ctx)
    Given a model, returns the priority of the WBProblem created against the model for any validation rules failure.
    java.lang.String ValidationWBProblemPopulator.getProblemId​(Model model, PlatformUserContext ctx)
    Given a model, returns the problem id of the WBProblem created against the model for any validation rules failure.
    java.lang.String ValidationWBProblemPopulator.getTitleArgs​(Model model, PlatformUserContext ctx)
    Given a model, returns the title arguments of the WBProblem created against the model for any validation rules failure.
    void ValidationFailureHandler.onValidationFailure​(Model model, ValidationResponse response, PlatformUserContext ctx)
    This method is called if there is any validation failure against a validation context derived from a ModelValidationConfig.
    Method parameters in com.onenetwork.platform.data.validation with type arguments of type Model 
    Modifier and Type Method Description
    java.util.List<java.lang.Long> ValidationEnterpriseLookupHandler.lookupEnterpriseIds​(java.util.List<Model> models)
    Given a set of Models, returns a list of enterprise ids.

  • Uses of Model in com.onenetwork.platform.integ.csv

    Methods in com.onenetwork.platform.integ.csv that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<Model> CsvService.csvToModel​(java.io.InputStream csvData, java.lang.String inboundInterfaceName, java.lang.String inboundInterfaceVersion, PlatformUserContext platformUserContext)
    Given a stream of CSV data, uses the provided inbound interface (typically defined in the MPT) to convert the given CSV data to model objects.
    Methods in com.onenetwork.platform.integ.csv with parameters of type Model 
    Modifier and Type Method Description
    void ModelCsvTransformer.transform​(Model model, CsvRow row, CsvTransformContext context)
    This method is used to transform a model to a csv row.

  • Uses of Model in com.onenetwork.platform.integ.edi

    Methods in com.onenetwork.platform.integ.edi with type parameters of type Model 
    Modifier and Type Method Description
    <T extends Model>
    java.util.List<com.americancoders.edi.TransactionSet>    		 EDIMapper.convertToEDI​(T model)
    Public method which is invoked to convert a model to list of TransactionSet
    protected <T extends Model>
    java.util.List<com.americancoders.edi.TransactionSet>    		 EDIMapper.convertToEDI​(T model, java.util.Map<java.lang.String,​java.lang.Object> additionalData)
    Implement this method when a single model object needs to be converted into a list of transaction sets.
    protected abstract <T extends Model>
    java.lang.Class<T>    		 BaseNetChangeEDIOutboundGenerator.getModelTypeClass()
    Method to get the class name of the model type being used to generate the outbound
    Methods in com.onenetwork.platform.integ.edi that return types with arguments of type Model 
    Modifier and Type Method Description
    protected abstract java.util.Map<Partner,​java.util.List<? extends Model>> BaseEDIOutboundGenerator.derivePartners​(ModelOutboundProcessingContext processingContext)
    Implementing class should map incoming models to a Partner record for purposes of matching to EDIOutboundRoutes.
    protected java.util.List<Model> BaseNetChangeEDIOutboundGenerator.getModelsForOutboundProcessing​(NetChangeOutboundProcessingContext processingContext, java.util.List<java.lang.Long> sysIdsOfModels)
    ModelDataService.readByIds in order to get all the models
    Method parameters in com.onenetwork.platform.integ.edi with type arguments of type Model 
    Modifier and Type Method Description
    java.util.List<com.americancoders.edi.TransactionSet> EDIMapper.convertToEDI​(java.util.List<? extends Model> modelList)
    Public method which is invoked to convert model/list of models to list of TransactionSet
    protected java.util.List<com.americancoders.edi.TransactionSet> EDIMapper.convertToEDI​(java.util.List<? extends Model> modelList, java.util.Map<java.lang.String,​java.lang.Object> additionalData)
    Implementing mappers are responsible for creation and population of TransactionSet (with all the required segments) from model list
    protected java.util.Map<java.lang.String,​java.lang.Object> EDIMapper.fetchAdditionalData​(java.util.List<? extends Model> modelList)
    Fetches any data not on the given list of Model objects and puts into a Map.
    protected void BaseEDIOutboundGenerator.generateEDI​(Partner partner, java.util.List<? extends Model> models, PlatformUserContext pltUserContext)
    Generates the EDI transaction sets for the models, sends it using EDIUtil.send (also updating the EDI MQ in the process)

  • Uses of Model in com.onenetwork.platform.integ.fixlen

    Methods in com.onenetwork.platform.integ.fixlen with type parameters of type Model 
    Modifier and Type Method Description
    protected abstract <T extends Model>
    java.lang.Class<T>    		 BaseNetChangeFixLenOutboundGenerator.getModelTypeClass()
    Method to get the class of the model type being used to generate the outbound message.
    Methods in com.onenetwork.platform.integ.fixlen that return types with arguments of type Model 
    Modifier and Type Method Description
    protected java.util.List<Model> BaseNetChangeFixLenOutboundGenerator.getModelsForOutboundProcessing​(NetChangeOutboundProcessingContext processingContext, java.util.List<java.lang.Long> sysIdsOfModels)
    Get models using ModelDataService.readByIds
    Method parameters in com.onenetwork.platform.integ.fixlen with type arguments of type Model 
    Modifier and Type Method Description
    protected abstract java.util.List<FixLenRow> BaseFixLenOutboundGenerator.generateRows​(java.util.List<? extends Model> modelList)
    Your implementation should convert the given Models into List and return the result.

  • Uses of Model in com.onenetwork.platform.integ.json

    Methods in com.onenetwork.platform.integ.json with type parameters of type Model 
    Modifier and Type Method Description
    <M extends Model>
    M    		 JSONService.jsonToModel​(org.json.JSONObject json, java.lang.Class<M> modelClass, PlatformUserProfile... userProfile)
    Converts the given JSON into a Model of the given type.
    <M extends Model>
    M    		 JSONService.jsonToModel​(org.json.JSONObject json, java.lang.Class<M> modelClass, java.lang.String inboundInterfaceName, java.lang.String inboundInterfaceVersion, PlatformUserProfile... profile)
    Converts the given JSON into a Model of the given type using the InboundInterface specified.
    <M extends Model>
    M    		 JSONService.jsonToModelExternal​(org.json.JSONObject json, java.lang.Class<M> modelClass, PlatformUserProfile... userProfile)
    Converts the given JSON into a Model of given type with following conditions: serializeOnlyNKs flag as false, de-serialize all NK components(populateAllNKComponents=true) skipSysId and does not de-serialize transient fields on models Requires the JSON to include ModelLevelType property (introduced in 8.3).
    <M extends Model>
    M    		 JSONService.jsonToModelFullySerialized​(org.json.JSONObject json, java.lang.Class<M> modelClass, PlatformUserProfile... userProfile)
    Converts the given JSON into a Model of given type with all the attributes de-serialized.
    <M extends Model>
    java.util.List<M>    		 JSONService.jsonToModels​(org.json.JSONArray arr, java.lang.Class<M> modelClass, PlatformUserProfile... userProfile)
    Converts the given JSON array into Models of the given type.
    <M extends Model>
    java.util.List<M>    		 JSONService.jsonToModels​(org.json.JSONArray arr, java.lang.Class<M> modelClass, java.lang.String inboundInterfaceName, java.lang.String inboundInteraceVersion, PlatformUserProfile... userProfile)  
    Methods in com.onenetwork.platform.integ.json that return Model 
    Modifier and Type Method Description
    Model JSONService.jsonToModel​(org.json.JSONObject json, PlatformUserProfile... userProfile)
    Converts the given JSON into a Model.
    Methods in com.onenetwork.platform.integ.json that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<Model> JSONService.jsonToModels​(org.json.JSONArray arr, PlatformUserProfile... userProfile)
    Converts the given JSON array into Models.
    Methods in com.onenetwork.platform.integ.json with parameters of type Model 
    Modifier and Type Method Description
    org.json.JSONObject JSONService.modelToJSON​(Model model, PlatformUserProfile... profile)
    Converts the given Model into a JSON representation.
    org.json.JSONObject JSONService.modelToJSON​(Model model, java.lang.String outboundIntfName, java.lang.String outboundIntfVersion, PlatformUserProfile... profile)
    Converts the given Model into a JSON representation using the given OutboundInterface specified by the outboundIntfName and outboundIntfVersion.
    org.json.JSONObject JSONService.modelToJSONFullySerialized​(Model model, PlatformUserProfile... profile)
    Converts the given Model into a JSON representation with all the attributes.
    org.json.JSONObject JSONService.modelToJSONObjectExternal​(Model model, PlatformUserProfile... profile)
    Converts the given Model into a JSON representation with following conditions: serializeOnlyNKs = false, serialize all NK components(populateAllNKComponents=true) showsMDFSeparately, skipSysId and does not serialize transient fields on models.
    void ModelJsonTransformer.transform​(Model model, org.json.JSONObject json, JsonTransformerContext context)
    Converts a model to json.
    Method parameters in com.onenetwork.platform.integ.json with type arguments of type Model 
    Modifier and Type Method Description
    org.json.JSONArray JSONService.modelsToJSON​(java.util.Collection<? extends Model> models, PlatformUserProfile... profile)
    Converts the given Models into a JSON array representation.
    org.json.JSONArray JSONService.modelsToJSON​(java.util.Collection<? extends Model> models, java.lang.String outboundIntfName, java.lang.String outboundIntfVersion, PlatformUserProfile... profile)  

  • Uses of Model in com.onenetwork.platform.integ.module

    Methods in com.onenetwork.platform.integ.module that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<Model> ModuleIntegrationService.processInboundInterface​(java.lang.String interfaceName, java.lang.String interfaceVersion, java.util.List<Model> models, PlatformUserContext context)
    Given an inbound interface and a list of models to process, converts the models to CSV and executes the interface.
    java.util.List<Model> ModuleIntegrationService.processInboundInterface​(java.lang.String interfaceName, java.lang.String interfaceVersion, java.util.List<Model> models, IntegrationContext integrationContext, PlatformUserContext context)
    Given an inbound interface, a list of models to process and integration specific parameters, converts the models to CSV and executes the interface.
    Method parameters in com.onenetwork.platform.integ.module with type arguments of type Model 
    Modifier and Type Method Description
    java.util.List<Model> ModuleIntegrationService.processInboundInterface​(java.lang.String interfaceName, java.lang.String interfaceVersion, java.util.List<Model> models, PlatformUserContext context)
    Given an inbound interface and a list of models to process, converts the models to CSV and executes the interface.
    java.util.List<Model> ModuleIntegrationService.processInboundInterface​(java.lang.String interfaceName, java.lang.String interfaceVersion, java.util.List<Model> models, IntegrationContext integrationContext, PlatformUserContext context)
    Given an inbound interface, a list of models to process and integration specific parameters, converts the models to CSV and executes the interface.

  • Uses of Model in com.onenetwork.platform.integ.msg

    Methods in com.onenetwork.platform.integ.msg that return types with arguments of type Model 
    Modifier and Type Method Description
    java.util.List<? extends Model> ModelOutboundInterfaceWriteRequest.getModels()  
    java.util.List<? extends Model> ModelOutboundProcessingContext.getModels()  
    java.util.Map<java.lang.Long,​Model> SysIdOutboundInterfaceWriteRequest.getSysIdModelMap()
    This method is used to return Map with key as SysId and value as Model.
    java.util.Map<java.lang.Long,​Model> SysIdOutboundProcessingContext.getSysIdModelMap()
    This method is used to accept Map with key as SysId and value as Model.
    Methods in com.onenetwork.platform.integ.msg with parameters of type Model 
    Modifier and Type Method Description
    void ModelJsonCsvTransformer.transform​(Model model, CsvRow row, CsvTransformContext context)  
    void ModelJsonCsvTransformer.transform​(Model model, org.json.JSONObject json, JsonTransformerContext context)  
    Method parameters in com.onenetwork.platform.integ.msg with type arguments of type Model 
    Modifier and Type Method Description
    void ModelOutboundProcessingContext.setModels​(java.util.List<? extends Model> models)  
    void SysIdOutboundInterfaceWriteRequest.setSysIdModelMap​(java.util.Map<java.lang.Long,​Model> sysIdModelMap)
    This method is used to accept Map with key as SysId and value as Model.
    void SysIdOutboundProcessingContext.setSysIdModelMap​(java.util.Map<java.lang.Long,​Model> sysIdModelMap)
    This method is used to return Map with key as SysId and value as Model.
    Constructor parameters in com.onenetwork.platform.integ.msg with type arguments of type Model 
    Constructor Description
    ModelOutboundInterfaceWriteRequest​(java.lang.String outboundInterfaceName, java.lang.String outboundInterfaceVersion, QueueRef outboundQueueRef, java.util.List<? extends Model> models)  

  • Uses of Model in com.onenetwork.platform.integ.oagis

    Methods in com.onenetwork.platform.integ.oagis with type parameters of type Model 
    Modifier and Type Method Description
    protected abstract <T extends Model>
    java.lang.Class<T>    		 BaseOAGISOutboundGenerator.getModelTypeClass()
    Method to get the class of the model type being used to generate the outbound message.
    Methods in com.onenetwork.platform.integ.oagis that return types with arguments of type Model 
    Modifier and Type Method Description
    protected java.util.List<Model> BaseOAGISOutboundGenerator.getModelsForOutboundProcessing​(NetChangeOutboundProcessingContext processingContext, java.util.List<java.lang.Long> sysIdsOfModels)
    Given a list of ids, returns a list of models.
    Method parameters in com.onenetwork.platform.integ.oagis with type arguments of type Model 
    Modifier and Type Method Description
    abstract java.util.List<java.lang.Object> OAGISMapper.generate​(java.util.List<? extends Model> modelList)
    Your implementation should convert the given Models into OAGIS and return the result.

  • Uses of Model in com.onenetwork.platform.integ.rest.model

    Methods in com.onenetwork.platform.integ.rest.model with parameters of type Model 
    Modifier and Type Method Description
    void BaseModelResourceListener.beforeActionExecuted​(java.lang.String actionName, org.json.JSONObject modelJSON, Model model)
    Called before the action is executed, after the Model object has been created from the json that was passed from the client, so this method is called after BaseModelResourceListener.beforeActionExecuted(String, JSONObject), and modelJSON is merely provided for reading extra fields that need to be populated on the Model; it should not be modified
    void BaseModelResourceListener.beforeDeleteExecuted​(java.lang.String actionName, org.json.JSONObject modelJSON, Model model)
    Called before the delete action for children is executed, after the Model object has been created from the json that was passed from the client.
    void BaseModelResourceListener.onActionExecuted​(java.lang.String actionName, Model model, ModelFormJSONObject jsonToReturn)
    Called after the action has been executed and jsonToReturn contains a sysId property if it was successful.
    void BaseModelResourceListener.onActionScreenExecuted​(java.lang.String actionName, java.lang.Long sysId, Model model)
    Called after the detail action screen has been retrieved but before the Model has been converted to JSON, so values may be set on the Model (in both CREATE and WRITE actions) and they will be passed up to the UI
    Method parameters in com.onenetwork.platform.integ.rest.model with type arguments of type Model 
    Modifier and Type Method Description
    void BaseModelResourceListener.beforeModelWrite​(ModelWriteRequest<? extends Model> writeRequest, PlatformUserProfile profile)
    Called just before the ModelDataService.write is called, both for action execution as well as "delete" execution if child levels are being deleted.

  • Uses of Model in com.onenetwork.platform.integ.rest.template

    Methods in com.onenetwork.platform.integ.rest.template with parameters of type Model 
    Modifier and Type Method Description
    void BaseTemplateResourceListener.beforeEdit​(Model templateJaxb, org.json.JSONObject additionalInfo)
    Called before updating template in the system.
    void BaseTemplateResourceListener.beforeSave​(Model templateJaxb, org.json.JSONObject additionalInfo)
    Called before saving a new template in the system.

  • Uses of Model in com.onenetwork.platform.integ.sap

    Methods in com.onenetwork.platform.integ.sap with type parameters of type Model 
    Modifier and Type Method Description
    protected abstract <T extends Model>
    java.lang.Class<T>    		 BaseNetChangeIDocOutboundGenerator.getModelTypeClass()
    Method to get the class of the model type being used to generate the outbound message.
    Methods in com.onenetwork.platform.integ.sap that return types with arguments of type Model 
    Modifier and Type Method Description
    protected java.util.List<Model> BaseNetChangeIDocOutboundGenerator.getModelsForOutboundProcessing​(NetChangeOutboundProcessingContext processingContext, java.util.List<java.lang.Long> sysIdsOfModels)
    Given a list of ids, returns a list of models.
    Method parameters in com.onenetwork.platform.integ.sap with type arguments of type Model 
    Modifier and Type Method Description
    abstract java.util.List<IDoc> IDocMapper.generate​(java.util.List<? extends Model> modelList)
    Your implementation should convert the given Models into IDocs and return the result.

  • Uses of Model in com.onenetwork.platform.workflow

    Classes in com.onenetwork.platform.workflow with type parameters of type Model 
    Modifier and Type Class Description
    class  AbstractActionBasedWorkflowActivity<M extends Model>
    Default base class for implementing ActionBasedWorkflowActivity
    interface  ActionBasedWorkflowActivity<M extends Model>
    Interface for an activity in an action-based workflow (a workflow initiated by executing a write action on a Model).
    interface  ActionBasedWorkflowContext<M extends Model>
    Describes the execution context for an activity in an action-based workflow.
    interface  Callback<M extends Model>
    Interface for callbacks registered in the module or spt for actions defined in an mpt.
    interface  Comp<M extends Model>
    A computation (Issue, Valication, etc) which can be invoked in the context of an action-based workflow.
    interface  NotificationComp<M extends Model>
    A computation for sending Notifications to users which can be invoked in the context of an action-based workflow.
    Methods in com.onenetwork.platform.workflow with type parameters of type Model 
    Modifier and Type Method Description
    <T extends Model>
    void    		 IssueService.computeIssues​(java.lang.Class<T> topLevelClass, java.util.List<java.lang.Long> modelIds, PlatformUserContext context, java.lang.String... issueCompNames)
    Convenience method to execute the issue computations for the provided list of candidates
    <T extends Model>
    void    		 IssueService.computeIssues​(java.util.Collection<T> models, PlatformUserContext context, java.lang.String... issueCompNames)
    Convenience method to execute the issue computations for the provided list of candidates
    <M extends Model>
    void    		 WorkflowService.executeIssueComps​(ActionBasedWorkflowContext<M> workflowCtx, java.util.List<M> modelsToInclude, java.lang.String... issueCompNames)
    Given a list of Models from your workflow, executes the given issue computations on those models.
    <M extends Model>
    void    		 WorkflowService.mergeInputToCurrent​(ActionBasedWorkflowContext<M> workflowCtx)
    Copies values from the "input" down onto the "current".
    <M extends Model>
    void    		 WorkflowService.populateCurrentFromDatabase​(ActionBasedWorkflowContext<M> workflowCtx, FetchParam... fetchParams)
    Based on the records provided by the user in the input of the ActionBasedWorkflowContext, fetches the current state of those records from the DB into the "current" collection of the context.
    <M extends Model>
    void    		 WorkflowService.write​(java.util.List<M> models, ActionBasedWorkflowContext<M> workflowCtx)
    Writes the given Models to the database in the context of an Action-Based workflow.
    <M extends Model>
    void    		 WorkflowService.write​(java.util.List<M> models, ActionBasedWorkflowContext<M> workflowCtx, boolean writeWithNKChange)
    Writes the given Models to the database in the context of an Action-Based workflow.
    Methods in com.onenetwork.platform.workflow that return types with arguments of type Model 
    Modifier and Type Method Description
    java.lang.Class<? extends Model> FetchParam.getLevel()  
    Methods in com.onenetwork.platform.workflow with parameters of type Model 
    Modifier and Type Method Description
    default void PersonalizedIssueComp.populateDisplayFields​(IssueSubscription subscription, Model m, java.util.Map<java.lang.String,​java.lang.String> displayFields, PlatformUserContext userContext)  
    Method parameters in com.onenetwork.platform.workflow with type arguments of type Model 
    Modifier and Type Method Description
    static FetchParam FetchParam.all​(java.lang.Class<? extends Model> modelLevelClass)
    A new FetchParam which indicates all records in the database should be fetched for the given level, regardless of what was passed to the workflow.
    static FetchParam[] FetchParam.allChildren​(java.lang.Class<? extends Model> jaxbClass)
    A convenience method to construct FetchParams for all child ModelLevelType excluding the top one.
    static FetchParam FetchParam.inputOnly​(java.lang.Class<? extends Model> modelLevelClass)
    A new FetchParam which indicates only records passed in to the current workflow should be fetched for the given level.
    Constructor parameters in com.onenetwork.platform.workflow with type arguments of type Model 
    Constructor Description
    FetchParam​(java.lang.Class<? extends Model> modelLevelClass, FetchType fetchType)