com.crystaldecisions.sdk.occa.report.data
Class CustomFunction

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Formula
      extended by com.crystaldecisions.sdk.occa.report.data.CustomFunction
All Implemented Interfaces:
ICustomFunction, IFormula, IClone

public class CustomFunction
extends Formula
implements ICustomFunction

This object enables you to set and retrieve information for custom functions. Use the CustomFunctionController object to retrieve and modify a custom function.


Constructor Summary
CustomFunction()
           
CustomFunction(ICustomFunction src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
          For internal use only.
 void disconnect()
           
 void doControllerModification(java.lang.Object newObject)
          For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 java.lang.String getLinkedURI()
           
 java.lang.String getName()
          Returns the name of the custom function.
 int getVersion()
           
 boolean hasContent(java.lang.Object srcCustomFunction)
           
 boolean isConnected()
           
 boolean isDirectlyControllable()
          For internal use only.
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void refresh()
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setLinkedURI(java.lang.String URI)
           
 void setName(java.lang.String name)
          Sets the name of the custom function.
 void setVersion(int version)
           
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Formula
enumerateMembers, getControllableMixin, getFormulaNullTreatment, getSyntax, getText, setFormulaNullTreatment, setSyntax, setText
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IFormula
getFormulaNullTreatment, getSyntax, getText, setFormulaNullTreatment, setSyntax, setText
 

Constructor Detail

CustomFunction

public CustomFunction(ICustomFunction src)

CustomFunction

public CustomFunction()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Formula

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Formula

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
For internal use only.

Overrides:
createMember in class Formula

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
For internal use only.

Overrides:
endElement in class Formula

getName

public java.lang.String getName()
Description copied from interface: ICustomFunction

Returns the name of the custom function.

Specified by:
getName in interface ICustomFunction
Returns:
The name of the custom function as a String.

hasContent

public boolean hasContent(java.lang.Object srcCustomFunction)
Overrides:
hasContent in class Formula

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
For internal use only.

Overrides:
readElement in class Formula

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class Formula
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
For internal use only.

Overrides:
save in class Formula
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
For internal use only.

Overrides:
saveContents in class Formula
Throws:
java.io.IOException

setName

public void setName(java.lang.String name)
Description copied from interface: ICustomFunction

Sets the name of the custom function.

Specified by:
setName in interface ICustomFunction
Parameters:
name - The name of the custom function as a String.

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
For internal use only.

Overrides:
startElement in class Formula

getLinkedURI

public java.lang.String getLinkedURI()

getVersion

public int getVersion()

setLinkedURI

public void setLinkedURI(java.lang.String URI)

setVersion

public void setVersion(int version)

isConnected

public boolean isConnected()

disconnect

public void disconnect()

refresh

public void refresh()

doControllerModification

public void doControllerModification(java.lang.Object newObject)
                              throws ReportSDKException
Description copied from class: Formula
For internal use only.

Overrides:
doControllerModification in class Formula
Throws:
ReportSDKException

isDirectlyControllable

public boolean isDirectlyControllable()
Description copied from class: Formula
For internal use only.

Overrides:
isDirectlyControllable in class Formula