dm.soap.services.metrictype

Class DmSoapMetricType

java.lang.Object

DmSoapService

dm.soap.services.metrictype.DmSoapMetricType

Direct Known Subclasses:

DmSoapSamlMetricType

@MTOM(enabled=true,
      threshold=2048)
public class DmSoapMetricType
extends DmSoapService

This SOAP service is used to expose all Metric Type related TechDoc operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.ws.WebServiceContext	_context The WebServiceContext that called this service.

Constructor Summary

Constructors

Constructor and Description
DmSoapMetricType()

Method Summary

Modifier and Type	Method and Description
int	createMetricType(MetricTypeInfo metricTypeInfo, java.lang.String reason) Web service operation for the CreateMetricTypeCmd.
void	deleteMetricType(java.lang.String name, java.lang.String reason) Web service operation for the DeleteMetricTypeCmd.
boolean	exists(java.lang.String name) Web service operation to see if the specified metric type exists.
void	modifyMetricType(java.lang.String name, MetricTypeInfo newMetricTypeInfo, java.lang.String reason) Web service operation for the ModifyMetricTypeCmd.
MetricTypeInfo	showMetricType(java.lang.String name) Web service operation for showing a specific metric type specified by the name.

Methods inherited from class java.lang.Object

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

Field Detail

_context

protected javax.xml.ws.WebServiceContext _context

The WebServiceContext that called this service.

Constructor Detail

DmSoapMetricType

public DmSoapMetricType()

Method Detail

createMetricType

public int createMetricType(MetricTypeInfo metricTypeInfo,
                            java.lang.String reason)
                     throws DmSoapException

Web service operation for the CreateMetricTypeCmd.

Parameters:

metricTypeInfo - A MetricTypeInfo object for the metric type to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The unique ID of the metric type created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

deleteMetricType

public void deleteMetricType(java.lang.String name,
                             java.lang.String reason)
                      throws DmSoapException

Web service operation for the DeleteMetricTypeCmd.

Parameters:

name - The metric type name.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

exists

public boolean exists(java.lang.String name)
               throws DmSoapException

Web service operation to see if the specified metric type exists.

Parameters:

name - The metric type name.

Throws:

DmSoapException - A DmSoapException if an error occurs.

modifyMetricType

public void modifyMetricType(java.lang.String name,
                             MetricTypeInfo newMetricTypeInfo,
                             java.lang.String reason)
                      throws DmSoapException

Web service operation for the ModifyMetricTypeCmd. Obtain the MetricTypeInfo object from showMetricType for the metric type you want to modify. Change what you want, and call modifyMetricType with the type name and modified MetricTypeInfo object.

Parameters:

name - The name of the metric type to modify.

newMetricTypeInfo - A modified MetricTypeInfo object.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

showMetricType

public MetricTypeInfo showMetricType(java.lang.String name)
                              throws DmSoapException

Web service operation for showing a specific metric type specified by the name.

Parameters:

name - The metric type name.

Returns:

A MetricTypeInfo object, or null.

Throws:

DmSoapException - A DmSoapException if an error occurs.