com.businessobjects.sdk.plugin.desktop.profile
Interface IProfileValue

public interface IProfileValue

This interface represents a profile value.

Nested Class Summary

static interface

IProfileValue.CeTargetType Profile target type for profile value.

Method Summary

java.lang.String	getFormula() Deprecated. Use {IProfileValue.getFormula(String) instead.
java.lang.String	getFormula(java.lang.String ceKindString) Gets the formula for the profile value for the specified kind.
java.lang.String	getInternalFormula(java.lang.String ceKindString) Gets the internal formula for the profile value for specified kind.
int	getProfileID() Returns the profile ID.
int	getTargetType() Gets the formula target type.
IProfileValueItems	getValues() Gets the profile values.
void	removeFormula(java.lang.String ceKindString) Removes the formula for specified type and document kind.
void	setFormula(java.lang.String formula) Deprecated. Use IProfileValue.setFormula(String, String) instead
void	setFormula(java.lang.String ceKindString, java.lang.String formula) Sets the formula for the profile value for the specified kind.
void	setInternalFormula(java.lang.String ceKindString, java.lang.String internalFormula) Sets the internal formula for the specified target kind.
void	setProfileID(int id) Sets the profile ID associated with the profile value.
void	setTargetType(int targetType) Gets the formula target type.

Method Detail

getProfileID

int getProfileID()

Returns the profile ID.

Returns:

An int that indicates the profile ID.

setProfileID

void setProfileID(int id)
                  throws SDKException

Sets the profile ID associated with the profile value.

Parameters:

id - An int that indicates the profile ID associated with the profile value.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFormula

java.lang.String getFormula()

Deprecated. Use {IProfileValue.getFormula(String) instead.

Returns the formula of the profile value for kind CeKind.FullClient.

Returns:

The String formula of the profile value for kind CeKind.FullClient.

setFormula

void setFormula(java.lang.String formula)
                throws SDKException

Deprecated. Use IProfileValue.setFormula(String, String) instead

Sets the formula of the profile value for kind CeKind.FullClient.

Parameters:

formula - The String formula for the kind CeKind.FullClient.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFormula

java.lang.String getFormula(java.lang.String ceKindString)

Gets the formula for the profile value for the specified kind.

Parameters:

ceKindString - The kind of object for which to retrieve the formula. This value may be for any arbitrary kind. For instance, it may be one of CeKind.CRYSTAL_REPORT, CeKind.WEBI, or CeKind.FullClient.

Returns:

An String that indicates formula for the specified document object kind.

setFormula

void setFormula(java.lang.String ceKindString,
                java.lang.String formula)
                throws SDKException

Sets the formula for the profile value for the specified kind.

Parameters:

ceKindString - The kind of object for which to set the formula. This value may be for any arbitrary kind. For instance, it may be one of CeKind.CRYSTAL_REPORT, CeKind.WEBI, or CeKind.FullClient.

formula - The String formula for the given kind. It should conform to the kind's document's syntax.

Throws:

SDKException

getInternalFormula

java.lang.String getInternalFormula(java.lang.String ceKindString)

Gets the internal formula for the profile value for specified kind.

Parameters:

ceKindString - The kind of object for which to set the internal formula. Currently only CeKind.WEBI is supported.

Returns:

The String internal formula for the given kind.

setInternalFormula

void setInternalFormula(java.lang.String ceKindString,
                        java.lang.String internalFormula)
                        throws SDKException

Sets the internal formula for the specified target kind.

Parameters:

ceKindString - The kind of object for which to retrieve the formula. Currently only CeKind.WEBI is supported.

formula - The String internal formula for the given kind.

Throws:

SDKException

getTargetType

int getTargetType()

Gets the formula target type.

Returns:

An int that indicates target type.

setTargetType

void setTargetType(int targetType)
                   throws SDKException

Gets the formula target type.

Parameters:

targetType - A int that is the target type, reference CeTargetType for predefined values.

Throws:

SDKException

removeFormula

void removeFormula(java.lang.String ceKindString)
                   throws SDKException

Removes the formula for specified type and document kind.

Parameters:

ceKindString - A String that indicates the object kind of the formula, limit the value to CeKind.CRYSTAL_REPORT, CeKind.WEBI, and CeKind.FullClient.

Throws:

SDKException

getValues

IProfileValueItems getValues()
                             throws SDKException

Gets the profile values.

Returns:

An IProfileValueItems to support multiple value.

Throws:

SDKException