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

public interface IScopeProfileValue

Method Summary

java.lang.String	getMultilingualVariableID() Gets the Multilingual Variable ID
java.lang.String	getProfileSubreportName() Gets the subreport name which has specified variable
java.lang.String	getProfileValue() Gets the profile value associated with the ScopeProfileValue
IProfileValueItems	getProfileValueData() Gets the profile value data
int	getProfileValueType() Returns the profile value target type associated with the ScopeProfileValue
java.lang.String	getProfileVariable() Gets the profile variable associated with the ScopeProfileValue
int	getProfileVariableIndex() Gets the profile index of Publication_DocumentProfile_Targets bag.
void	setProfileSubreportName(java.lang.String subreportName) Sets the subreport name
void	setProfileValue(java.lang.String value) Sets the target profile value associated with the ScopeBatchValue
void	setProfileValueType(int value) Sets the target profile value target type associated with the ScopeBatchValue
void	setProfileVariable(java.lang.String variableName) Sets the target profile variable associated with the ScopeProfileValue profile
void	setProfileVariableIndex(int indexVal) Sets the profile index of Publication_DocumentProfile_Targets bag.

Method Detail

getProfileVariable

java.lang.String getProfileVariable()

Gets the profile variable associated with the ScopeProfileValue

Returns:

An String representing the profile variable for this ScopeProfileValue

setProfileVariable

void setProfileVariable(java.lang.String variableName)
                        throws SDKException

Sets the target profile variable associated with the ScopeProfileValue profile

Parameters:

id - An String representing the personalization variable name

Throws:

SDKException

getProfileSubreportName

java.lang.String getProfileSubreportName()

Gets the subreport name which has specified variable

Returns:

An String representing the subreport name

setProfileSubreportName

void setProfileSubreportName(java.lang.String subreportName)
                             throws SDKException

Sets the subreport name

Parameters:

subreportName - An String representing the subreport name which has specified variable

Throws:

SDKException

getProfileValue

java.lang.String getProfileValue()

Gets the profile value associated with the ScopeProfileValue

Returns:

A String representing the profile value.

setProfileValue

void setProfileValue(java.lang.String value)
                     throws SDKException

Sets the target profile value associated with the ScopeBatchValue

Parameters:

value - A String representing the value of the profile.

Throws:

SDKException

getProfileValueType

int getProfileValueType()

Returns the profile value target type associated with the ScopeProfileValue

Returns:

A int representing the profile value target type. CeTargetType.Value and CeTargetType.FilterExpression

setProfileValueType

void setProfileValueType(int value)
                         throws SDKException

Sets the target profile value target type associated with the ScopeBatchValue

Parameters:

value - A int representing the value of the profile value target type. CeTargetType.Value and CeTargetType.FilterExpression

Throws:

SDKException

getProfileValueData

IProfileValueItems getProfileValueData()

Gets the profile value data

Returns:

An IProfileValueItems representing the profile value data

getProfileVariableIndex

int getProfileVariableIndex()

Gets the profile index of Publication_DocumentProfile_Targets bag.

Returns:

a int representing the profile index in Publication_DocumentProfile_Targets bag

setProfileVariableIndex

void setProfileVariableIndex(int indexVal)
                             throws SDKException

Sets the profile index of Publication_DocumentProfile_Targets bag.

Parameters:

indexVal - A int the index value.

Throws:

SDKException

getMultilingualVariableID

java.lang.String getMultilingualVariableID()

Gets the Multilingual Variable ID

Returns:

An String representing the Multilingual Variable ID