dm.soap.services.organization

Class DmSoapOrganization

java.lang.Object

DmSoapService

dm.soap.services.organization.DmSoapOrganization

Direct Known Subclasses:

DmSoapSamlOrganization

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

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

Method Summary

Modifier and Type	Method and Description
int	createOrganization(OrganizationInfo organizationInfo, java.lang.String reason) Web service operation for the CreateOrganizationCmd.
void	deleteOrganization(java.lang.String abbreviation, java.lang.String reason) Web service operation for the DeleteOrganizationCmd.
boolean	exists(java.lang.String abbreviation) Web service operation to see if the specified organization exists.
void	modifyOrganization(java.lang.String abbreviation, OrganizationInfo newOrganizationInfo, java.lang.String reason) Web service operation for the ModifyOrganizationCmd.
OrganizationInfo	showOrganization(java.lang.String abbreviation) Web service operation for showing a specific organization 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

DmSoapOrganization

public DmSoapOrganization()

Method Detail

createOrganization

public int createOrganization(OrganizationInfo organizationInfo,
                              java.lang.String reason)
                       throws DmSoapException

Web service operation for the CreateOrganizationCmd.

Parameters:

organizationInfo - A OrganizationInfo object for the org to create.

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

Returns:

The unique ID of the create organization created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

deleteOrganization

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

Web service operation for the DeleteOrganizationCmd.

Parameters:

abbreviation - The organization 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 organization exists.

Parameters:

abbreviation - The organization abbreviation.

Throws:

DmSoapException - A DmSoapException if an error occurs.

modifyOrganization

public void modifyOrganization(java.lang.String abbreviation,
                               OrganizationInfo newOrganizationInfo,
                               java.lang.String reason)
                        throws DmSoapException

Web service operation for the ModifyOrganizationCmd. Obtain the OrganizationInfo object from showOrganization for the organization you want to modify. Change what you want, and call modifyOrganization with the organization abbreviation and modified OrganizationInfo object.

Parameters:

abbreviation - The abbreviation of the existing org to modify.

newOrganizationInfo - A modified OrganizationInfo 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.

showOrganization

public OrganizationInfo showOrganization(java.lang.String abbreviation)
                                  throws DmSoapException

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

Parameters:

abbreviation - The organization abbreviation.

Returns:

A OrganizationInfo object, or null.

Throws:

DmSoapException - A DmSoapException if an error occurs.