com.crystaldecisions.sdk.plugin.desktop.program
Interface IProgramPluginBase

All Known Subinterfaces:

IProgram

public interface IProgramPluginBase

This interface allows you to define what types of program objects you want to manage within the BusinessObjects Enterprise Infrastructure.

Field Summary

static java.lang.String	KIND The Kind used to query for Program objects.
static java.lang.String	PROGID The ProgID for the Program Class.

Method Summary

java.lang.Object	getProgramInterface() Returns the program interface for this program.
int	getProgramType() Returns the program type for this program.
byte[]	getResultByteStream() Returns the result data as an array of bytes.
long	getResultLength() Returns length of the result in bytes.
java.lang.String	getResultMIMEType() Mime type for the result data
void	setProgramType(int programType) Sets the program type for this program.
void	writeResult(java.io.OutputStream stream) Writes the result to the specific OutputStream.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for Program objects.

Since:

4.0

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the Program Class.

ProgID	CrystalEnterprise.Program
Query Category	CI_INFOOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.program.IProgram

Query syntax:

SELECT
	SI_DESCRIPTION, SI_NAME, SI_ID
FROM
	CI_INFOOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.Program'

The IProgram interface does not contain any methods or properties that require specific CePropertyIDs to be referenced in the SELECT Statement. However, you can access general InfoObject properties, such as the SI_NAME, SI_DESCRIPTION, and SI_ID from the objects returned by the query. For more information, see program.

Since:

4.0

See Also:

Constant Field Values

Method Detail

setProgramType

void setProgramType(int programType)

Sets the program type for this program.

You can choose from the following types:

Undefined: constant that indicates that the program type is undefined. The int value associated with this constant is 0.

Binary: constant that indicates that the program type is a binary program. The int value associated with this constant is 1.

Java: constant that indicates that the program type is a java program. The int value associated with this constant is 2.

Script: constant that indicates that the program type is a script program. The int value associated with this constant is 3.

See Also:

IProgram

getProgramType

int getProgramType()

Returns the program type for this program.

Program types:

Undefined: constant that indicates that the program type is undefined. The int value associated with this constant is 0.

Binary: constant that indicates that the program type is a binary program. The int value associated with this constant is 1.

Java: constant that indicates that the program type is a java program. The int value associated with this constant is 2.

Script: constant that indicates that the program type is a script program. The int value associated with this constant is 3.

Returns:

An int that indicates the program type.

InfoObject properties to query for:

SI_PROCESSINFO.SI_TYPE

getProgramInterface

java.lang.Object getProgramInterface()
                                     throws SDKException

Returns the program interface for this program.

Returns:

An Object that represents the program interface.

Throws:

SDKException

InfoObject properties to query for:

SI_PROCESSINFO.SI_TYPE

getResultMIMEType

java.lang.String getResultMIMEType()

Mime type for the result data

getResultByteStream

byte[] getResultByteStream()
                           throws SDKException

Returns the result data as an array of bytes.

Returns:

A byte[] that contains the result data.

Throws:

SDKException - This is thrown if the process is unsuccessful

InfoObject properties to query for:

SI_FILES

writeResult

void writeResult(java.io.OutputStream stream)
                 throws SDKException

Writes the result to the specific OutputStream.

Parameters:

stream - An OutputStream stream object.

Throws:

SDKException - This is thrown if the process is unsuccessful

InfoObject properties to query for:

SI_FILES

getResultLength

long getResultLength()
                     throws SDKException

Returns length of the result in bytes.

Returns:

A long that represents the length of the result in bytes.

Throws:

SDKException - This is thrown if the process is unsuccessful

InfoObject properties to query for:

SI_FILES