com.ace.moab.api.reservation
Class ReservationRequirements

java.lang.Object
  extended by com.ace.moab.api.reservation.ReservationRequirements
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ReservationRequirements>

public class ReservationRequirements
extends java.lang.Object
implements java.lang.Comparable<ReservationRequirements>, java.io.Serializable

Represents all types of requirements a user can request while creating a reservation. This class is used while creating a reservation creation request. Although the user specifies these attributes, Moab retains this information and it needs to be set from moab XML.

Like a reservation, most or all of these requirements may be null depending on the use. For example, when parsing moab XML this entire object can be null for a reservation if no requirements are specified. However, while attempting to create a reservation, some of these must be set. See CreateReservation class for more information.

Author:
Scott Brown
See Also:
Serialized Form

Constructor Summary
ReservationRequirements()
           
 
Method Summary
 int compareTo(ReservationRequirements o)
           
 java.lang.String getArchitecture()
          Get the required architecture
 java.lang.String getFeatureList()
          Get the required feature list
 java.lang.String getFeatureMode()
          Get the required feature mode
 java.lang.String getNetwork()
          Get the required network
 int getNodeCount()
          Get the required node count
 java.util.Set<MoabNode> getNodeList()
          Get the required node list as a Set of MoabNode Objects
 java.lang.String getOS()
          Get the required Operating System
 Task getTask()
          Get the required Task associated with the reservation
 int getTaskCount()
          Get the required task count
 java.lang.String nodeListToString()
           Creates a human-readable form of the nodeList variable
 void setArchitecture(java.lang.String architecture)
          Set the required architecture
 void setFeatureList(java.lang.String featureList)
          Set the required feature list
 void setFeatureMode(java.lang.String featureMode)
          Set the required feature mode
 void setNetwork(java.lang.String network)
          Set the required network
 void setNodeCount(int nodeCount)
          Set the required node count
 void setNodeList(java.util.Set<MoabNode> nodeList)
          Set the required node list as a Set of MoabNode Objects
 void setNodeListFromStr(java.lang.String nodeStr)
          Set required node list from a comma delimited string
 void setOS(java.lang.String os)
          Set the required Operating System
 void setTask(Task task)
           Sets the task definition associated with the reservation.
 void setTaskCount(int taskCount)
          Set the required task count
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReservationRequirements

public ReservationRequirements()
Method Detail

nodeListToString

public java.lang.String nodeListToString()

Creates a human-readable form of the nodeList variable

Returns:
human-readable list of nodeList

setNodeListFromStr

public void setNodeListFromStr(java.lang.String nodeStr)
Set required node list from a comma delimited string

Parameters:
nodeStr - Comma delimited string representing nodes

getArchitecture

public java.lang.String getArchitecture()
Get the required architecture

Returns:
the required architecture

setArchitecture

public void setArchitecture(java.lang.String architecture)
Set the required architecture

Parameters:
architecture - the required architecture

getFeatureList

public java.lang.String getFeatureList()
Get the required feature list

Returns:
the required feature list

setFeatureList

public void setFeatureList(java.lang.String featureList)
Set the required feature list

Parameters:
featureList - the required feature list

getFeatureMode

public java.lang.String getFeatureMode()
Get the required feature mode

Returns:
the required feature mode

setFeatureMode

public void setFeatureMode(java.lang.String featureMode)
Set the required feature mode

Parameters:
featureMode - the required feature mode

getNetwork

public java.lang.String getNetwork()
Get the required network

Returns:
the required network

setNetwork

public void setNetwork(java.lang.String network)
Set the required network

Parameters:
network - the required network

getOS

public java.lang.String getOS()
Get the required Operating System

Returns:
the required Operating System

setOS

public void setOS(java.lang.String os)
Set the required Operating System

Parameters:
os - the required Operating System

getNodeCount

public int getNodeCount()
Get the required node count

Returns:
the required node count

setNodeCount

public void setNodeCount(int nodeCount)
Set the required node count

Parameters:
nodeCount - the required node count

getNodeList

public java.util.Set<MoabNode> getNodeList()
Get the required node list as a Set of MoabNode Objects

Returns:
the required node list as a Set of MoabNode Objects

setNodeList

public void setNodeList(java.util.Set<MoabNode> nodeList)
Set the required node list as a Set of MoabNode Objects

Parameters:
nodeList - the required node list as a Set of MoabNode Objects

getTaskCount

public int getTaskCount()
Get the required task count

Returns:
the required task count

setTaskCount

public void setTaskCount(int taskCount)
Set the required task count

Parameters:
taskCount - the required task count

getTask

public Task getTask()
Get the required Task associated with the reservation

Returns:
the required Task associated with the reservation

setTask

public void setTask(Task task)

Sets the task definition associated with the reservation.

Can be null.

Parameters:
task - the required Task associated with the reservation

compareTo

public int compareTo(ReservationRequirements o)
Specified by:
compareTo in interface java.lang.Comparable<ReservationRequirements>


Copyright © 2001-2009 Cluster Resources, Inc. All Rights Reserved.