| Package | Description | 
|---|---|
| com.onwbp.adaptation | Provides core classes and interfaces for accessing datasets, tables, and their records. | 
| com.orchestranetworks.d3 | 
Provides classes for distributed data delivery (D3) functionalities. | 
| com.orchestranetworks.instance | 
Provides interfaces for accessing data sets. | 
| com.orchestranetworks.rest.util | |
| com.orchestranetworks.schema.dynamic | A public API for defining a dynamic schema. | 
| com.orchestranetworks.schema.trigger | Provides classes and interfaces for trigger creation. | 
| com.orchestranetworks.service | Provides classes and interfaces for implementing specific services and access rules on EBX®. | 
| com.orchestranetworks.service.comparison | Provides classes and interfaces for to compute differences between
adaptations, homes and examine the results. | 
| com.orchestranetworks.service.directory | 
Provides classes for Directory handling. | 
| com.orchestranetworks.service.extensions | Provides classes and interfaces for specific extensions such as batch
and adaptation tree optimizer. | 
| com.orchestranetworks.ui | This package provides the capability to create custom user interface components
that are integrated within EBX®. | 
| com.orchestranetworks.ui.selection | This package provides interfaces with information about the selection. | 
| com.orchestranetworks.userservice | A public API for user services. | 
| com.orchestranetworks.userservice.permission | Allows the definition of activation rules and permission rules on user services. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | Adaptation. getHome()Returns the dataspace which contains this dataset or record. | 
| abstract AdaptationHome | AdaptationHome. getParent()Returns the parent dataspace of this  AdaptationHome. | 
| abstract AdaptationHome | AdaptationHome. getParentBranch()Returns the parent dataspace or snapshot of this  AdaptationHome. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract List<AdaptationHome> | AdaptationHome. getBranchChildren()Returns the dataspaces which have been created from this  AdaptationHome. | 
| abstract List<AdaptationHome> | AdaptationHome. getVersionChildren()Returns the snapshots which have been created from this
  AdaptationHome. | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | AdaptationHome. isAncestorOf(AdaptationHome anotherHome)Returns  trueif thisAdaptationHomeis an ancestor of
 the specifiedAdaptationHome(theAdaptationHomeitself is excluded). | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | D3NodeAsSlaveOnStartup. createDeliveryDataspace(BranchKey aDataspaceKey)Creates a delivery dataspace or gets the existing one. | 
| Modifier and Type | Method and Description | 
|---|---|
| Class<? extends D3ReceiveBroadcastTrigger> | D3NodeAsSlaveOnStartup. getRegisteredBroadcastTrigger(AdaptationHome aDataspace)Returns the 'D3 receive broadcast trigger' class registered according to a delivery dataspace. | 
| boolean | D3Node. isMasterHome(AdaptationHome aHome)Returns  trueif the parameteraHomeis a D3 primary delivery dataspace or its snapshot,
 otherwise returnsfalse. | 
| boolean | D3Node. isSlaveHome(AdaptationHome aHome)Returns  trueif the parameteraHomeis a D3 replica delivery dataspace or its snapshot,
 otherwise returnsfalse. | 
| void | D3NodeAsSlaveOnStartup. registerBroadcastTrigger(AdaptationHome aDataspace,
                        Class<? extends D3ReceiveBroadcastTrigger> aTriggerOrNull)Registers or unregisters the 'D3 receive broadcast trigger'. | 
| void | D3NodeAsSlaveOnStartup. registerDeliveryDataspace(AdaptationHome aDataspace)Registers the delivery dataspace. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract AdaptationHome | Repository. createHome(AdaptationHome parentDataSpace,
          HomeKey aKey,
          Profile owner,
          Session aSession,
          UserMessage aLabel,
          UserMessage aDescription)Creates the specified dataspace or snapshot. | 
| abstract AdaptationHome | Repository. createHome(HomeCreationSpec aSpec,
          Session aSession)Performs the dataspace or snapshot creation as specified. | 
| AdaptationHome | ValueContextForValidationOnTable. getFunctionalDataspace()Returns the dataspace that contains the table for which the validation has been requested. | 
| AdaptationHome | ValueContextForValidation. getFunctionalDataspace()Returns the dataspace that contains the adaptation for which the validation has been requested. | 
| AdaptationHome | ValueContext. getHome()Returns the current dataspace or snapshot. | 
| AdaptationHome | HomeCreationSpec. getHomeToCopyPermissionsFrom() | 
| AdaptationHome | HomeCreationSpec. getParent() | 
| abstract AdaptationHome | Repository. getReferenceBranch()Returns the reference dataspace. | 
| abstract AdaptationHome | Repository. lookupHome(boolean d3Lookup,
          HomeKey aKey)Returns the specified dataspace or snapshot. | 
| abstract AdaptationHome | Repository. lookupHome(HomeKey aKey)Returns the specified dataspace or snapshot. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract void | Repository. closeHome(AdaptationHome aDataSpaceOrSnapshot,
         Session aSession)Closes the specified dataspace or snapshot. | 
| abstract AdaptationHome | Repository. createHome(AdaptationHome parentDataSpace,
          HomeKey aKey,
          Profile owner,
          Session aSession,
          UserMessage aLabel,
          UserMessage aDescription)Creates the specified dataspace or snapshot. | 
| abstract void | Repository. deleteHome(AdaptationHome aDataSpaceOrSnapshot,
          Session aSession)Permanently deletes the specified dataspace or snapshot and all its descendants
 (dataspaces and snapshots). | 
| void | RepositoryPurge. markHomeForHistoryPurge(AdaptationHome aHome,
                       Date aStartDate,
                       Date anEndDate,
                       Session aSession)Marks the interval [aStartDate,anEndDate) for the specified dataspace or snapshot for history purge. | 
| void | RepositoryPurge. markHomeForHistoryPurge(AdaptationHome aDataSpaceOrSnapshot,
                       Session aSession)Marks the specified dataspace or snapshot for history purge. | 
| void | RepositoryPurge. markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot,
                Session aSession)Deprecated. 
 Replaced by  Repository.deleteHome(AdaptationHome, Session). | 
| abstract void | Repository. markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot,
                Session aSession)Deprecated. 
 Replaced by  Repository.deleteHome(AdaptationHome, Session). | 
| abstract void | Repository. reopenHome(AdaptationHome aHome,
          Session aSession)Reopens the specified home. | 
| abstract void | Repository. setDocumentationDescription(AdaptationHome aDataSpaceOrSnapshot,
                           String aDescription,
                           Locale aLocale,
                           Session aSession)Sets the documentation label for the specified dataspace or snapshot. | 
| abstract void | Repository. setDocumentationLabel(AdaptationHome aDataSpaceOrSnapshot,
                     String aLabel,
                     Locale aLocale,
                     Session aSession)Sets the documentation label for the specified dataspace or snapshot. | 
| void | HomeCreationSpec. setHomeToCopyPermissionsFrom(AdaptationHome aDataSpace)Specifies that the permissions of the dataspace to be created will
 be a copy of those of the specified dataspace. | 
| void | HomeCreationSpec. setParent(AdaptationHome aDataSpace)Specifies the parent dataspace of the new dataspace or snapshot to be created. | 
| Modifier and Type | Method and Description | 
|---|---|
| URI | URIBuilderForBuiltin.ForDataspace. buildForDataspace(AdaptationHome aDataspace) | 
| UriBuilder | URIBuilderForBuiltin.ForDataspace. dataspace(AdaptationHome aDataspace) | 
| ProcedureResult | ProcedureUtility. execute(Procedure aProcedure,
       AdaptationHome aDataspace)Executes the given  Procedureagainst the provided dataspace. | 
| Modifier and Type | Method and Description | 
|---|---|
| BeanFacetDatasetSet | BeanElement. addFacetDatasetSet(AdaptationHome aDataspace)Adds a dataset constraint to this element. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | TableTriggerExecutionContext. getAdaptationHome()Returns the current dataspace. | 
| AdaptationHome | InstanceTriggerExecutionContext. getAdaptationHome()Returns the current dataspace. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | ProcedureContext. getAdaptationHome()Returns the current dataspace. | 
| abstract AdaptationHome | ServiceContext. getCurrentHome()Deprecated.  Returns the dataspace currently selected in the user interface. | 
| AdaptationHome | ProgrammaticService. getCurrentHome()Returns the current dataspace or snapshot of this service. | 
| AdaptationHome | MergeSpecForHome. getHomeToMerge()Returns the dataspace to merge. | 
| Modifier and Type | Method and Description | 
|---|---|
| static ProgrammaticService | ProgrammaticService. createForSession(Session aSession,
                AdaptationHome aDataSpace)Instantiates a service that will execute within the specified session
 in the specified dataspace. | 
| static ProgrammaticService | ProgrammaticService. createForSession(Session aSession,
                AdaptationHome aDataSpace,
                Map<String,String> someInputParameters)Instantiates a service that will be executed in the specified dataspace, and
 within a session cloned from  aSessionwith specific input parameters. | 
| void | ProcedureContext. doMergeToParent(AdaptationHome aSource)Merges the specified dataspace to the current dataspace. | 
| AccessPermission | SessionPermissions. getHomeAccessPermission(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's access rights on the dataspace or snapshot specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionForService(ServiceKey serviceKey,
                                 AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permissions for executing the dataspace or snapshot service specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToChangeOwner(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permissions for changing the owner of the dataspace or snapshot specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToChangePermission(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permissions for changing permissions of the dataspace or snapshot specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToCloseHome(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permissions for closing the dataspace or snapshot specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToCreateChildBranch(AdaptationHome aDataSpace)Returns the current user's permissions for creating child dataspaces from the dataspace specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToCreateChildVersion(AdaptationHome aDataSpace)Returns the current user's permissions for creating child snapshots from the dataspace specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToCreateRootInstance(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permissions for creating a root dataset. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToExportArchive(AdaptationHome aDataSpaceOrSnapshot)Returns the current user's permission for performing an archive export of the dataspace or snapshot specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToImportArchive(AdaptationHome aDataSpace)Returns the current user's permissions for performing an archive import into the dataspace specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToInitializeMerge(AdaptationHome aDataSpace)Returns the current user's permissions for merging the dataspace specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToLockHome(LockSpec aSpec,
                                 AdaptationHome aDataSpace)Returns the current user's permissions for locking the dataspace specified. | 
| ActionPermission | SessionPermissions. getHomeActionPermissionToUnlockHome(LockSpec aSpec,
                                   AdaptationHome aDataSpace)Returns the current user's permissions for unlocking the dataspace specified. | 
| abstract String | ServiceContext. getURLForServiceSelection(AdaptationHome aHome,
                         Adaptation aRecordOrInstance,
                         SchemaNode aNode,
                         ServiceKey aServiceKey)Deprecated.  Returns a user interface URL that selects the specified node in the given record or dataset
 and starts the specified service on it, in the context of the given  AdaptationHome. | 
| abstract String | ServiceContext. getURLForServiceSelection(AdaptationHome aHome,
                         Adaptation aRecordOrInstance,
                         ServiceKey aServiceKey)Deprecated.  Returns a user interface URL that selects the specified record or dataset
 and starts the specified service on it, in the context of the given  AdaptationHome. | 
| abstract String | ServiceContext. getURLForServiceSelection(AdaptationHome aHome,
                         ServiceKey aServiceKey)Deprecated.  Returns a user interface URL that selects the specified dataspace
 and starts the specified service on it. | 
| boolean | SessionPermissions. isHomeOwner(AdaptationHome aDataSpaceOrSnapshot)Returns whether the current user is the owner of the dataspace or snapshot specified. | 
| boolean | Session. isUserOwner(AdaptationHome aDataspace)Returns  trueif this user is an owner of the specified dataspace. | 
| Constructor and Description | 
|---|
| MergeSpecForHome(AdaptationHome homeToMerge)Specifies the dataspace to merge. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | DifferenceBetweenHomes. getHomeOnLeft()The dataspace or snapshot on the left of the comparison. | 
| AdaptationHome | DifferenceBetweenHomes. getHomeOnRight()The dataspace or snapshot on the right of the comparison. | 
| Modifier and Type | Method and Description | 
|---|---|
| static DifferenceBetweenHomes | DifferenceHelper. compareHomes(AdaptationHome leftHome,
            AdaptationHome rightHome,
            boolean isResolvedMode)Compares two dataspaces or snapshots and returns the result. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract Directory | DirectoryFactory. createDirectory(AdaptationHome aDataSpace)Creates the directory. | 
| Directory | DirectoryDefaultFactory. createDirectory(AdaptationHome aDataSpace)Creates the default directory. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | LockSpec. lock(AdaptationHome aDataSpace,
    Session aSession)Locks the specified dataspace. | 
| void | LockSpec. unlock(AdaptationHome aDataSpace,
      Session aSession)Unlocks the specified dataspace. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | UIAjaxContext. getCurrentHome()Returns the dataspace or snapshot currently selected in the session. | 
| Modifier and Type | Method and Description | 
|---|---|
| String | UIResourceLocator. getURLForSelection(AdaptationHome aDataSpaceOrSnapshot)Returns a URL that, when used, changes the current navigation context to
 the specified dataspace or snapshot. | 
| void | UIHttpManagerComponent. selectHome(AdaptationHome aDataSpaceOrSnapshot)Selects the specified dataspace or snapshot. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | DataspaceEntitySelection. getDataspace()Returns the currently selected dataspace. | 
| Modifier and Type | Method and Description | 
|---|---|
| ProcedureResult | UserServiceTransaction. execute(AdaptationHome aDataSpace)In the same transaction, on a given dataspace, updates and creates objects
 and executes procedures in the same order as they were previously added. | 
| ProcedureResult | UserServiceTransaction. execute(AdaptationHome aDataSpace,
       boolean addErrorMessageIfException)In the same transaction, on a given dataspace, updates and creates objects
 and executes procedures in the same order as they were previously added. | 
| String | UserServiceResourceLocator. getURLForServiceSelection(ServiceKey aServiceKey,
                         AdaptationHome aDataSpaceOrSnapshot)Returns a user interface URL that selects the specified dataspace or
 snapshot and starts the specified service on it. | 
| String | UserServiceResourceLocator. getURLForServiceSelection(ServiceKey aServiceKey,
                         AdaptationHome aDataSpaceOrSnapshot,
                         URLQuery aQuery)Returns a user interface URL that selects the specified dataspace or
 snapshot and starts the specified service on it. | 
| static UserServiceEventOutcome | UserServiceNext. nextService(ServiceKey aServiceKey,
           AdaptationHome aDataSpaceOrSnapshot)The current user service will close, the specified dataspace or snapshot
 will be selected and the specified service started. | 
| Modifier and Type | Method and Description | 
|---|---|
| AdaptationHome | ServiceActivationRuleForDataspaceContext. getDataspace()Returns the current dataspace. |