Package com.orchestranetworks.addon.dqid.dashboard

Class DashboardConfiguration

java.lang.Object

com.orchestranetworks.addon.dqid.dashboard.DashboardConfiguration

public final class DashboardConfiguration
extends java.lang.Object

Represents a dashboard configuration in DashboardExportSpec.

Method Summary

Modifier and Type	Method	Description
static DashboardConfiguration	getDashboardConfigForDefaultStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode)	Returns a DashboardConfiguration instance for the default storage configured for the dashbhoard.
static DashboardConfiguration	getDashboardConfigForDefaultStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode, java.lang.String dashboardContextCode)	Deprecated. Since 2.5.0, the dashboard context is no longer available.
static DashboardConfiguration	getDashboardConfigForIntegrationStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode)	Returns a DashboardConfiguration instance for integration storage.
static DashboardConfiguration	getDashboardConfigForIntegrationStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode, java.lang.String dashboardContextCode)	Deprecated. Since 2.5.0, the dashboard context is no longer available.
static DashboardConfiguration	getDashboardConfigForProductionStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode)	Returns a DashboardConfiguration instance for production storage.
static DashboardConfiguration	getDashboardConfigForProductionStorage(com.orchestranetworks.instance.Repository repository, java.lang.String dashboardCode, java.lang.String dashboardContextCode)	Deprecated. Since 2.5.0, the dashboard context is no longer available.
com.onwbp.adaptation.PrimaryKey	getDashboardContextKey()	Deprecated. Since 2.5.0, the dashboard context is removed.
com.onwbp.adaptation.PrimaryKey	getDashboardKey()	Returns the PrimaryKey of the dashboard.
com.onwbp.adaptation.PrimaryKey	getStorageKey()	Returns the PrimaryKey of the storage.

Methods inherited from class java.lang.Object

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

Method Detail

getDashboardConfigForDefaultStorage

public static DashboardConfiguration getDashboardConfigForDefaultStorage(com.orchestranetworks.instance.Repository repository,
                                                                         java.lang.String dashboardCode)
                                                                  throws DQIdException

Returns a DashboardConfiguration instance for the default storage configured for the dashbhoard.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid.

getDashboardConfigForDefaultStorage

public static DashboardConfiguration getDashboardConfigForDefaultStorage(com.orchestranetworks.instance.Repository repository,
                                                                         java.lang.String dashboardCode,
                                                                         java.lang.String dashboardContextCode)
                                                                  throws DQIdException

Deprecated.

Since 2.5.0, the dashboard context is no longer available. Use getDashboardConfigForDefaultStorage(Repository, String) instead.

Returns a DashboardConfiguration instance for the default storage configured for the dashbhoard.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

dashboardContextCode - The unique code of the target dashboard context. This is optional if the dashboard is not configured with any contexts.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid.

getDashboardConfigForProductionStorage

public static DashboardConfiguration getDashboardConfigForProductionStorage(com.orchestranetworks.instance.Repository repository,
                                                                            java.lang.String dashboardCode)
                                                                     throws DQIdException

Returns a DashboardConfiguration instance for production storage.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid, or the storage is not found.

getDashboardConfigForProductionStorage

public static DashboardConfiguration getDashboardConfigForProductionStorage(com.orchestranetworks.instance.Repository repository,
                                                                            java.lang.String dashboardCode,
                                                                            java.lang.String dashboardContextCode)
                                                                     throws DQIdException

Deprecated.

Since 2.5.0, the dashboard context is no longer available. Use getDashboardConfigForProductionStorage(Repository, String) instead.

Returns a DashboardConfiguration instance for production storage.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

dashboardContextCode - The unique code of the target dashboard context. This is optional if the dashboard is not configured with any contexts.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid, or the storage is not found.

getDashboardConfigForIntegrationStorage

public static DashboardConfiguration getDashboardConfigForIntegrationStorage(com.orchestranetworks.instance.Repository repository,
                                                                             java.lang.String dashboardCode,
                                                                             java.lang.String dashboardContextCode)
                                                                      throws DQIdException

Deprecated.

Since 2.5.0, the dashboard context is no longer available. Use getDashboardConfigForIntegrationStorage(Repository, String) instead.

Returns a DashboardConfiguration instance for integration storage.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

dashboardContextCode - The unique code of the target dashboard context. This is optional if the dashboard is not configured with any contexts.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid, or the storage is not found.

getDashboardConfigForIntegrationStorage

public static DashboardConfiguration getDashboardConfigForIntegrationStorage(com.orchestranetworks.instance.Repository repository,
                                                                             java.lang.String dashboardCode)
                                                                      throws DQIdException

Returns a DashboardConfiguration instance for integration storage.

Parameters:

repository - The current repository.

dashboardCode - The unique code of the target dashboard.

Throws:

DQIdException - If the unique code of either the dashboard or the dashboard context is invalid, or the storage is not found.

getDashboardKey

public com.onwbp.adaptation.PrimaryKey getDashboardKey()

Returns the PrimaryKey of the dashboard.

getDashboardContextKey

public com.onwbp.adaptation.PrimaryKey getDashboardContextKey()

Deprecated.

Since 2.5.0, the dashboard context is removed.

Returns the PrimaryKey of the dashboard context.

getStorageKey

public com.onwbp.adaptation.PrimaryKey getStorageKey()

Returns the PrimaryKey of the storage.