com.quantum.dxi.rest.vtl

Class ReportEmailRecipients

java.lang.Object

Base

com.quantum.dxi.rest.vtl.ReportEmailRecipients

public class ReportEmailRecipients
extends Base

The ReportEmailRecipients resource represents configuration of email recipients on the system. The ReportEmailRecipients interface includes services for getting, updating, creating, and deleting email recipients.

The schema that defines the ReportEmailRecipients resource is defined below.

 
    <xs:element name="ReportEmailRecipients">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="ReportEmailRecipient" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="ReportEmailRecipient">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Address" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ReportEmailRecipientColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Address"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ReportEmailRecipients()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addReportEmailRecipient(javax.servlet.http.HttpServletRequest request, ReportEmailRecipient alertEmailRecipient, String errorType) POST /rest/ReportEmailRecipients
void	deleteReportEmailRecipient(javax.servlet.http.HttpServletRequest request, String address, String errorType) DELETE /rest/ReportEmailRecipients/{address}
ReportEmailRecipient	getReportEmailRecipient(javax.servlet.http.HttpServletRequest request, String address, String errorType) GET /rest/ReportEmailRecipients/{address}
com.quantum.dxi.dao.types.ReportEmailRecipients	getReportEmailRecipients(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString, String errorType) GET /rest/ReportEmailRecipients
StringListScalarType	getReportEmailRecipientsAddresses(javax.servlet.http.HttpServletRequest request, String filterString, String errorType) GET /rest/ReportEmailRecipients/getAddresses
NumericScalarType	getReportEmailRecipientsCount(javax.servlet.http.HttpServletRequest request, String filterString, String errorType) GET /rest/ReportEmailRecipients/getRowCount
StringListScalarType	getReportEmailRecipientsNames(javax.servlet.http.HttpServletRequest request, String filterString, String errorType) Deprecated. As of 1.2 replaced by getReportEmailRecipientsAddresses(HttpServletRequest, String, String)
javax.ws.rs.core.Response	sendConfigOnDemand(javax.servlet.http.HttpServletRequest request, String address) POST /rest/ReportEmailRecipients/sendConfig/{address}
javax.ws.rs.core.Response	sendStatusOnDemand(javax.servlet.http.HttpServletRequest request, String address) POST /rest/ReportEmailRecipients/sendStatus/{address}

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportEmailRecipients

public ReportEmailRecipients()

Method Detail

getReportEmailRecipientsCount

public NumericScalarType getReportEmailRecipientsCount(@Context
                                                       javax.servlet.http.HttpServletRequest request,
                                                       String filterString,
                                                       String errorType)

GET /rest/ReportEmailRecipients/getRowCount

Get the number of ReportEmailRecipients configured on the system.

getReportEmailRecipientsCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="ReportEmailRecipientColumnName">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getReportEmailRecipientsAddresses

public StringListScalarType getReportEmailRecipientsAddresses(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              String filterString,
                                                              String errorType)

GET /rest/ReportEmailRecipients/getAddresses

Get the addresses of ReportEmailRecipients configured on the system.

getReportEmailRecipientsAddresses supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="ReportEmailRecipientColumnName">

Response Entity type: <xs:element name="StringListScalarType">

Since:

1.2

getReportEmailRecipientsNames

public StringListScalarType getReportEmailRecipientsNames(@Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          String filterString,
                                                          String errorType)

Deprecated. As of 1.2 replaced by getReportEmailRecipientsAddresses(HttpServletRequest, String, String)

GET /rest/ReportEmailRecipients/getNames

Get the names of ReportEmailRecipients configured on the system.

getReportEmailRecipientsNames supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="ReportEmailRecipientColumnName">

Response Entity type: <xs:element name="StringListScalarType">

Since:

1.1

getReportEmailRecipients

public com.quantum.dxi.dao.types.ReportEmailRecipients getReportEmailRecipients(@Context
                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                int start,
                                                                                int limit,
                                                                                String sortColumn,
                                                                                String sortDirection,
                                                                                String filterString,
                                                                                String errorType)

GET /rest/ReportEmailRecipients

Get the ReportEmailRecipients configured on the system.

Response Entity type: <xs:element name="ReportEmailRecipients">

<xs:element name="ReportEmailRecipients"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="ReportEmailRecipientColumnName">

Since:

1.1

getReportEmailRecipient

public ReportEmailRecipient getReportEmailRecipient(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String address,
                                                    String errorType)

GET /rest/ReportEmailRecipients/{address}

Get the ReportEmailRecipient on the system identified by {address}.

Response Entity type: <xs:element name="ReportEmailRecipient">

Since:

1.1

deleteReportEmailRecipient

public void deleteReportEmailRecipient(@Context
                                       javax.servlet.http.HttpServletRequest request,
                                       String address,
                                       String errorType)

DELETE /rest/ReportEmailRecipients/{address}

Delete the ReportEmailRecipient on the system identified by {address}.

Since:

1.1

addReportEmailRecipient

public javax.ws.rs.core.Response addReportEmailRecipient(@Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         ReportEmailRecipient alertEmailRecipient,
                                                         String errorType)

POST /rest/ReportEmailRecipients

Create a new ReportEmailRecipient on the system.

Request Entity type: <xs:element name="ReportEmailRecipient">

Response Entity type: <xs:element name="ReportEmailRecipient">

Since:

1.1

sendConfigOnDemand

public javax.ws.rs.core.Response sendConfigOnDemand(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String address)

POST /rest/ReportEmailRecipients/sendConfig/{address}

Email the config report to an email address.

Since:

1.1

sendStatusOnDemand

public javax.ws.rs.core.Response sendStatusOnDemand(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String address)

POST /rest/ReportEmailRecipients/sendStatus/{address}

Email the status report to an email address.

Since:

1.1