com.crystaldecisions.sdk.occa.report.application
Class CustomFunctionController

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.application.CustomFunctionController

public class CustomFunctionController
extends java.lang.Object

This object enables you to retrieve and modify custom functions in a report. Custom functions are procedures you create in Crystal Reports to evaluate, make calculations on, or transform data. Reusability is one of the main virtues of custom functions. Custom functions must be added to the report using Crystal Reports.


Method Summary
 void add(ICustomFunction function)
          For internal use only.
 PropertyBag fetchCustomerFunctionRelation(ICustomFunction func)
          For internal use only.
 CustomFunctions getCustomFunctions()
           Returns a collection of the custom functions contained in a report.
 void modify(java.lang.Object oldCustomFunction, ICustomFunction newCustomFunction)
           Modifies a custom function.
 void removeCustomFunction(ICustomFunction function)
          For internal use only.
 void removeCustomFunction(java.lang.String functionName)
          For internal use only.
 void rename(ICustomFunction func, java.lang.String newName)
          For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCustomFunctions

public CustomFunctions getCustomFunctions()
                                   throws ReportSDKException

Returns a collection of the custom functions contained in a report. Custom functions must be added to the report using Crystal Reports. For information on how to do this, see the Crystal Reports online help.

Returns:
A CustomFunctions object containing a collection of custom functions.
Throws:
ReportSDKException

modify

public void modify(java.lang.Object oldCustomFunction,
                   ICustomFunction newCustomFunction)
            throws ReportSDKException

Modifies a custom function. The CustomFunction collection can be accessed by using the getCustomFunctions() method. The index is zero-based. Custom functions must be added to the report using Crystal Reports.

Parameters:
oldCustomFunction - The name of the custom function to be modified, or the CustomFunction object itself.
newCustomFunction - The new custom function object.
Throws:
ReportSDKException

add

public void add(ICustomFunction function)
         throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

removeCustomFunction

public void removeCustomFunction(java.lang.String functionName)
                          throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

removeCustomFunction

public void removeCustomFunction(ICustomFunction function)
                          throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

rename

public void rename(ICustomFunction func,
                   java.lang.String newName)
            throws ReportSDKException
For internal use only.

Throws:
ReportSDKException

fetchCustomerFunctionRelation

public PropertyBag fetchCustomerFunctionRelation(ICustomFunction func)
                                          throws ReportSDKException
For internal use only.

Throws:
ReportSDKException