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

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

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)
           
 void disconnect()
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           
 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()
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           
 void refresh()
           
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           
 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)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CustomFunction

public CustomFunction(ICustomFunction src)

CustomFunction

public CustomFunction()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

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)

readElement

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

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
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)

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()