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

public interface IProfileTarget

This interface represents a profile target. A profile target references a universe.

Method Summary

java.lang.String	getMultilingualUniverseCUID() Returns the multilingual universe CUID.
java.lang.String	getMultilingualVariableID() Returns the multilingual variable ID.
int	getTargetID() Returns the target universe ID.
java.lang.String	getUniverseClass() Returns the universe class that applies to this profile.
java.lang.String	getVariable() Returns the variable that applies to this profile.
void	setMultilingualUniverseCUID(java.lang.String cuid) Sets the multilingual universe CUID.
void	setMultilingualVariableID(java.lang.String variableID) Sets the multilingual variable ID.
void	setTargetID(int id) Sets the target universe ID.
void	setUniverseClass(java.lang.String univClass) Sets the universe class that applies to this profile.
void	setVariable(java.lang.String variable) Sets the variable that applies to this profile.

Method Detail

getTargetID

int getTargetID()

Returns the target universe ID.

Returns:

An int that indicates the target universe ID.

setTargetID

void setTargetID(int id)
                 throws SDKException

Sets the target universe ID.

Parameters:

id - An int that indicates the target universe ID.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUniverseClass

java.lang.String getUniverseClass()

Returns the universe class that applies to this profile.

This method only applies to universe target object type.

Returns:

A String that indicates the universe class that applies to this profile.

setUniverseClass

void setUniverseClass(java.lang.String univClass)
                      throws SDKException

Sets the universe class that applies to this profile.

This method only applies to universe target object type.

Parameters:

univClass - A String that indicates the universe class that applies to this profile.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getVariable

java.lang.String getVariable()

Returns the variable that applies to this profile.

Returns:

A String that indicates the variable that applies to this profile.

setVariable

void setVariable(java.lang.String variable)
                 throws SDKException

Sets the variable that applies to this profile.

Parameters:

variable - A String that indicates the variable that applies to this profile.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getMultilingualUniverseCUID

java.lang.String getMultilingualUniverseCUID()

Returns the multilingual universe CUID.

For profile targets that are multilingual universes, retrieves the CUID that uniquely identifies the universe.

setMultilingualUniverseCUID

void setMultilingualUniverseCUID(java.lang.String cuid)

Sets the multilingual universe CUID.

For profile targets that are part of multilingual universes, sets the CUID that uniquely identifies the universe. Even if this value is set, setTargetID(), setUniverseClass(), and setVariable() should be called for use by documents that do not support multilingual universes.

Parameters:

cuid - A String representing the CUID of the multilingual universe target.

getMultilingualVariableID

java.lang.String getMultilingualVariableID()

Returns the multilingual variable ID.

For profile targets that are multilingual universes, sets the ID that uniquely identifies the variable in the universe.

setMultilingualVariableID

void setMultilingualVariableID(java.lang.String variableID)

Sets the multilingual variable ID.

For profile targets that are part of multilingual universes, sets the ID that uniquely identifies the variable in the universe. Even if this value is set, setTargetID(), setUniverseClass(), and setVariable() should be called for use by documents that do not support multilingual universes.

Parameters:

variableID - A String representing the ID of the target in the multilingual universe.