dm.soap.services.employer

Class DmSoapEmployer

java.lang.Object

DmSoapService

dm.soap.services.employer.DmSoapEmployer

Direct Known Subclasses:

DmSoapSamlEmployer

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

This SOAP service is used to expose all Employer 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
DmSoapEmployer()

Method Summary

Modifier and Type	Method and Description
int	createEmployer(EmployerInfo employerInfo, java.lang.String reason) Web service operation for the CreateEmployerCmd.
void	deleteEmployer(java.lang.String abbreviation, java.lang.String reason) Web service operation for the DeleteEmployerCmd.
boolean	exists(java.lang.String abbreviation) Web service operation to see if the specified employer exists.
void	modifyEmployer(java.lang.String abbreviation, EmployerInfo newEmployerInfo, java.lang.String reason) Web service operation for the ModifyEmployerCmd.
EmployerInfo	showEmployer(java.lang.String abbreviation) Web service operation for showing a specific employer specified by the abbreviation.

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

DmSoapEmployer

public DmSoapEmployer()

Method Detail

createEmployer

public int createEmployer(EmployerInfo employerInfo,
                          java.lang.String reason)
                   throws DmSoapException

Web service operation for the CreateEmployerCmd.

Parameters:

employerInfo - A EmployerInfo object for the employer to create.

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

Returns:

The unique ID of the employer created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

deleteEmployer

public void deleteEmployer(java.lang.String abbreviation,
                           java.lang.String reason)
                    throws DmSoapException

Web service operation for the DeleteEmployerCmd.

Parameters:

abbreviation - The employer abbreviation.

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 abbreviation)
               throws DmSoapException

Web service operation to see if the specified employer exists.

Parameters:

abbreviation - The employer abbreviation.

Throws:

DmSoapException - A DmSoapException if an error occurs.

modifyEmployer

public void modifyEmployer(java.lang.String abbreviation,
                           EmployerInfo newEmployerInfo,
                           java.lang.String reason)
                    throws DmSoapException

Web service operation for the ModifyEmployerCmd. Obtain the EmployerInfo object from showEmployer for the employer you want to modify. Change what you want, and call modifyEmployer with the employer abbreviation and modified EmployerInfo object.

Parameters:

abbreviation - The employer abbreviation of the existing employer to modify.

newEmployerInfo - A modified EmployerInfo object for the employer abbreviation specified.

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

Throws:

DmSoapException - A DmSoapException if an error occurs.

showEmployer

public EmployerInfo showEmployer(java.lang.String abbreviation)
                          throws DmSoapException

Web service operation for showing a specific employer specified by the abbreviation.

Parameters:

abbreviation - The employer abbreviation.

Returns:

A EmployerInfo object, or null.

Throws:

DmSoapException - A DmSoapException if an error occurs.