Bookshelf Home | Contents | Index | PDF     

Hierarchy Developer's Guide for Oracle Self-Service E-Billing > APIs for Customizing Oracle Self-Service E-Billing Hierarchy Manager >

IHierarchyService Interface

The IHierarchyService interface provides a contract for creating a hierarchy service that provides an entry-point to the hierarchy module. Implement this interface to create important Hierarchy components such as IHierarchyManager.

To use XMA to obtain an instance of IHierarchyService:

  1. LookupService lookup: LookupServiceFactory.getInstance();
  2. IHierarchyService hierarchyService: (IHierarchyService) lookup.getModule("hierarchy");
  3. Use the IHierarchyService interface to create hierarchy managers and filter queries on hierarchies.

Table 17 describes the methods available for the IHierarchyService API.

Table 17. IHierarchyService Methods
Method
Description

IAttribute createAttribute(java.lang.String name, java.lang.Object value)

Creates an instance of IAttribute, which represents a Hierarchy node attribute.

IExpression createExpression()

Creates an instance of IExpression.

IFilteredQuery createFilteredQueryForIHierarchy()

Creates an instance of IFilteredQuery to manage hierarchy query-related operations.

IFilteredQuery createFilteredQueryForIHierarchyNode()

Creates an instance of IFilteredQuery to manage hierarchy node query-related operations.

IHierarchyAccessManager createHierarchyAccessManager(IHierarchyContext hierarchyContext)

Returns a singleton of the IHierarchyAccessManager to manage hierarchy access.

IHierarchyFolderManager createHierarchyFolderManager()

Creates an instance of IHierarchyFolderManager to manage hierarchy folder-related operations.

IHierarchyManager createHierarchyManager(IUser user)

Creates an instance of IHiearchyManager to manage hierarchy-related operations.

IHierarchyTypeManager createHierarchyTypeManager()

Creates an instance of IHierarchyTypeManager to manage hierarchy type-related operations.

java.util.List getObjectSearchTypes(OMFTypeProperty otp)

Returns a list of HierSearchType objects for the specified OMFTypeProperty

java.util.List getObjectSearchTypes(OMFTypeProperty omfType, IHierarchyType hierType)

Returns a list of hierarchy search types for specified OMF type within given type of hierarchy.
    
Hierarchy Developer's Guide for Oracle Self-Service E-Billing Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.