com.cloupia.model.cIM

Class ReportContextRegistry

java.lang.Object

com.cloupia.model.cIM.ReportContextRegistry

public final class ReportContextRegistry
extends java.lang.Object

Used to register report contexts. Report contexts need to be properly registered otherwise any reports using unrecognized contexts will not be shown in the UI.

Method Summary

Modifier and Type	Method and Description
DynReportContext	getContextByName(java.lang.String name) Use this method to get the report context if all you have is the name of the context.
static ReportContextRegistry	getInstance()
DynReportContext[]	getValidatedContexts() Returns all the contexts registered by validated modules.
DynReportContext	register(int type, java.lang.String name, java.lang.String label) Use this method to register a new report context into the system.
DynReportContext	register(java.lang.String name, java.lang.String label) Use this method to register a new report context if you are an unvalidated open automation developer.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ReportContextRegistry getInstance()

register

public DynReportContext register(int type,
                                 java.lang.String name,
                                 java.lang.String label)
                          throws java.lang.Exception

Use this method to register a new report context into the system. This method is ONLY applicable if you already know the unique type of your context. Only MSP developers and validated open automation developers have assigned types, which is guaranteed to be unique by UCSD team.

Parameters:

type - A unique integer to identify this report context.

name - A unique string to identify this report context.

label - A user friendly readable string to describe this context.

Returns:

A DynReportContext containing all the parameters passed in.

Throws:

java.lang.Exception - Throws an exception if the type and name are not unique.

register

public DynReportContext register(java.lang.String name,
                                 java.lang.String label)
                          throws java.lang.Exception

Use this method to register a new report context if you are an unvalidated open automation developer. This method will auto generate the report context for you such that the type value is unique. NOTE: you should not assume the type value generated is the same across UCSD installations. You may get 5000 in one installation and 6000 in another. This method should only be used during the development phase of your module, once validated you will need to switch over to the other register method!

Parameters:

name - A unique string to identify this report context.

label - A user friendly readable string to describe this context.

Returns:

A DynReportContext with the type populated with an autogenerated unique value.

Throws:

java.lang.Exception - Throws exception if auto generation of value fails.

getValidatedContexts

public DynReportContext[] getValidatedContexts()

Returns all the contexts registered by validated modules.

getContextByName

public DynReportContext getContextByName(java.lang.String name)

Use this method to get the report context if all you have is the name of the context. This is intended for use primarily with open automation. Where you have an auto generated context but don't have a reference to it!

Parameters:

name - The name of the context you registered with.

Returns:

The DynReportContext if a context with name exists, null otherwise.