g-Eclipse
Release 1.0.0

eu.geclipse.batch
Class BatchQueueDescription

java.lang.Object
  extended by PlatformObject
      extended by eu.geclipse.core.model.impl.AbstractGridElement
          extended by eu.geclipse.core.model.impl.AbstractGridContainer
              extended by eu.geclipse.core.model.impl.ResourceGridContainer
                  extended by eu.geclipse.batch.BatchQueueDescription
All Implemented Interfaces:
IGridBatchQueueDescription, IGridContainer, IGridElement

public class BatchQueueDescription
extends ResourceGridContainer
implements IGridBatchQueueDescription


Constructor Summary
BatchQueueDescription(IFile file)
           
 
Method Summary
 void createRoot()
          Create the Qdl Root Element with all necessary children (QueueType).
 void enableQueue(boolean status)
           
 java.util.Collection<java.lang.String> getAllowedVirtualOrganizations()
          Returns a collection of strings containing the name of Virtual Organizations allowed to use the Queue..
 RangeValueType getQueueMaxCPUTime()
           
 double getQueueMaxCPUTimeValue()
           
 RangeValueType getQueueMaxWallTime()
           
 double getQueueMaxWallTimeValue()
           
 java.lang.String getQueueName()
           
 java.lang.String getQueueStatus()
          Returns ENABLED or DISABLED based on the Queue Status.
 java.lang.String getQueueType()
          Returns EXECUTION if this is an Execution Queue.
 DocumentRoot getRoot()
           
 void load(java.lang.String path)
           
 void loadModel(IFile file)
           
 void queueType(QueueTypeEnumeration enumeration)
           
 void save(IFile qdlFile)
           
 void setAllowedVirtualOrganizations(java.util.Collection<java.lang.String> collection)
           
 void setQueueName(java.lang.String queueName)
           
 void setRoot(DocumentRoot root)
           
 void startQueue(boolean value)
           
 boolean writeToFile(IFile qdlFile)
           
 
Methods inherited from class eu.geclipse.core.model.impl.ResourceGridContainer
getFileStore, getName, getParent, getPath, getResource, isLazy, isLocal
 
Methods inherited from class eu.geclipse.core.model.impl.AbstractGridContainer
canContain, contains, create, delete, deleteAll, dispose, findChild, findChildWithResource, getChildCount, getChildren, hasChildren, isDirty, refresh, setDirty
 
Methods inherited from class eu.geclipse.core.model.impl.AbstractGridElement
getAdapter, getProject, isHidden, isVirtual
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface eu.geclipse.core.model.IGridContainer
canContain, contains, create, delete, deleteAll, findChild, findChildWithResource, getChildCount, getChildren, hasChildren, isDirty, isLazy, refresh, setDirty
 
Methods inherited from interface eu.geclipse.core.model.IGridElement
dispose, getFileStore, getName, getParent, getPath, getProject, getResource, isHidden, isLocal, isVirtual
 

Constructor Detail

BatchQueueDescription

public BatchQueueDescription(IFile file)
Parameters:
file -
Method Detail

getAllowedVirtualOrganizations

public java.util.Collection<java.lang.String> getAllowedVirtualOrganizations()
Returns a collection of strings containing the name of Virtual Organizations allowed to use the Queue..

Specified by:
getAllowedVirtualOrganizations in interface IGridBatchQueueDescription
Returns:
The list of Virtual Organizations that are allowed to use the Queue.

getQueueName

public java.lang.String getQueueName()
Specified by:
getQueueName in interface IGridBatchQueueDescription
Returns:
Queue Name

getQueueStatus

public java.lang.String getQueueStatus()
Returns ENABLED or DISABLED based on the Queue Status.

Specified by:
getQueueStatus in interface IGridBatchQueueDescription
Returns:
Queue Status

getQueueType

public java.lang.String getQueueType()
Returns EXECUTION if this is an Execution Queue. Returns ROUTE if this is a Route Queue.

Specified by:
getQueueType in interface IGridBatchQueueDescription
Returns:
Queue Type

getQueueMaxCPUTime

public RangeValueType getQueueMaxCPUTime()
Returns:
the RangeValueType Max CPU Time object for the Queue. This could be an UpperBoundedRange or LowerBoundedRange value.

getQueueMaxWallTime

public RangeValueType getQueueMaxWallTime()
Returns:
the RangeValueType Max Wall Time object for the Queue. This could be an UpperBoundedRange or LowerBoundedRange value.

getQueueMaxCPUTimeValue

public double getQueueMaxCPUTimeValue()
Returns:
the Max CPU Time Value for the Queue. Returns -1 if value is not set

getQueueMaxWallTimeValue

public double getQueueMaxWallTimeValue()
Returns:
the Max Wall Time Value for the Queue. Returns -1 if value is not set

enableQueue

public void enableQueue(boolean status)
Parameters:
status - Set's the Queue Status to be ENABLED or DISABLED.

startQueue

public void startQueue(boolean value)
Parameters:
value - Start or Stop the Queue.

queueType

public void queueType(QueueTypeEnumeration enumeration)
Parameters:
enumeration - Set's the Queue Type. QueueType is QueueTypeEnumeration

setAllowedVirtualOrganizations

public void setAllowedVirtualOrganizations(java.util.Collection<java.lang.String> collection)
Parameters:
collection - Set's the Virtual Organizations that will be allowed to use the Queue.

setQueueName

public void setQueueName(java.lang.String queueName)
Parameters:
queueName - The Queue Name

setRoot

public void setRoot(DocumentRoot root)
Parameters:
root - The Qdl Document Root

getRoot

public DocumentRoot getRoot()
Returns:
The Qdl Document Root

createRoot

public void createRoot()
Create the Qdl Root Element with all necessary children (QueueType).


loadModel

public void loadModel(IFile file)
Parameters:
file -

save

public void save(IFile qdlFile)
Parameters:
qdlFile -

writeToFile

public boolean writeToFile(IFile qdlFile)
Parameters:
qdlFile - The Qdl File.
Returns:
true if the model has been written correctly to the file.

load

public void load(java.lang.String path)
Parameters:
path -

g-Eclipse
Release 1.0.0