ptdb.common.dto

Class GetModelTask

java.lang.Object

ptdb.common.dto.Task

ptdb.common.dto.GetModelTask

public class GetModelTask
extends Task

A task request to fetch a model from the database.

It is used as a data transfer object and hold the model name with its getter and setter method.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Yousef Alsaeed

Pt.AcceptedRating:

Red (yalsaeed)

Pt.ProposedRating:

Red (yalsaeed)

Field Summary

Fields inherited from class ptdb.common.dto.Task

_isUpdateTask

Constructor Summary

Constructors

Constructor and Description
GetModelTask(java.lang.String modelName) Construct an instance of the object and set the model name to be fetched from the database.
GetModelTask(java.lang.String modelName, java.lang.String modelId) Construct an instance of the object and set the model id to be fetched from the database.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getModelId() Return the model Id.
java.lang.String	getModelName() Return the model name that is needed to be fetched from the database.
boolean	isModelFromCache() Return if the model is to be read from cache or not.
void	setModelFromCache(boolean isModelFromCache) Set if the model is being retrieved from cache.
void	setModelId(java.lang.String modelId) Set the model Id.
void	setModelName(java.lang.String modelName) Set the model name to be fetched from the database.

Methods inherited from class ptdb.common.dto.Task

isUpdateTask, setIsUpdateTask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetModelTask

public GetModelTask(java.lang.String modelName)

Construct an instance of the object and set the model name to be fetched from the database.

Parameters:

modelName - the model name to be fetched from the database.

GetModelTask

public GetModelTask(java.lang.String modelName,
                    java.lang.String modelId)

Construct an instance of the object and set the model id to be fetched from the database.

Parameters:

modelId - the model id to be fetched from the database.

modelName - the model name to be fetched from the database.

Method Detail

getModelId

public java.lang.String getModelId()

Return the model Id.

Returns:

The model Id.

See Also:

setModelId(java.lang.String)

getModelName

public java.lang.String getModelName()

Return the model name that is needed to be fetched from the database.

Returns:

The model name.

See Also:

setModelName(java.lang.String)

isModelFromCache

public boolean isModelFromCache()

Return if the model is to be read from cache or not.

Returns:

True if the model is being read from cache, false otherwise. see #setModelFromCache

setModelId

public void setModelId(java.lang.String modelId)

Set the model Id.

Parameters:

modelId - The model Id to be set.

See Also:

getModelId()

setModelName

public void setModelName(java.lang.String modelName)

Set the model name to be fetched from the database.

Parameters:

modelName - the name of the model to be fetched from the database.

See Also:

getModelName()

setModelFromCache

public void setModelFromCache(boolean isModelFromCache)

Set if the model is being retrieved from cache.

Parameters:

isModelFromCache - Boolean to indicate whether the model is being retrieved from cache.