|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BusinessLayerService
Provides services for business layer objects.
Method Summary | |
---|---|
IStatus |
addCoreUniverses(java.lang.String blPath,
java.util.List<java.lang.String> unxIdentifiers)
Adds core universes to a linked universe. |
void |
detectLovColumns(BusinessQueryLov businessQueryLov)
Creates the columns of the list of values from the query specification on which the list of values is based. |
void |
detectLovColumns(SQLQueryLov sqlQueryLov)
Creates the columns of the list of values from the SQL expression on which the list of values is based. |
BlItem |
getBlItem(BusinessLayer businessLayer,
java.lang.String path,
boolean failed)
Returns a business item from its full path. |
java.lang.String |
getBlItemPath(BlItem item)
Generates the full path of a business item in the CMS repository. |
java.util.List<java.lang.String> |
getImplicitTables(BlItem blItem)
Returns the list of implicit tables of a business item. |
IStatus |
includeCoreUniverses(java.lang.String blPath,
java.util.List<java.lang.String> unxIdentifiers)
Integrates core universe components into a linked universe (folders, objects, tables, joins, views, and so on). |
IStatus |
refreshUniverseReferences(java.lang.String blPath)
Updates the paths or names of the core universes used in a linked universe. |
IStatus |
removeCoreUniverses(java.lang.String blPath,
java.util.List<java.lang.String> unxIdentifiers)
Removes core universes from a linked universe. |
IStatus |
synchronizeCoreUniverses(java.lang.String blPath,
java.util.List<java.lang.String> unxIdentifiers)
Synchronizes core universe components of a linked universe with their latest versions in the CMS repository (folders, objects, tables, joins, views, and so on). |
IStatus |
validateBusinessFilterExpression(java.lang.String expression)
Validates the expression of a business filter. |
IStatus |
validateBusinessQueryLovExpression(java.lang.String expression)
Validates the business query of a list of values. |
Method Detail |
---|
java.util.List<java.lang.String> getImplicitTables(BlItem blItem)
It contains the tables on which the business item is based. It means that implicit tables are those of the SQL expression attached to a business item. For example, the "Product Id" dimension, whose SELECT is "PRODUCT.PRODUCT_ID", has the table "PRODUCT" as implicit table. The list cannot be modified.
The tables of the list belong to the business layer persisted physically on the machine (.blx
file).
Implicit tables do not comprise extra tables. If an implicit table is added as an extra table to the business item,
then the table is ignored and removed from the list of extra tables at save time.
blItem
- The business item
List
containing the names of the implicit tablesvoid detectLovColumns(SQLQueryLov sqlQueryLov)
This method detects the columns from the SQL expression and then creates the columns of the
SQLQueryLov
object. The columns cannot be edited (adding,
modifying, removing).
After the expression is edited, this method needs to be used so that columns can be computed. When the business layer is saved and loaded, the columns are computed automatically.
Example:
SQLQueryLov sqlQueryLov = businessLayerFactory.createSQLQueryLov("SQLQueryLov", businessLayer); sqlQueryLov.setDescription("Description of SQLQueryLov"); sqlQueryLov.setSQLExpression("SELECT * FROM CUSTORDER"); ... BusinessLayerService businessLayerService = context.getService(BusinessLayerService.class); businessLayerService.detectLovColumns(sqlQueryLov);
sqlQueryLov
- The list of values attached to a data foundationBusinessLayerFactory.createSQLQueryLov(String, BusinessLayer)
,
Lov.setDescription(String)
,
SQLQueryLov.setSQLExpression(String)
,
SlContext.getService(Class)
void detectLovColumns(BusinessQueryLov businessQueryLov)
This method detects the columns from the query specification and then creates the columns of the
BusinessQueryLov
object. The columns cannot be edited (adding,
modifying, removing).
After the expression is edited, this method needs to be used so that columns can be computed. When the business layer is saved and loaded, the columns are computed automatically.
Example:
BusinessQueryLov businessQueryLov = businessLayerFactory.createBusinessQueryLov("BusinessQueryLov", businessLayer); businessQueryLov.setDescription("Description of BusinessQueryLov"); businessQueryLov.setExpression("... "); ... BusinessLayerService businessLayerService = context.getService(BusinessLayerService.class); businessLayerService.detectLovColumns(businessQueryLov);
businessQueryLov
- The list of values attached to a business layerBusinessLayerFactory.createBusinessQueryLov(String, BusinessLayer)
,
Lov.setDescription(String)
,
BusinessQueryLov.setExpression(String)
,
SlContext.getService(Class)
java.lang.String getBlItemPath(BlItem item)
The full path is based on the non-localized name of the business item.
Full paths adhere to the following rules:
Examples:
item
- The business item
getBlItem(BusinessLayer, String, boolean)
BlItem getBlItem(BusinessLayer businessLayer, java.lang.String path, boolean failed)
businessLayer
- A business layerpath
- The item full pathfailed
- If true
, an exception is raised (item not found)
BlItem
object, or null if item is not found and failed
set to false
getBlItemPath(BlItem)
IStatus addCoreUniverses(java.lang.String blPath, java.util.List<java.lang.String> unxIdentifiers)
blPath
- The path of the local business layer with a secured connection, for example C:\BusinessLayers\myProject.blx
unxIdentifiers
- Identifiers of the core universes stored in the CMS repository. They can be the following:
Universes
root folder. See CmsResourceService.UNIVERSES_ROOT
.
Example: /Universes/myCmsFolder/MyUniverse.unx
Example: AUkhFsg72ntHpql8Izl9pv0
IStatus
objectremoveCoreUniverses(String blPath, List< String > unxIdentifiers)
IStatus removeCoreUniverses(java.lang.String blPath, java.util.List<java.lang.String> unxIdentifiers)
blPath
- The path of the local business layer with a secured connection, for example C:\BusinessLayers\myProject.blx
unxIdentifiers
- Identifiers of the core universes stored in the CMS repository. They can be the following:
Universes
root folder. See CmsResourceService.UNIVERSES_ROOT
.
Example: /Universes/myCmsFolder/MyUniverse.unx
Example: AUkhFsg72ntHpql8Izl9pv0
IStatus
objectaddCoreUniverses(String blPath, List< String > unxIdentifiers)
IStatus includeCoreUniverses(java.lang.String blPath, java.util.List<java.lang.String> unxIdentifiers)
The components of the core universes are copied to the business layer and the underlying data foundation. They become editable in the linked universe.
The links to the core universes are broken. The core universes are removed from the list of core universes.
blPath
- The path of the local business layer with a secured connection, for example C:\BusinessLayers\myProject.blx
unxIdentifiers
- Identifiers of the core universes stored in the CMS repository. They can be the following:
Universes
root folder. See CmsResourceService.UNIVERSES_ROOT
.
Example: /Universes/myCmsFolder/MyUniverse.unx
Example: AUkhFsg72ntHpql8Izl9pv0
IStatus
objectIStatus synchronizeCoreUniverses(java.lang.String blPath, java.util.List<java.lang.String> unxIdentifiers)
Synchronizing means updating, adding, or removing core universe components from the local, linked business layer.
The core universes are synchronized if their revision numbers have been modified, that is, if new revisions have been published.
If the core universes have been moved or renamed in the CMS repository, run refreshUniverseReferences(String)
before you synchronize them.
blPath
- The path of the local business layer with a secured connection, for example C:\BusinessLayers\myProject.blx
unxIdentifiers
- Identifiers of the core universes stored in the CMS repository. They can be the following:
Universes
root folder. See CmsResourceService.UNIVERSES_ROOT
.
Example: /Universes/myCmsFolder/MyUniverse.unx
Example: AUkhFsg72ntHpql8Izl9pv0
IStatus
objectrefreshUniverseReferences(String)
IStatus refreshUniverseReferences(java.lang.String blPath)
Use this method if core universes have been moved or renamed.
blPath
- The path of the local business layer with a secured connection, for example C:\BusinessLayers\myProject.blx
IStatus
objectIStatus validateBusinessFilterExpression(java.lang.String expression)
Use this method to check the XML query against its XSD.
You can also validate the expression through its business fiter by using BusinessFilter.validateExpression()
.
expression
- The expression of the business filter
IStatus
objectIStatus validateBusinessQueryLovExpression(java.lang.String expression)
Use this method to check the XML expression against its XSD.
You can also validate the expression through its list of values by using BusinessQueryLov.validateExpression()
.
expression
- The expression of the list of values
IStatus
objectBusinessQueryLov
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |