IJobReportRequirement (mws)

Overview

Package

Class

Deprecated

Index

Help

Groovy Documentation

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

com.adaptc.mws.plugins
[Java] Interface IJobReportRequirement

public interface IJobReportRequirement

Contains common methods for a job report requirement object. Note that the JobReportRequirementsList also implements this interface and can be used directly as a single job report requirement.

Authors:: bsaville

Method Summary
`String`	`getArchitecture()` Retrieves the required architecture.
`List`	`getFeatures()` Retrieves the list of required node features for this requirement.
`Integer`	`getNodeCount()` Retrieves the minimum number of nodes called for by the requirement.
`List`	`getNodes()` Retrieves the names of the nodes that are actually allocated to the job.
`ReportResourceMap`	`getResourcesPerTask()` Retrieve the job's resources information.
`Integer`	`getTaskCount()` Retrieves the minimum task count for this requirement.
`Integer`	`getTasksPerNode()` Retrieves the number of tasks to map to each node.
`void`	`setArchitecture(String architecture)` Sets the required architecture.
`void`	`setFeatures(List features)` Sets the list of required node features.
`void`	`setNodeCount(Integer nodeCount)` Sets the minimum number of nodes called for by the requirement.
`void`	`setNodes(List nodes)` Sets the list of node names that are actually allocated to the job.
`void`	`setResourcesPerTask(ReportResourceMap resourcesPerTask)` Sets the job's resources requirements.
`void`	`setTaskCount(Integer taskCount)` Sets the minimum task count for this requirement.
`void`	`setTasksPerNode(Integer tasksPerNode)` Sets the number of tasks to map to each node.

Method Detail

getArchitecture

public String getArchitecture()

Retrieves the required architecture.

Returns:: The current value

getFeatures

public List getFeatures()

Retrieves the list of required node features for this requirement.

Returns:: The current value

getNodeCount

public Integer getNodeCount()

Retrieves the minimum number of nodes called for by the requirement.

Returns:: The current value

getNodes

public List getNodes()

Retrieves the names of the nodes that are actually allocated to the job.

Returns:: The current value

getResourcesPerTask

public ReportResourceMap getResourcesPerTask()

Retrieve the job's resources information. Note that no null checks are needed to act on the resources. PluginConstants.RESOURCE_DISK, PluginConstants.RESOURCE_SWAP, and PluginConstants.RESOURCE_MEMORY are used as key values, PluginConstants.RESOURCE_PROCESSORS is ignored, and all key values are reported as generic resources.

For each entry, the total value is used if set. If not set, the available value is used.

Returns:: The current value

getTaskCount

public Integer getTaskCount()

Retrieves the minimum task count for this requirement.

Returns:: The current value

getTasksPerNode

public Integer getTasksPerNode()

Retrieves the number of tasks to map to each node.

Returns:: The current value

setArchitecture

public void setArchitecture(String architecture)

Sets the required architecture.

Parameters:: architecture - The value to set

setFeatures

public void setFeatures(List features)

Sets the list of required node features.

Parameters:: features - The value to set

setNodeCount

public void setNodeCount(Integer nodeCount)

Sets the minimum number of nodes called for by the requirement.

Parameters:: nodeCount - The value to set

setNodes

public void setNodes(List nodes)

Sets the list of node names that are actually allocated to the job.

Parameters:: nodes - The value to set

setResourcesPerTask

public void setResourcesPerTask(ReportResourceMap resourcesPerTask)

Sets the job's resources requirements. PluginConstants.RESOURCE_DISK, PluginConstants.RESOURCE_SWAP, and PluginConstants.RESOURCE_MEMORY are used as key values, PluginConstants.RESOURCE_PROCESSORS is ignored, and all key values are reported as generic resources.