org.pentaho.platform.api.repository
Interface IRuntimeElement

All Known Implementing Classes:

RuntimeElement, SimpleRuntimeElement

public interface IRuntimeElement

Method Summary

void	forceSave() Causes an immediate call to the underlying persistence mechanism's write-now method.
java.math.BigDecimal	getBigDecimalProperty(java.lang.String key) Gets a BigDecimal property from the Runtime Element.
java.math.BigDecimal	getBigDecimalProperty(java.lang.String key, java.math.BigDecimal defaultValue) Gets a BigDecimal property from the Runtime Element.
java.util.Date	getDateProperty(java.lang.String key) Gets a Date property from the Runtime Element.
java.util.Date	getDateProperty(java.lang.String key, java.util.Date defaultValue) Gets a Date property from the Runtime Element.
java.lang.String	getInstanceId()
java.util.List	getListProperty(java.lang.String key) Gets a List property from the Runtime Element
boolean	getLoaded()
int	getLoggingLevel()
long	getLongProperty(java.lang.String key, long defaultValue) Gets a property from the paramMap as a long using a default value if it doesn't exist in the map
java.lang.Long	getLongProperty(java.lang.String key, java.lang.Long defaultValue) Gets a Long property from the Runtime Element.
java.util.Map	getMapProperty(java.lang.String key) Gets a Map property from the Runtime Element Special implementation note - Null values aren't supported in the Map.
java.util.Set	getParameterNames()
java.lang.String	getParameterType(java.lang.String name) Gets the type of the parameter
java.lang.String	getParentId()
java.lang.String	getParentType()
int	getRevision()
java.lang.String	getSolutionId()
java.lang.String	getStringProperty(java.lang.String key) Gets a string property from the Runtime Element.
java.lang.String	getStringProperty(java.lang.String key, java.lang.String defaultValue) Gets a string property from the Runtime Element.
void	setAllowableAttributeNames(java.util.Collection allowableReadAttributeNames)
void	setBigDecimalProperty(java.lang.String key, java.math.BigDecimal value) Sets a BigDecimal property in the Runtime Element.
void	setDateProperty(java.lang.String key, java.util.Date value) Sets a Date property in the Runtime Element.
void	setInstanceId(java.lang.String instanceId)
void	setListProperty(java.lang.String key, java.util.List value) Sets a List Property in the Runtime Element
void	setLoaded(boolean value)
void	setLongProperty(java.lang.String key, long value) Sets a Long property in the Runtime Element.
void	setLongProperty(java.lang.String key, java.lang.Long value) Sets a Long property in the Runtime Element.
void	setMapProperty(java.lang.String key, java.util.Map value) Sets a Map Property in the Runtime Element Special implementation note - Null values aren't supported in the Map.
void	setParentId(java.lang.String parentId)
void	setParentType(java.lang.String parentType)
void	setSolutionId(java.lang.String solutionId)
void	setStringProperty(java.lang.String key, java.lang.String value) Sets a string property in the Runtime Element.
java.lang.String	toXML()

Method Detail

getParentId

java.lang.String getParentId()

Returns:

Returns the parent ID

setParentId

void setParentId(java.lang.String parentId)

Parameters:

parentId - The parentId to set.

getParentType

java.lang.String getParentType()

Returns:

Returns the parent Type

setParentType

void setParentType(java.lang.String parentType)

Parameters:

parentType - The parent type to set

getInstanceId

java.lang.String getInstanceId()

Returns:

Returns the instance Id

setInstanceId

void setInstanceId(java.lang.String instanceId)

Parameters:

instanceId - The instance Id to set

getSolutionId

java.lang.String getSolutionId()

Returns:

Returns the solution Id.

setSolutionId

void setSolutionId(java.lang.String solutionId)

Parameters:

solutionId - The solution Id to set

getRevision

int getRevision()

Returns:

Returns the revision (updated by Hibernate)

getStringProperty

java.lang.String getStringProperty(java.lang.String key)

Gets a string property from the Runtime Element.

Parameters:

key - The key of the property

Returns:

The value of the property, or NULL if the property doesn't exist.

getStringProperty

java.lang.String getStringProperty(java.lang.String key,
                                   java.lang.String defaultValue)

Gets a string property from the Runtime Element.

Parameters:

key - The key of the property

defaultValue - The value to return if the property doesn't exist

Returns:

The value of the property.

setStringProperty

void setStringProperty(java.lang.String key,
                       java.lang.String value)

Sets a string property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to set

value - The value to associate with the key

getBigDecimalProperty

java.math.BigDecimal getBigDecimalProperty(java.lang.String key)

Gets a BigDecimal property from the Runtime Element.

Parameters:

key - The key of the property

Returns:

The value of the property, or null if the property doesn't exist.

getBigDecimalProperty

java.math.BigDecimal getBigDecimalProperty(java.lang.String key,
                                           java.math.BigDecimal defaultValue)

Gets a BigDecimal property from the Runtime Element.

Parameters:

key - The key of the property

defaultValue - The value to return if the property doesn't exist

Returns:

The value of the property, or defaultValue if the property doesn't exist.

setBigDecimalProperty

void setBigDecimalProperty(java.lang.String key,
                           java.math.BigDecimal value)

Sets a BigDecimal property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to set

value - The value to associate with the key.

getDateProperty

java.util.Date getDateProperty(java.lang.String key)

Gets a Date property from the Runtime Element.

Parameters:

key - The key of the property

Returns:

The value of the property, or NULL if the property doesn't exist.

getDateProperty

java.util.Date getDateProperty(java.lang.String key,
                               java.util.Date defaultValue)

Gets a Date property from the Runtime Element.

Parameters:

key - The key of the property

defaultValue - The value to return if the property doesn't exist

Returns:

The value of the property, or defaultValue if the property doesn't exist.

setDateProperty

void setDateProperty(java.lang.String key,
                     java.util.Date value)

Sets a Date property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to set

value - The value to associate with the key.

getLongProperty

java.lang.Long getLongProperty(java.lang.String key,
                               java.lang.Long defaultValue)

Gets a Long property from the Runtime Element.

Parameters:

key - The key of the property

defaultValue - The value to return if the property doesn't exist

Returns:

The value of the property, or defaultValue if the property doesn't exist.

getLongProperty

long getLongProperty(java.lang.String key,
                     long defaultValue)

Gets a property from the paramMap as a long using a default value if it doesn't exist in the map

Parameters:

key - Key in the paramMap

defaultValue - The default value if the property doesn't exist in the paramMap.

Returns:

The property in the map.

setLongProperty

void setLongProperty(java.lang.String key,
                     java.lang.Long value)

Sets a Long property in the Runtime Element.

Parameters:

key - The key of the property to set

value - The value to associate with the key.

setLongProperty

void setLongProperty(java.lang.String key,
                     long value)

Sets a Long property in the Runtime Element. Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to set

value - The value to associate with the key. Note - A new Long object is constructed and stored.

getListProperty

java.util.List getListProperty(java.lang.String key)

Gets a List property from the Runtime Element

Parameters:

key - The key of the property to get

Returns:

The list associated with the key, or NULL if it doesn't exist.

getMapProperty

java.util.Map getMapProperty(java.lang.String key)

Gets a Map property from the Runtime Element Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to get

Returns:

The Map associated with the key, or NULL if it doesn't exist.

setListProperty

void setListProperty(java.lang.String key,
                     java.util.List value)

Sets a List Property in the Runtime Element

Parameters:

key - The key of the property to set

value - The List value to associate with the key.

setMapProperty

void setMapProperty(java.lang.String key,
                    java.util.Map value)

Sets a Map Property in the Runtime Element Special implementation note - Null values aren't supported in the Map. So, if a null value is passed in, this implementation will remove the entry from the Runtime Element.

Parameters:

key - The key of the property to set

value - The Map value to associate with the key.

toXML

java.lang.String toXML()

Returns:

A string containing the XML representation of the Runtime Element

getLoggingLevel

int getLoggingLevel()

Returns:

Returns the loggingLevel.

setAllowableAttributeNames

void setAllowableAttributeNames(java.util.Collection allowableReadAttributeNames)

Parameters:

allowableReadAttributeNames - The names of the attributes that this process is allowed to read.

getParameterNames

java.util.Set getParameterNames()

Returns:

The set of currently defined parameter names

getParameterType

java.lang.String getParameterType(java.lang.String name)

Gets the type of the parameter

Parameters:

name - Parameter name

Returns:

String type of the parameter

setLoaded

void setLoaded(boolean value)

getLoaded

boolean getLoaded()

forceSave

void forceSave()

Causes an immediate call to the underlying persistence mechanism's write-now method. For Hibernate, this results in a call to HibernateUtil.flush().