com.crystaldecisions.sdk.plugin.desktop.common
Interface IProcessingExtension


public interface IProcessingExtension

This interface allows you to retrieve information about a processing extension contained in the ProcessingExtensions Collection. You can also update the location and description of the processing extension.


Method Summary
 java.lang.String getDescription()
           Returns the description of the processing extension.
 java.lang.String getName()
           Returns the name of the processing extension.
 java.lang.String getPath()
           Returns the location of the processing extension.
 void setDescription(java.lang.String description)
           Sets the description of the processing extension.
 void setPath(java.lang.String path)
           Sets the location of the processing extension.
 

Method Detail

getName

public java.lang.String getName()
                         throws SDKException

Returns the name of the processing extension.

Returns:
A String specifying the name of the processing extension.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getPath

public java.lang.String getPath()
                         throws SDKException

Returns the location of the processing extension. When the associated object is a report object as opposed to an IReportGlobal object, the path will not be set.

Returns:
A String specifying the location of the processing extension.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setPath

public void setPath(java.lang.String path)

Sets the location of the processing extension. When the associated object is a report object as opposed to an IReportGlobal object, the path will not be set.

Parameters:
path - A String specifying the location of the processing extension.

getDescription

public java.lang.String getDescription()
                                throws SDKException

Returns the description of the processing extension. When the associated object is a report object as opposed to an IReportGlobal object, the description will not be set.

Returns:
A String containing the description of the processing extension.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the processing extension. When the associated object is a report object as opposed to an IReportGlobal object, the description will not be set.

Parameters:
description - A String containing the description of the processing extension.