com.exalead.cloudview.alerting.v10

Class DeleteAlert

java.lang.Object

com.exalead.cloudview.alerting.v10.DeleteAlert

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class DeleteAlert
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Delete an alert based on its key.
Deleting an alert invalidates its history.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	key
java.lang.String	user

Constructor Summary

Constructors

Constructor and Description
DeleteAlert()
DeleteAlert(DeleteAlert o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DeleteAlert.
static DeleteAlert	fromString(java.lang.String s) String representation of this DeleteAlert.
java.lang.String	getKey()
java.lang.String	getUser() Expected user for this alert.
DeleteAlert	makeCopy() Creates and returns a deep copy of this DeleteAlert.
static DeleteAlert	readFrom(java.io.InputStream is) Read this DeleteAlert from an XML fragment.
void	setKey(java.lang.String key)
void	setUser(java.lang.String user) Expected user for this alert.
java.lang.String	toString() String representation of this DeleteAlert.
DeleteAlert	withKey(java.lang.String key)
DeleteAlert	withUser(java.lang.String user)
void	writeTo(java.io.OutputStream os) Write this DeleteAlert as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

key

public java.lang.String key

user

public java.lang.String user

Constructor Detail

DeleteAlert

public DeleteAlert()

DeleteAlert

public DeleteAlert(DeleteAlert o)

Copy constructor

Method Detail

setKey

public void setKey(java.lang.String key)

getKey

public java.lang.String getKey()

withKey

public DeleteAlert withKey(java.lang.String key)

setUser

public void setUser(java.lang.String user)

Expected user for this alert. Exception is thrown if this is valued,
and the alert in the database does not match this user

getUser

public java.lang.String getUser()

Expected user for this alert. Exception is thrown if this is valued,
and the alert in the database does not match this user

withUser

public DeleteAlert withUser(java.lang.String user)

makeCopy

public DeleteAlert makeCopy()

Creates and returns a deep copy of this DeleteAlert.

readFrom

public static DeleteAlert readFrom(java.io.InputStream is)
                            throws javax.xml.bind.JAXBException

Read this DeleteAlert from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this DeleteAlert as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static DeleteAlert fromString(java.lang.String s)
                              throws javax.xml.bind.JAXBException,
                                     java.io.UnsupportedEncodingException

String representation of this DeleteAlert.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DeleteAlert.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this DeleteAlert.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException