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

public interface IBinaryProgram

This object provides functionality which allows you to use a binary program within the BusinessObjects Enterprise framework.

Note: Binary programs are required to use impersonation as a form of additional security. Impersonation is a form of delegation which authorizes another principle to use its identity with restricted privileges. For more information see the IProgramGlobal interface.

Method Summary

void	addFile(java.lang.String filePath) Adds an auxiliary file.
java.lang.String	getArgs() Returns the program arguments.
java.lang.String[]	getEnvironmentVars() Returns the environment variables.
java.lang.String[]	getExternalDependencies() Returns the external dependencies for the binary program object.
java.lang.String	getFileName() Return the name of file to be processed.
java.lang.String[]	getFileNames() Returns the names of all files set for processing.
java.lang.String	getUserName() Returns the user name for the system that this object will run on.
java.lang.String	getWorkingDir() Returns the working directory.
boolean	isPasswordNotEmpty() Returns a boolean that indicates whether the password is set and not empty.
boolean	isPasswordSet() Returns a boolean that indicates whether the password is set.
void	setArgs(java.lang.String args) Sets the program arguments.
void	setEnvironmentVars(java.lang.String[] envp) Set the environment variables.
void	setExternalDependencies(java.lang.String[] dependencies) Sets the external dependencies for the binary program object.
void	setFile(java.lang.String filePath) Sets the file to be processed.
void	setPassword(java.lang.String password) Sets the users's password for the system that this object will run on.
void	setUserName(java.lang.String userName) Sets the user name for this object.
void	setWorkingDir(java.lang.String workingDir) Sets the working directory.

Method Detail

setFile

void setFile(java.lang.String filePath)
             throws SDKException

Sets the file to be processed.

Parameters:

filePath - A String specifying the file path.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFileName

java.lang.String getFileName()
                             throws SDKException

Return the name of file to be processed.

Returns:

A String containing the name of the file to be processed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

addFile

void addFile(java.lang.String filePath)
             throws SDKException

Adds an auxiliary file.

Parameters:

filePath - A String specifying the file path.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFileNames

java.lang.String[] getFileNames()
                                throws SDKException

Returns the names of all files set for processing.

Returns:

A String array containing the name of all files set for processing.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setArgs

void setArgs(java.lang.String args)

Sets the program arguments.

Parameters:

args - A String specifying the program arguments.

getArgs

java.lang.String getArgs()

Returns the program arguments.

Returns:

A String containing the program arguments.

setWorkingDir

void setWorkingDir(java.lang.String workingDir)

Sets the working directory.

Parameters:

workingDir - A String specifying the working directory.

getWorkingDir

java.lang.String getWorkingDir()

Returns the working directory.

Returns:

A String containing the working directory.

setEnvironmentVars

void setEnvironmentVars(java.lang.String[] envp)

Set the environment variables.

Parameters:

envp[] - A String[] array specifying the environment variables.

getEnvironmentVars

java.lang.String[] getEnvironmentVars()

Returns the environment variables.

Returns:

A String[] array containing the environment variables.

setExternalDependencies

void setExternalDependencies(java.lang.String[] dependencies)

Sets the external dependencies for the binary program object.

Parameters:

dependencies[] - A String[] array specifying the external dependencies.

getExternalDependencies

java.lang.String[] getExternalDependencies()

Returns the external dependencies for the binary program object.

Returns:

A String array containing the external dependencies.

getUserName

java.lang.String getUserName()

Returns the user name for the system that this object will run on.

Returns:

A String containing the username.

setUserName

void setUserName(java.lang.String userName)

Sets the user name for this object.

Parameters:

userName - A String specifying the user name.

setPassword

void setPassword(java.lang.String password)

Sets the users's password for the system that this object will run on.

Parameters:

password - A String specifying the user's password.

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Returns a boolean that indicates whether the password is set.

Note: the password can be set and contain an empty field.

Returns:

true if the password is set, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isPasswordNotEmpty

boolean isPasswordNotEmpty()
                           throws SDKException

Returns a boolean that indicates whether the password is set and not empty.

Returns:

true if the password is set and not empty, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.