com.inrix.sdk

Class IncidentsManager.IncidentDeleteOptions

java.lang.Object

com.inrix.sdk.IncidentsManager.IncidentDeleteOptions

Enclosing class:

IncidentsManager

public static final class IncidentsManager.IncidentDeleteOptions
extends Object

Contains options for deleting incidents, which allows you to cancel an incident that was previously reported.

Constructor Summary

Constructors

Constructor and Description
IncidentDeleteOptions(long incidentId, int incidentVersion) Initializes a new instance of the IncidentsManager.IncidentDeleteOptions class.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getId() Gets the incident id to report (optional).
Integer	getVersion() Gets the incident version (optional).
IncidentsManager.IncidentDeleteOptions	setId(Long value) Sets the ID of the incident to cancel.
IncidentsManager.IncidentDeleteOptions	setVersion(Integer value) Sets the version of the incident to cancel.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IncidentDeleteOptions

public IncidentDeleteOptions(long incidentId,
                     int incidentVersion)

Initializes a new instance of the IncidentsManager.IncidentDeleteOptions class.

Parameters:

incidentId - The ID of the incident to cancel.

incidentVersion - The version of the incident to cancel.

Throws:

IncidentsManager.IncidentsManagerException - Thrown when incidentId or incidentVersion is invalid.

Method Detail

setId

public IncidentsManager.IncidentDeleteOptions setId(Long value)

Sets the ID of the incident to cancel. This parameter is required.

Parameters:

value - The incident ID.

Returns:

This instance of the IncidentsManager.IncidentDeleteOptions class.

setVersion

public IncidentsManager.IncidentDeleteOptions setVersion(Integer value)

Sets the version of the incident to cancel. This parameter is required.

Parameters:

value - The incident version.

Returns:

This instance of the IncidentsManager.IncidentDeleteOptions class.

toString

public String toString()

Overrides:

toString in class Object

getId

public final Long getId()

Gets the incident id to report (optional).

Returns:

Incident id.

getVersion

public final Integer getVersion()

Gets the incident version (optional).

Returns:

Incident version.