com.appiancorp.suiteapi.process.analytics2

Class ProcessAnalyticsServiceUtils

java.lang.Object

com.appiancorp.suiteapi.process.analytics2.ProcessAnalyticsServiceUtils

public class ProcessAnalyticsServiceUtils
extends java.lang.Object

This class supplements the ProcessAnalyticsService with additional methods. These methods were not put directly on the service only because they would have coupled the services to the servlet container.

Constructor Summary

Constructors

Constructor and Description
ProcessAnalyticsServiceUtils()

Method Summary

Modifier and Type	Method and Description
ProcessReport[]	getProcessReportsUsingAlias(java.lang.String[] aliases_, javax.servlet.ServletContext servletContext_, ProcessAnalyticsService service_) Retrieve multiple process reports by their aliases.
ProcessReport	getProcessReportUsingAlias(java.lang.String alias_, javax.servlet.ServletContext servletContext_, ProcessAnalyticsService service_) Retrieve a process report using the alias that is defined for that report in the analytics configuration file.
ProcessReport[]	getSystemProcessViews(javax.servlet.ServletContext servletContext_, ProcessAnalyticsService service_, java.util.Locale locale_) Retrieve the process reports defining the system process views.
ProcessReport[]	getSystemTaskViews(javax.servlet.ServletContext servletContext_, ProcessAnalyticsService service_) Retrieve the process reports defining the system task views.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessAnalyticsServiceUtils

public ProcessAnalyticsServiceUtils()

Method Detail

getProcessReportUsingAlias

public ProcessReport getProcessReportUsingAlias(java.lang.String alias_,
                                                javax.servlet.ServletContext servletContext_,
                                                ProcessAnalyticsService service_)
                                         throws PrivilegeException

Retrieve a process report using the alias that is defined for that report in the analytics configuration file.

Parameters:

alias_ - the alias for the report.

servletContext_ - the context for the servlet container.

service_ - the ProcessAnalyticsService.

Returns:

the report.

Throws:

PrivilegeException - if the user does not have rights to view the report.

getProcessReportsUsingAlias

public ProcessReport[] getProcessReportsUsingAlias(java.lang.String[] aliases_,
                                                   javax.servlet.ServletContext servletContext_,
                                                   ProcessAnalyticsService service_)

Retrieve multiple process reports by their aliases.

Parameters:

aliases_ - the aliases for the reports.

servletContext_ - the context for the servlet container.

service_ - the ProcessAnalyticsService.

Returns:

the reports.

See Also:

getProcessReportUsingAlias(String, ServletContext, ProcessAnalyticsService)

getSystemTaskViews

public ProcessReport[] getSystemTaskViews(javax.servlet.ServletContext servletContext_,
                                          ProcessAnalyticsService service_)

Retrieve the process reports defining the system task views. The system task views are the reports declared as such in the analytics configuration file.

Parameters:

servletContext_ - the context for the servlet container.

service_ - the ProcessAnalyticsService.

Returns:

the system task views.

getSystemProcessViews

public ProcessReport[] getSystemProcessViews(javax.servlet.ServletContext servletContext_,
                                             ProcessAnalyticsService service_,
                                             java.util.Locale locale_)

Retrieve the process reports defining the system process views. The system process views are the reports declared as such in the analytics configuration file.

Parameters:

servletContext_ - the context for the servlet container.

service_ - the ProcessAnalyticsService.

locale_ - the locale for the current user

Returns:

the system process views.