com.ibm.pim.extensionpoints
Interface RichSearchReportFunctionArguments

All Superinterfaces:
FunctionArguments

public interface RichSearchReportFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to RichSearchReportFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getCatalog()
          Obtains the catalog for this RichSearchReportFunction.
 java.lang.String getDocName()
          Obtains the document path within the docstore where the output from this rich search result is expected to be created.
 Hierarchy getHierarchy()
          Obtains the hierarchy for this RichSearchReportFunction.
 PIMCollection getReportSet()
          Obtains the set for this report.
 java.lang.String getViewName()
          Obtains the view name for this invocation.
 
Methods inherited from interface com.ibm.pim.extensionpoints.FunctionArguments
getCustomParameter, setCustomParameter
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getHierarchy

Hierarchy getHierarchy()
Obtains the hierarchy for this RichSearchReportFunction.

null if report set contains items.


getViewName

java.lang.String getViewName()
Obtains the view name for this invocation.


getDocName

java.lang.String getDocName()
Obtains the document path within the docstore where the output from this rich search result is expected to be created.

Equivalent in Script API:
the scripting variable 'docName' passed for the corresponding script.

getCatalog

Catalog getCatalog()
Obtains the catalog for this RichSearchReportFunction.

null if report set contains categories.


getReportSet

PIMCollection getReportSet()
Obtains the set for this report.

Set will contain items or categories depending on the report.