Uses of Class
com.orchestranetworks.service.ServiceKey

Packages that use ServiceKey

Package	Description
com.orchestranetworks.interactions	Provides classes for UI interactions.
com.orchestranetworks.schema	Represents XML Schema concepts and provides schema extensions capabilities.
com.orchestranetworks.service	Provides classes and interfaces for implementing specific services and access rules on EBX®.
com.orchestranetworks.ui	This package provides the capability to create custom user interface components that are integrated within EBX®.
com.orchestranetworks.ui.action	This package allows to define actions that can be triggered by the end user.
com.orchestranetworks.ui.perspective
com.orchestranetworks.ui.toolbar	This package allows customizing toolbars.
com.orchestranetworks.userservice	A public API for user services.
com.orchestranetworks.userservice.declaration	A public API for declaring user services.
com.orchestranetworks.userservice.permission	Allows the definition of activation rules and permission rules on user services.

Uses of ServiceKey in com.orchestranetworks.interactions

Methods in com.orchestranetworks.interactions that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	SessionInteraction.getServiceKey()	Returns the service key of this interaction.

Uses of ServiceKey in com.orchestranetworks.schema

Methods in com.orchestranetworks.schema with parameters of type ServiceKey

Modifier and Type	Method	Description
void	SchemaExtensionsContext.setServicePermissionRuleOnNode(Path aPathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule)	Sets a ServicePermissionRule on a node without specifying a custom description.
void	SchemaExtensionsContext.setServicePermissionRuleOnNode(Path aPathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule, UserMessage aDescription)	Declares that the display and execution of the specified service is conditioned by the specified rule, when invoked on the element referred by the specified path.
void	SchemaExtensionsContext.setServicePermissionRuleOnNodeAndAllDescendants(Path aSubTreePathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule)	Sets a ServicePermissionRule on a node subtree without specifying a custom description.
void	SchemaExtensionsContext.setServicePermissionRuleOnNodeAndAllDescendants(Path aSubTreePathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule, UserMessage aDescription)	Declares that the display and execution of the specified service is conditioned by the specified rule, for all elements matching the rule's type of EntitySelection under the specified data model element.

Uses of ServiceKey in com.orchestranetworks.service

Fields in com.orchestranetworks.service declared as ServiceKey

Modifier and Type	Field	Description
static final ServiceKey	ServiceKey.ASSOCIATION_ATTACH	Built-in service to perform an association attachment.
static final ServiceKey	ServiceKey.ASSOCIATION_DETACH	Built-in service to perform an association detachment.
static final ServiceKey	ServiceKey.ASSOCIATION_MOVE	Built-in service to perform an association move.
static final ServiceKey	ServiceKey.CLOSE	Built-in service to close a dataspace or snapshot.
static final ServiceKey	ServiceKey.COMPARE	Built-in service to compare data: The user is directed to the comparison interface.
static final ServiceKey	ServiceKey.CREATE	Built-in service to create a table record: the user is directed to a page in order to a new record in the selected table.
static final ServiceKey	ServiceKey.DEFAULT_SERVICE	Built-in service to access a table record or a dataset.
static final ServiceKey	ServiceKey.DUPLICATE	Built-in service to duplicate a table record.
static final ServiceKey	ServiceKey.EXPORT_TO_CSV	Built-in service to export data from EBX® to CSV format.
static final ServiceKey	ServiceKey.EXPORT_TO_XML	Built-in service to export data from EBX® to XML format.
static final ServiceKey	ServiceKey.HIERARCHY_ATTACH	Built-in service to attach nodes in a hierarchical view.
static final ServiceKey	ServiceKey.HIERARCHY_DETACH	Built-in service to detach nodes in a hierarchical view.
static final ServiceKey	ServiceKey.HIERARCHY_EDIT_LINK_RECORD	Built-in service to edit the record that links two hierarchy nodes.
static final ServiceKey	ServiceKey.HIERARCHY_MASS_MOVE	Built-in service to perform a mass move of nodes in a hierarchical view.
static final ServiceKey	ServiceKey.IMPORT_FROM_CSV	Built-in service to import data from a CSV file into EBX®.
static final ServiceKey	ServiceKey.IMPORT_FROM_XML	Built-in service to import data from an XML file into EBX®.
static final ServiceKey	ServiceKey.INHERIT	Built-in service makes a record inherit from the parent dataset.
static final ServiceKey	ServiceKey.MASS_UPDATE	Built-in service to perform a mass update of records.
static final ServiceKey	ServiceKey.MASSDELETE	Built-in service to perform a mass delete of records.
static final ServiceKey	ServiceKey.MERGE	Built-in service to merge a dataspace into its parent: the user is directed to the merge user interface in order to merge the selected dataspace into its parent dataspace.
static final ServiceKey	ServiceKey.MERGE_VIEW	Built-in service to display the merge view: the user is directed to the merge user interface in order to detect differences and conflicts without performing the merge of the selected dataspace into its parent.
static final ServiceKey	ServiceKey.MY_PROFILE	Built-in service to access current user's profile settings.
static final ServiceKey	ServiceKey.OPEN_LINK_RECORD	Built-in service to edit the record that links an associated object to its parent record.
static final ServiceKey	ServiceKey.OPTIMIZE	Built-in service to optimize and refactor data in EBX®.
static final ServiceKey	ServiceKey.OVERWRITE	Built-in service makes a record overwrite from inheritance of the parent dataset.
static final ServiceKey	ServiceKey.REFRESH_REPLICAS	Built-in service to refresh replicas for replicated tables.
static final ServiceKey	ServiceKey.SELECT_DATASPACE	Built-in service to select a dataspace: the user is directed to a page in order to work with the selected dataspace.
static final ServiceKey	ServiceKey.VALIDATION	Built-in service to validate a dataspace, snapshot, dataset, table or record: the user is directed to the validation report of the selected entity.
static final ServiceKey	ServiceKey.VIEW_HISTORY	Built-in service to view table or row history.
static final ServiceKey	ServiceKey.WORKFLOW	Built-in service to access the data workflows user interface.

Methods in com.orchestranetworks.service that return ServiceKey

Modifier and Type	Method	Description
static ServiceKey	ServiceKey.forModuleServiceName(String moduleName, String serviceName)	Returns the identifier of a service defined in a module (user service on branches or versions, for more information see the class comment).
static ServiceKey	ServiceKey.forName(String serviceName)	Returns the identifier of a service defined in a data model (user service on datasets or records, for more information see the class comment).
abstract ServiceKey	ServiceContext.getServiceKey()	Deprecated. Returns the key of the current service.
static ServiceKey	ServiceKey.parse(String aString)	Returns the service key that corresponds to the specified string.

Methods in com.orchestranetworks.service that return types with arguments of type ServiceKey

Modifier and Type	Method	Description
Iterator<ServiceKey>	UserReference.getPrivileges()	Returns an iterator over ServiceKeys representing the user's privileges.

Methods in com.orchestranetworks.service with parameters of type ServiceKey

Modifier and Type	Method	Description
static UserReference	Profile.forUserWithSpecificPrivilege(String userId, ServiceKey servicePrivilegeGranted)	Returns the user reference specified, with the specific privilege granted.
ActionPermission	SessionPermissions.getHomeActionPermissionForService(ServiceKey serviceKey, AdaptationHome aDataSpaceOrSnapshot)	Returns the current user's permissions for executing the dataspace or snapshot service specified.
ActionPermission	SessionPermissions.getInstanceActionPermissionForService(ServiceKey serviceKey, Adaptation aDataSet)	Returns the current user's permissions for executing the dataset service specified.
ActionPermission	SessionPermissions.getNodeActionPermissionForService(ServiceKey aServiceKey, SchemaNode aNode, Adaptation aDataSetOrRecord)	Returns the current user's permissions for executing the service on the specified node.
ActionPermission	SessionPermissions.getTableActionPermissionForService(ServiceKey serviceKey, AdaptationTable aTable)	Returns the current user's permissions for executing the service in the table 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.
abstract String	ServiceContext.getURLForServiceSelection(Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)	Deprecated. Returns a user interface URL which selects the specified node in the given record or dataset and starts the specified service on it.
abstract String	ServiceContext.getURLForServiceSelection(Adaptation aRecordOrInstance, ServiceKey aServiceKey)	Deprecated. Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
abstract String	ServiceContext.getURLForServiceSelection(ServiceKey aServiceKey)	Deprecated. Returns a user interface URL to start the specified service.
boolean	UserReference.isPrivilegeGranted(ServiceKey aServiceKey)	Returns true if this reference has been granted the privilege to execute the specified service.

Method parameters in com.orchestranetworks.service with type arguments of type ServiceKey

Modifier and Type	Method	Description
static UserReference	Profile.forUserWithSpecificPrivileges(String userId, Set<ServiceKey> servicePrivileges)	Returns the user reference specified, with the specific privileges granted.

Uses of ServiceKey in com.orchestranetworks.ui

Methods in com.orchestranetworks.ui that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	UIHttpManagerComponent.getService()	Returns the service to be activated, null if no specific service has been set.

Methods in com.orchestranetworks.ui with parameters of type ServiceKey

Modifier and Type	Method	Description
void	UIHttpManagerComponent.setService(ServiceKey aServiceKey)	Specifies the service to be activated.

Uses of ServiceKey in com.orchestranetworks.ui.action

Methods in com.orchestranetworks.ui.action that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	ServiceActionInCurrentContext.getServiceKey()

Constructors in com.orchestranetworks.ui.action with parameters of type ServiceKey

Modifier	Constructor	Description
	ServiceActionInCurrentContext(ServiceKey aServiceKey)	Creates an action launching the specified user service.

Uses of ServiceKey in com.orchestranetworks.ui.perspective

Methods in com.orchestranetworks.ui.perspective that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	PerspectiveAction.getServiceKey()	Returns the specified service key.

Uses of ServiceKey in com.orchestranetworks.ui.toolbar

Method parameters in com.orchestranetworks.ui.toolbar with type arguments of type ServiceKey

Modifier and Type	Method	Description
void	ToolbarMenu.addServiceGroup(ServiceGroupKey aGroupKey, List<ServiceKey> excludedService, boolean isSmartFiltering)	Sets the key of the group of service to be displayed.

Uses of ServiceKey in com.orchestranetworks.userservice

Methods in com.orchestranetworks.userservice that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	UserServiceRequest.getServiceKey()	Returns the current service key.

Methods in com.orchestranetworks.userservice with parameters of type ServiceKey

Modifier and Type	Method	Description
String	UserServiceResourceLocator.getURLForServiceSelection(Adaptation aRecordOrInstance, SchemaNode aNode, ServiceKey aServiceKey)	Deprecated. Instead use {UserServiceResourceLocator.getURLForServiceSelection(ServiceKey, Adaptation, SchemaNode, URLQuery).
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey)	Returns a user interface URL to start the specified service.
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet)	Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
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.
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode)	Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrInstance, SchemaNode aNode, URLQuery aQuery)	Returns a user interface URL which selects the specified node of the given record or dataset and starts the specified service on it.
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey, Adaptation aRecordOrDataSet, URLQuery aQuery)	Returns a user interface URL which selects the specified record or dataset and starts the specified service on it.
String	UserServiceResourceLocator.getURLForServiceSelection(ServiceKey aServiceKey, URLQuery aQuery)	Returns a user interface URL to start the specified service.
static UserServiceEventOutcome	UserServiceNext.nextService(ServiceKey aServiceKey)	The current user service will close and a new one will be displayed.
static UserServiceEventOutcome	UserServiceNext.nextService(ServiceKey aServiceKey, Adaptation aRecordOrDataSet)	The current user service will close, the specified record or dataset will be selected and the specified service started.
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.
static UserServiceEventOutcome	UserServiceNext.nextService(ServiceKey aServiceKey, AdaptationTable aTable)	The current user service will close, the specified table will be selected and the specified service started.

Uses of ServiceKey in com.orchestranetworks.userservice.declaration

Methods in com.orchestranetworks.userservice.declaration that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	UserServiceExtensionDeclaration.getExtendedServiceKey()	Returns the identifier of the user service to be extended.
ServiceKey	UserServiceDeclaration.getServiceKey()	Returns the identifier of the user service.
ServiceKey	UserServiceExtensionDeclaration.getServiceKey()	Returns the identifier of the user service extension.

Uses of ServiceKey in com.orchestranetworks.userservice.permission

Methods in com.orchestranetworks.userservice.permission that return ServiceKey

Modifier and Type	Method	Description
ServiceKey	ServicePermissionRuleContext.getServiceKey()	Returns the current service key.