# Uses of Interface
com.orchestranetworks.service.Session

Packages that use Session
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.d3.slave
Provides classes and interfaces for D3 slave functionalities.
com.orchestranetworks.instance
Provides interfaces for accessing data sets.
com.orchestranetworks.interactions
Provides classes for UI interactions.
com.orchestranetworks.module
This package allows to handle module registration.
com.orchestranetworks.permissions
com.orchestranetworks.query
Provides the API for accessing and processing data stored in EBX®.
com.orchestranetworks.rest.inject
com.orchestranetworks.rest.security
com.orchestranetworks.scheduler
This package allows the implementation of custom tasks in EBX® scheduler.
com.orchestranetworks.schema
Represents XML Schema concepts and provides schema extensions capabilities.
com.orchestranetworks.schema.businessObjects
com.orchestranetworks.schema.relationships
Provides interfaces for accessing relationships defined in a data model.
com.orchestranetworks.schema.trigger
Provides classes and interfaces for trigger creation.
com.orchestranetworks.schema.types.dataset
Interfaces to define sets of data set references.
com.orchestranetworks.schema.types.dataspace
Interfaces to define sets of data space keys.
com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.
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.form.widget
This package provides a library of user interface widgets.
com.orchestranetworks.ui.perspective
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.
com.orchestranetworks.userservice.schema
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

- ## Uses of Session in com.onwbp.adaptation

  Methods in com.onwbp.adaptation with parameters of type Session
  Modifier and Type
  Method
  Description
  `String`
  Adaptation.`getLabel(Session aSession)`
  Returns the label of the dataset or record corresponding to the locale in the specified session.
  `String`
  Adaptation.`getLabelOrName(Session aSession)`
  Returns the label of the dataset or record corresponding to the locale in the specified session.
  `void`
  Request.`setSession(Session aSession)`
  Sets the user session on the request.

- ## Uses of Session in com.orchestranetworks.d3

  Methods in com.orchestranetworks.d3 that return Session
  Modifier and Type
  Method
  Description
  `Session`
  D3NodeAsSlaveOnStartup.`createSystemUserSession(String aTrackingInformationComplementOrNull)`
  Creates a session executing as the "system user".
  Methods in com.orchestranetworks.d3 with parameters of type Session
  Modifier and Type
  Method
  Description
  `D3NodeAsMaster`
  D3NodeFactory.`createForMasterFromSession(Session aSession)`
  Creates a primary D3 engine to offer primary administrative functionalities.
  `D3NodeAsSlave`
  D3NodeFactory.`createForSlaveFromSession(Session aSession)`
  Creates a replica D3 engine to offer replica administrative functionalities.
  `static D3Engine`
  D3Engine.`getFromSession(Repository aRepository, Session aSession)`
  Deprecated.
  See `D3NodeFactory.createForMasterFromSession(Session)`.

- ## Uses of Session in com.orchestranetworks.d3.slave

  Methods in com.orchestranetworks.d3.slave that return Session
  Modifier and Type
  Method
  Description
  `Session`
  D3ReceiveBroadcastExecutionContext.`getSession()`
  Returns the authenticated session performing the action, that corresponds to the D3 replica node user defined in the `ebx.properties` file.

- ## Uses of Session in com.orchestranetworks.instance

  Methods in com.orchestranetworks.instance that return Session
  Modifier and Type
  Method
  Description
  `abstract Session`
  Repository.`createSessionFromArray(Object[] args)`
  Instantiates a session from an open array.
  `abstract Session`
  Repository.`createSessionFromHttpRequest(HttpServletRequest httpServletRequest)`
  Instantiates a session from an HTTP request.
  `abstract Session`
  Repository.`createSessionFromLoginPassword(String login, String password)`
  Instantiates a session based on the login and password specified.
  `abstract Session`
  Repository.`createSessionFromSOAPHeader(Element header)`
  Instantiates a session from a SOAP Header.
  `Session`
  NewRecordContext.`getSession()`
  Returns the authenticated session performing the record creation.
  Methods in com.orchestranetworks.instance with parameters of type Session
  Modifier and Type
  Method
  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 AdaptationHome`
  Repository.`createHome(HomeCreationSpec aSpec, Session aSession)`
  Performs the dataspace or snapshot creation as specified.
  `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 aDataSpaceOrSnapshot, Session aSession)`
  Marks the specified dataspace or snapshot for history purge.
  `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.
  `abstract void`
  Repository.`markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot, Session aSession)`
  Deprecated.
  Replaced by `Repository.deleteHome(AdaptationHome, Session)`.
  `void`
  RepositoryPurge.`markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot, Session aSession)`
  Deprecated.
  Replaced by `Repository.deleteHome(AdaptationHome, Session)`.
  `void`
  RepositoryPurge.`purgeAll(Session aSession)`
  Performs a complete deletion of the physical entities that have been marked for purge.
  `abstract void`
  Repository.`purgeHomes(Session aSession)`
  Deprecated.
  Replaced by `purgeAll`.
  `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.

- ## Uses of Session in com.orchestranetworks.interactions

  Methods in com.orchestranetworks.interactions with parameters of type Session
  Modifier and Type
  Method
  Description
  `static void`
  InteractionHelper.`complete(InteractionHelper.ParametersMap outputParameters, Session aSession)`
  Deprecated.
  Replaced by `SessionInteraction.complete(com.orchestranetworks.interactions.InteractionHelper.ParametersMap)`.
  `static InteractionHelper.ParametersMap`
  InteractionHelper.`getInputParameters(Session aSession)`
  Deprecated.
  Replaced by `SessionInteraction.getInputParameters()`.
  `static InteractionHelper.ParametersMap`
  InteractionHelper.`getInternalParameters(Session aSession)`
  Deprecated.
  Replaced by `SessionInteraction.getInternalParameters()`.
  `static boolean`
  InteractionHelper.`isComplete(Session aSession)`
  Deprecated.
  Replaced by `SessionInteraction.isComplete()`.
  `static void`
  InteractionHelper.`setInternalParameters(InteractionHelper.ParametersMap internalParameters, Session aSession)`
  Deprecated.
  Replaced by `SessionInteraction.setInternalParameters(com.orchestranetworks.interactions.InteractionHelper.ParametersMap)`.

- ## Uses of Session in com.orchestranetworks.module

  Methods in com.orchestranetworks.module that return Session
  Modifier and Type
  Method
  Description
  `Session`
  ModuleContextOnRepositoryStartup.`createSystemUserSession(String aTrackingInformationComplementOrNull)`
  Creates a session executing as the "system user".

- ## Uses of Session in com.orchestranetworks.permissions

  Methods in com.orchestranetworks.permissions that return Session
  Modifier and Type
  Method
  Description
  `Session`
  QueryPermissionException.`getSession()`
  Returns the session specified in the query.
  Methods in com.orchestranetworks.permissions with parameters of type Session
  Modifier and Type
  Method
  Description
  `static QueryPermissionException`
  QueryPermissionException.`create(Session aSession, Map<SchemaNode,Adaptation> forbiddenNodes)`
  Creates a QueryPermissionException.
  `static QueryPermissionException`
  QueryPermissionException.`create(Session aSession, Map<SchemaNode,Adaptation> forbiddenNodes, String message)`

- ## Uses of Session in com.orchestranetworks.query

  Methods in com.orchestranetworks.query with parameters of type Session
  Modifier and Type
  Method
  Description
  `void`
  Query.`setSession(Session aSession)`
  Sets the user session on the query.

- ## Uses of Session in com.orchestranetworks.rest.inject

  Methods in com.orchestranetworks.rest.inject that return Session
  Modifier and Type
  Method
  Description
  `Session`
  SessionContext.`getSession()`
  Returns the EBX® session for the current authenticated user.
  `Session`
  SessionContext.`getSessionOrNull()`
  Returns the EBX® session for the current authenticated user or `null` if the user is not authenticated.

- ## Uses of Session in com.orchestranetworks.rest.security

  Methods in com.orchestranetworks.rest.security that return Session
  Modifier and Type
  Method
  Description
  `Session`
  AuthorizationContext.`getSession()`
  Returns the EBX® session for the current user.

- ## Uses of Session in com.orchestranetworks.scheduler

  Methods in com.orchestranetworks.scheduler that return Session
  Modifier and Type
  Method
  Description
  `Session`
  ScheduledExecutionContext.`getSession()`
  Returns the session associated with this execution.

- ## Uses of Session in com.orchestranetworks.schema

  Methods in com.orchestranetworks.schema that return Session
  Modifier and Type
  Method
  Description
  `Session`
  SchemaDocumentationContext.`getSession()`
  Returns the current session or `null`.
  Methods in com.orchestranetworks.schema with parameters of type Session
  Modifier and Type
  Method
  Description
  `BusinessObjectModel`
  SchemaNode.`getBusinessObjectModel(Adaptation aDataset, Session aSession)`
  Returns the business object model associated to this node if it is a table node.
  `String`
  SchemaNode.`getDescription(Session aSession)`
  Returns the localized description of this node in the context of a user session.
  `String`
  SchemaNode.`getLabel(Session aSession)`
  Returns the label of this node for the specified session.
  `SchemaNodeRelationships`
  SchemaNode.`getRelationships(Adaptation aDataset, Session aSession)`
  Returns the relationships defined by this node.
  `SchemaNodeRelationships`
  SchemaNode.`getRelationships(Adaptation aDataset, Session aSession, boolean includeMetadata)`
  Returns the relationships defined by this node.

- ## Uses of Session in com.orchestranetworks.schema.businessObjects

  Methods in com.orchestranetworks.schema.businessObjects that return Session
  Modifier and Type
  Method
  Description
  `Session`
  Entity.`getSessionOrNull()`
  Returns the session used for creating this business object.
  Methods in com.orchestranetworks.schema.businessObjects with parameters of type Session
  Modifier and Type
  Method
  Description
  `List<BusinessObjectModel>`
  DataModelBusinessObjectModels.`getBusinessObjectModels(Adaptation aDataset, Session aSession)`
  Returns all the business object models defined in the data model.
  `BusinessObjectModel`
  DataModelBusinessObjectModels.`getBusinessObjetModelForTable(SchemaNode aTableNode, Adaptation aDataset, Session aSession)`
  Returns the business object model associated to the specified table.
  `MainEntity`
  BusinessObjectModel.`initForRead(Adaptation aRecord, Session aSessionOrNull)`
  Creates a read only facade from the specified record of the main table of this business object model.
  `BusinessObjectModel`
  DataModelBusinessObjectModels.`lookupBusinessObjectModel(String aName, Adaptation aDataset, Session aSession)`
  Return the business object model associated to the specified name.

- ## Uses of Session in com.orchestranetworks.schema.relationships

  Methods in com.orchestranetworks.schema.relationships with parameters of type Session
  Modifier and Type
  Method
  Description
  `ExplicitRelationship`
  SchemaNodeExplicitRelationship.`getExplicitRelationship(Adaptation aDataset, Session aSession)`
  Returns the `ExplicitRelationship` object associated with this relationship.
  `static RequestResult`
  RelationshipsHelper.`getExplicitRelationshipResult(Adaptation aRecord, SchemaNode anExplicitRelationshipNode, Session aSession)`
  Returns the result of the explicit relationship defined by the specified node, in the context of the specified record.
  `static ReverseRelationshipResult`
  RelationshipsHelper.`getInterDatasetReferringRecords(Adaptation aReferencedRecord, SchemaNode aReferringNode, Adaptation aReferringDataset, Session aSession)`
  Returns the records in the specified referring dataset that refer to the specified record through the corresponding foreign key constraint, selection link or association link.
  `static ReverseRelationshipResult`
  RelationshipsHelper.`getIntraDatasetReferringRecords(Adaptation aReferencedRecord, SchemaNode aReferringNode, Session aSession)`
  Returns the records in the same dataset that refer to the specified record through the corresponding foreign key constraint, selection link or association link.
  `RequestResult`
  SchemaNodeExplicitRelationship.`getResult(Adaptation aRecord, Session aSessionOrNull)`
  Returns the result of this relationship, in the context of the specified record.

- ## Uses of Session in com.orchestranetworks.schema.trigger

  Methods in com.orchestranetworks.schema.trigger that return Session
  Modifier and Type
  Method
  Description
  `Session`
  TriggerExecutionContext.`getSession()`
  Returns the authenticated session performing the action.

- ## Uses of Session in com.orchestranetworks.schema.types.dataset

  Methods in com.orchestranetworks.schema.types.dataset that return Session
  Modifier and Type
  Method
  Description
  `Session`
  DatasetSetFilterContext.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.schema.types.dataspace

  Methods in com.orchestranetworks.schema.types.dataspace that return Session
  Modifier and Type
  Method
  Description
  `Session`
  DataspaceSetFilterContext.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.service

  Methods in com.orchestranetworks.service that return Session
  Modifier and Type
  Method
  Description
  `Session`
  Session.`clone(Map<String,String> someInputParameters)`
  Returns a session cloned from this session with specific input parameters.
  `Session`
  ProcedureContext.`getSession()`
  Returns the current session context.
  `Session`
  ProgrammaticService.`getSession()`
  Returns the current session of this service.
  `abstract Session`
  ServiceContext.`getSession()`
  Deprecated.
  Returns the current session context.
  `Session`
  SessionPermissions.`getSession()`
  Deprecated.
  Since 5.4.1, this method returns `null` if this instance has been created directly to evaluate user permissions.
  Methods in com.orchestranetworks.service with parameters of type Session
  Modifier and Type
  Method
  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 `aSession` with specific input parameters.
  `AccessPermission`
  AccessRule.`getPermission(Adaptation aDataSetOrRecord, Session aSession, SchemaNode aNode)`
  Returns permissions for the specified arguments.
  `AccessPermission`
  AccessRule.NoWriteRule.`getPermission(Adaptation anAdaptation, Session aSession, SchemaNode aNode)`
  `ActionPermission`
  ServicePermission.`getPermission(SchemaNode aNode, Adaptation aDataSetOrRecord, Session aSession)`
  Returns a permission for the specified arguments.
  `ActionPermission`
  ServicePermissionForHierarchy.`getPermissionForHierarchy(HierarchyNode aHierarchyNode, Session aSession)`
  Returns the permissions for the arguments specified.

- ## Uses of Session in com.orchestranetworks.service.directory

  Methods in com.orchestranetworks.service.directory with parameters of type Session
  Modifier and Type
  Method
  Description
  `URI`
  Directory.`getUserAuthenticationURI(Session aSession)`
  Deprecated.
  Since 6.1.3, it is recommended to use the property `ebx.security.loginPage.url` instead.
  `URI`
  DirectoryHandler.`getUserAuthenticationURI(Session aSession)`
  Deprecated.
  Since 6.1.3, see `Directory.getUserAuthenticationURI(Session)`.

- ## Uses of Session in com.orchestranetworks.service.extensions

  Methods in com.orchestranetworks.service.extensions with parameters of type Session
  Modifier and Type
  Method
  Description
  `AdaptationTreeOptimizerIterator`
  AdaptationTreeOptimizerSpec_MutualizeCommons.`createOptimizerIterator(Session aSession)`
  `AdaptationTreeOptimizerIterator`
  AdaptationTreeOptimizerSpec_RemoveDuplicates.`createOptimizerIterator(Session aSession)`
  `abstract AdaptationTreeOptimizerIterator`
  AdaptationTreeOptimizerSpec.`createOptimizerIterator(Session aSession)`
  Builds an iterator for dataset tree optimization.
  `void`
  LockSpec.`lock(AdaptationHome aDataSpace, Session aSession)`
  Locks the specified dataspace.
  `abstract ProcedureResult`
  ReplicationUnit.`performRefresh(Session aSession)`
  Refreshes the tables included by this replication unit.
  `void`
  LockSpec.`unlock(AdaptationHome aDataSpace, Session aSession)`
  Unlocks the specified dataspace.

- ## Uses of Session in com.orchestranetworks.ui

  Methods in com.orchestranetworks.ui that return Session
  Modifier and Type
  Method
  Description
  `Session`
  UIContext.`getSession()`
  Deprecated.
  Replaced by `UISessionContext.getSession()`
  `Session`
  UIFormRequestContext.`getSession()`
  Returns the current session.
  `Session`
  UILabelRendererContext.`getSession()`
  Returns the current user session.
  `Session`
  UISessionContext.`getSession()`
  Returns the current session.
  `Session`
  UITableFilterContext.`getSession()`
  Returns the current session.
  Methods in com.orchestranetworks.ui with parameters of type Session
  Modifier and Type
  Method
  Description
  `static UIHttpManagerComponent`
  UIHttpManagerComponent.`createWithURIWithParametersForSubSession(String uriWithParameters, Session aSession)`
  Creates an instance of this class in order to call the EBX® user interface in a separate sub-session (namely, a Web Component).

- ## Uses of Session in com.orchestranetworks.ui.form.widget

  Methods in com.orchestranetworks.ui.form.widget that return Session
  Modifier and Type
  Method
  Description
  `Session`
  WidgetValidationContext.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.ui.perspective

  Methods in com.orchestranetworks.ui.perspective with parameters of type Session
  Modifier and Type
  Method
  Description
  `static PerspectiveHandler`
  PerspectiveHandler.`newInstance(Repository repository, Session aSession)`
  Returns a new instance of the perspective handler.

- ## Uses of Session in com.orchestranetworks.userservice

  Methods in com.orchestranetworks.userservice that return Session
  Modifier and Type
  Method
  Description
  `Session`
  UserServiceRequest.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.userservice.permission

  Methods in com.orchestranetworks.userservice.permission that return Session
  Modifier and Type
  Method
  Description
  `Session`
  ServicePermissionRuleContext.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.userservice.schema

  Methods in com.orchestranetworks.userservice.schema that return Session
  Modifier and Type
  Method
  Description
  `Session`
  UserServiceAssociationRecordFormContext.`getSession()`
  Returns the current session.
  `Session`
  UserServiceRecordFormContext.`getSession()`
  Returns the current session.

- ## Uses of Session in com.orchestranetworks.workflow

  Methods in com.orchestranetworks.workflow that return Session
  Modifier and Type
  Method
  Description
  `Session`
  ActionPermissionsOnWorkflowContext.`getSession()`
  The session associated with the current user.
  `Session`
  ConditionBeanContext.`getSession()`
  Always throws `UnsupportedOperationException`
  `Session`
  ConditionContext.`getSession()`
  Always throws `UnsupportedOperationException`
  `Session`
  ProcessExecutionInfoContext.`getSession()`
  Returns a system-user session (not an authenticated user session).
  `Session`
  UserTaskBeforeWorkItemCompletionContext.`getSession()`
  Returns the authenticated session of the user who is doing the current interaction.
  `Session`
  UserTaskUsersForAllocationCollectorContext.`getSession()`
  Returns the authenticated session of the user.
  `Session`
  WorkflowTriggerWorkItemAuthenticatedContext.`getSession()`
  Returns the authenticated session of the current user.
  Methods in com.orchestranetworks.workflow with parameters of type Session
  Modifier and Type
  Method
  Description
  `static WorkflowEngine`
  WorkflowEngine.`getFromRepository(Repository aRepository, Session aSession)`
  Creates a workflow engine from a repository and, optionally, a session.
  `List<UserTask.WorkItem>`
  WorkflowEngine.`getWorkItemsOfferedToSession(Session aSession)`
  Returns all the work items offered to a Session.