lumis.service.autoadministration
Class NavigationDataProvider

java.lang.Object
  lumis.service.autoadministration.NavigationDataProvider

All Implemented Interfaces:

IDataProvider<TabularSource<?>>

public class NavigationDataProvider
extends Object
implements IDataProvider<TabularSource<?>>

Data provider for returning the interfaces instances available for auto administration. This includes Channels, Service Instances and Interface Instances.

The items are order so that if the user has selected to group by channel it should be ordered as follows:

        Channel 1 (by position)  
                Service Instance (order by name)
                        Interface Instance (order by name)
 

The items are order so that if the user has selected to group by service instance it should be ordered as follows:

  
        Service Instance (order by name)
                Interface Instance (order by name)
 

The structure of the row should be as follows:

 
                <id></id>
                <name></name>
                <indentAmount></indentAmount>
                <hasChildren></hasChildren>
                <targetLink></targetLink>
                <parentPath></parentPath>
                <position></position>
                <path></path>
                <type></type>
  

The values represented by each of these items are:

id

If it's a channel, it will represent a channel id, if it's a service instance, it will represent the service instance's id, if it's a interface instance, it will repress it's id.

name

The respective name of the object represented by the id (channel: channel's name; service instance: service instance's name; interface instance: interface instance's display name).

indentAmount

the number of indents that will need to happen to correctly align the values as a tree.

hasChildren

Indicates if the current value has children (i.e. channels or service instances). If the value is false, it represents an interface instance.

parentPath

Field created to help out in ordering. It indicates the current item's parent path.

position

Field created to help out in ordering. It indicates the current item's position within the parent channel if this item is a channel. If the value is smaller than 0, then the current item is either a Service Instance or as Interface Instance.

path

The current item's path. This would usually be: <parentPath> / <name> .

type

The current item's type. CH for channel, SI for service instance or II for interface instance..

Since:

7.0.0

Field Summary

Fields inherited from interface lumis.doui.source.IDataProvider

INTERFACE_INSTANCE_PROPERTY_FIELDS, INTERFACE_INSTANCE_PROPERTY_FILTERS, INTERFACE_INSTANCE_PROPERTY_MAX_ROWS, INTERFACE_INSTANCE_PROPERTY_ORDER_BY, MAX_NUM_ORDER_BY_FIELDS

Constructor Summary

NavigationDataProvider()

Method Summary

void	loadData(SessionConfig sessionConfig, TabularSource<?> source, ITransaction transaction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavigationDataProvider

public NavigationDataProvider()
                       throws PortalException

Throws:

PortalException

Method Detail

loadData

public void loadData(SessionConfig sessionConfig,
                     TabularSource<?> source,
                     ITransaction transaction)
              throws PortalException

Specified by:

loadData in interface IDataProvider<TabularSource<?>>

Throws:

PortalException