# Package com.orchestranetworks.service

package com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.

### Services

In EBX®, there are two type of services:

- A UI service is integrated into Manager sessions – see `ServiceContext`.
- A programmatic service is called externally, for example from a batch or from a web service implementation – see `ProgrammaticService`.

If a service has to perform any update on data in EBX®, it has to implement a `Procedure`.

### Access Rules

In EBX®, access to data may be restricted programmatically – see `AccessRule`.

- Related Packages
  Package
  Description
  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.
- Class
  Description
  AccessPermission
  Defines the permission to see and modify a resource.
  AccessRule
  Specifies a programmatic access rule.
  AccessRule.NoWriteRule
  Wraps another rule to return a maximum access level of read-only.
  AccessRuleForCreate
  Specifies a programmatic access rule invoked only when a record is created.
  AccessRuleForCreateContext
  Provides the context of the record creation for which the access rule is being called.
  ActionPermission
  Defines the permissions for whether or not a user can execute an action.
  Archive
  An instance of this class references an archive used to export data from / import data to EBX® repositories.
  ArchiveExportSpec
  Defines the settings of an archive export.
  ArchiveImportSpec
  Defines the settings of an archive import.
  ArchiveImportSpecMode
  Defines the strategy used for importing an archive.
  ExportImportCSVSpec
  Defines the settings for executing an import or export to "Comma-separated values" format (CSV).
  ExportImportCSVSpec.Header
  Specifies the header type of the CSV document.
  ExportSpec
  Defines the settings of an export.
  ImportResult
  Describes the result of an import.
  ImportSpec
  Defines the settings of an import.
  ImportSpecMode
  Defines the possible modes for an XML import.
  InstanceContentSpec
  Specifies the content to export from a dataset.
  LoggingCategory
  This class provides methods for logging messages according to their severities.
  MergeSpecForHome
  Specifies the contents of a dataspace to be merged.
  MergeSpecForInstanceContents
  Specifies the contents to be merged for a dataset.
  NodeDataTransformer
  This class allows the transformation of data.
  NodeDataTransformerContext
  Context used to transform data upon export.
  OperationException
  Thrown to indicate that an operation cannot complete normally.
  Procedure
  This interface must be implemented in order to update data in a dataspace.
  ProcedureContext
  Context to execute EBX® transactions.
  ProcedureResult
  Represents the result of a procedure execution.
  Profile
  Identifies a user profile for permission management.
  ProgrammaticService
  This class provides the ability to programmatically log a user session.
  ReadOnlyProcedure
  Interface to be implemented for read-only transactions.
  Role
  A role is a profile that is not a reference to a specific user; several users can have the same role.
  ServiceContext
  Deprecated.
  From release 6.0, this API is no longer supported.
  ServiceGroupKey
  Identifies a group of user services.
  ServiceKey
  Identifies a user service.
  ServicePermission
  Attached to a legacy user service definition, this interface specifies the conditions under which this service can be executed.
  ServicePermissionForHierarchy
  Attached to a legacy user service definition, this interface specifies the conditions under which this service may be executed in the context of a hierarchy.
  Session
  Represents an authenticated user session, either an HTTP session or a "programmatic" session.
  SessionPermissions
  Defines a facade for checking the user's session permissions (access rights or actions) on dataspaces, snapshots, datasets, records, and nodes (tables, ...).
  URLQuery
  Represents a list of URL query parameters.
  UserReference
  Identifies a specific user.
  ValidationReport
  A validation report is composed of validation items, each one characterized by a severity and a user message.
  ValidationReportItem
  Represents an element of a validation report.
  ValidationReportItemIterator
  Iterator over items contained in a validation report.
  ValidationReportItemSubject
  Represents the subject of a validation report item.
  ValidationReportItemSubjectForAdaptation
  Represents the subject of a validation report item in the context of a dataset or record.
  ValidationReportItemSubjectForTable
  Represents the subject of a validation report item in the context of a table.
  ValidationSpec
  Defines the properties for validating a dataset, a table or a record.
  ValidationSpec.RefreshPolicy
  Defines the refresh policy for validating a dataset, a table or a record.
  ValueContextForUpdate
  This container interface provides the possibility of setting values on persisted or transient content whose structure and types conform to an underlying data model.
  ValueContextForUpdate.ValidationPolicy
  Defines the policy for validating this content.