com.ibm.tws.objects.types
Class ResourceBaseConstraints

java.lang.Object
  extended bycom.ibm.tws.objects.types.ResourceBaseConstraints
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ResourceInPlanConstraints

public class ResourceBaseConstraints
extends java.lang.Object
implements java.io.Serializable

This class includes the information required to describe the usage constraints of a resource.

The following syntax validation constraints must be met on ResourceBaseConstraints objects:

quantity Allowed range is from 0 to 1024
Default value is 1
actionOnComplete One of the values exposed by the ResourceActionOnComplete class
Default value is ResourceActionOnComplete.DEFAULT
maxUsageLimitType One of the values exposed by the YesNoResetOption class
Default value is YesNoResetOption.RESET
maxUsageLimitValue Default value is 0. Possible value are 0-999999.

See Also:
ResourceActionOnComplete, YesNoResetOption, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ResourceBaseConstraints()
          Creates an empty ResourceBaseConstraints object.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this ResourceBaseConstraints object are equal to those of the given one.
 ResourceActionOnComplete getActionOnComplete()
          Returns the action on complete.
 ResourceActionOnError getActionOnError()
          Returns the action on error.
 java.lang.String getGroupId()
          Returns the group identifier.
 YesNoResetOption getMaxUsageLimitType()
          Returns the max usage limit type.
 int getMaxUsageLimitValue()
          Returns the max usage limit value.
 int getQuantity()
          Returns the resource quantity.
 ResourceUsage getUsedFor()
          Returns the resource usage.
 int hashCode()
          Returns a hash code for this ResourceBaseConstraints object.
 YesNoDefaultOption isAvailable()
          Returns true if the resource is available.
 boolean isZOSHiperbatch()
          Returns the zOSHiperbatch flag.
 void setActionOnComplete(ResourceActionOnComplete value)
          Sets the action on complete.
 void setActionOnError(ResourceActionOnError value)
          Sets the action on error.
 void setAvailable(YesNoDefaultOption value)
          Sets the property used to state if the resource is available.
 void setGroupId(java.lang.String value)
          Sets the group identifier.
 void setMaxUsageLimitType(YesNoResetOption value)
          Sets the max usage limit type.
 void setMaxUsageLimitValue(int value)
          Sets the max usage limit value.
 void setQuantity(int value)
          Sets the resource quantity.
 void setUsedFor(ResourceUsage value)
          Sets the resource usage.
 void setZOSHiperbatch(boolean value)
          Sets the zOSHiperbatch flag.
 java.lang.String toString()
          Returns a string representation of this ResourceBaseConstraints object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

ResourceBaseConstraints

public ResourceBaseConstraints()
Creates an empty ResourceBaseConstraints object.

Method Detail

getQuantity

public int getQuantity()
Returns the resource quantity.

Returns:
The resource quantity.

isAvailable

public YesNoDefaultOption isAvailable()
Returns true if the resource is available.

Returns:
True if the resource is available.

getGroupId

public java.lang.String getGroupId()
Returns the group identifier.

Returns:
The group identifier.

getUsedFor

public ResourceUsage getUsedFor()
Returns the resource usage.

Returns:
The resource usage.

getActionOnError

public ResourceActionOnError getActionOnError()
Returns the action on error.

Returns:
The action on error.

getActionOnComplete

public ResourceActionOnComplete getActionOnComplete()
Returns the action on complete.

Returns:
The action on complete.

getMaxUsageLimitType

public YesNoResetOption getMaxUsageLimitType()
Returns the max usage limit type.

Returns:
The max usage limit type.

getMaxUsageLimitValue

public int getMaxUsageLimitValue()
Returns the max usage limit value.

Returns:
The max usage limit value.

isZOSHiperbatch

public boolean isZOSHiperbatch()
Returns the zOSHiperbatch flag.

Returns:
The zOSHiperbatch flag.

setQuantity

public void setQuantity(int value)
Sets the resource quantity.

Parameters:
value - The resource quantity.

setAvailable

public void setAvailable(YesNoDefaultOption value)
Sets the property used to state if the resource is available.

Parameters:
value - True if the resource is available.

setGroupId

public void setGroupId(java.lang.String value)
Sets the group identifier.

Parameters:
value - The group identifier.

setUsedFor

public void setUsedFor(ResourceUsage value)
Sets the resource usage.

Parameters:
value - The resource usage.

setActionOnError

public void setActionOnError(ResourceActionOnError value)
Sets the action on error.

Parameters:
value - The action on error.

setActionOnComplete

public void setActionOnComplete(ResourceActionOnComplete value)
Sets the action on complete.

Parameters:
value - The action on complete.

setMaxUsageLimitType

public void setMaxUsageLimitType(YesNoResetOption value)
Sets the max usage limit type.

Parameters:
value - The max usage limit type.

setMaxUsageLimitValue

public void setMaxUsageLimitValue(int value)
Sets the max usage limit value.

Parameters:
value - The max usage limit value.

setZOSHiperbatch

public void setZOSHiperbatch(boolean value)
Sets the zOSHiperbatch flag.

Parameters:
value - The zOSHiperbatch flag.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this ResourceBaseConstraints object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this ResourceBaseConstraints object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this ResourceBaseConstraints object.

Returns:
A text string including all ResourceBaseConstraints fields.


Copyright © 2005 IBM All Rights Reserved.