com.sun.management.oss.pm.measurement
Interface ReportInfo

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
ReportInfoImpl

public interface ReportInfo
extends java.io.Serializable, java.lang.Cloneable

Contains information related to a measurement report file.

Version:
0.9, 2001-10-25
Author:
Stefan Aberg

Method Summary
 java.lang.Object clone()
          Deep copy of this instance.
 java.util.Calendar getExpirationDate()
          Gets the expiration date of the measurement report.
 ReportFormat getReportFormat()
          Returns the report format of the measurement report.
 java.net.URL getURL()
          Returns a pointer (URL) to the measurement report.
 ReportFormat makeReportFormat()
          Creates a new instance of the ReportFormat interface.
 void setExpirationDate(java.util.Calendar date)
          Sets the expiration date of the measurement report.
 void setReportFormat(ReportFormat format)
          Sets the report format of the measurement report.
 void setURL(java.net.URL url)
          Sets a pointer (URL) to the measurement report.
 

Method Detail

clone

public java.lang.Object clone()
Deep copy of this instance.

Returns:
Object copy of this instance.

getURL

public java.net.URL getURL()
Returns a pointer (URL) to the measurement report.

Returns:
URL Reference to the measurement report.
See Also:
setURL(java.net.URL)

setURL

public void setURL(java.net.URL url)
Sets a pointer (URL) to the measurement report.

Parameters:
url - the URL value
See Also:
getURL()

getReportFormat

public ReportFormat getReportFormat()
Returns the report format of the measurement report.

Returns:
ReportFormat The report format of the measurement report.
See Also:
setReportFormat(com.sun.management.oss.pm.measurement.ReportFormat)

setReportFormat

public void setReportFormat(ReportFormat format)
Sets the report format of the measurement report.

The supporting report format can be retrieved by using the PerformanceMonitorMethods.getReportFormats().

Parameters:
format - The report format of the measurement report.
See Also:
getReportFormat()

makeReportFormat

public ReportFormat makeReportFormat()
Creates a new instance of the ReportFormat interface.

Returns:
ReportFormat The created object. The object is empty.

getExpirationDate

public java.util.Calendar getExpirationDate()
Gets the expiration date of the measurement report.

When the expiration date of the measurement report occurs, the measurement report file will be removed from the performance monitor agent.

If null is return, no expiration date exist for the measurement report and the retention period is implementation dependent.

Returns:
Date Expiration date of the measurement report.
See Also:
setExpirationDate(java.util.Calendar)

setExpirationDate

public void setExpirationDate(java.util.Calendar date)
Sets the expiration date of the measurement report.

If not set the expiration date will be set to null, no expiration date exist for the measurement report and the retention period is implementation dependent.

Parameters:
date - a Calendar object specifying the expiration date value
See Also:
getExpirationDate()