org.rhq.core.pluginapi.support

Class SnapshotReportRequest

java.lang.Object

org.rhq.core.pluginapi.support.SnapshotReportRequest

All Implemented Interfaces:

Serializable

public class SnapshotReportRequest
extends Object
implements Serializable

Encapsulates information about a snapshot report request.

Since:

1.3

Author:

John Mazzitelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnapshotReportRequest(String name, String description)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A generic description that can be used to identify the specific snapshot being taken or it can describe why the snapshot was being taken.
String	getName() Returns the name that identifies the type of snapshot to take.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotReportRequest

public SnapshotReportRequest(String name,
                     String description)

Parameters:

name - identifies the type of snapshot to take

Method Detail

getName

public String getName()

Returns the name that identifies the type of snapshot to take. This can be used by the facet implementation to determine what it should include in the snapshot report and how to generate it.

Returns:

name of snapshot to take

getDescription

public String getDescription()

A generic description that can be used to identify the specific snapshot being taken or it can describe why the snapshot was being taken. This is typically text entered by a user.

Returns:

snapshot report description