org.nhindirect.config.service
Interface DomainService

All Known Subinterfaces:
ConfigurationService
All Known Implementing Classes:
ConfigurationServiceImpl, DomainServiceImpl

public interface DomainService

Service class for methods related to a Domain object.


Method Summary
 void addDomain(Domain domain)
          Add a new Domain.
 Domain getDomain(Long id)
          Return a Domain matching the given ID.
 int getDomainCount()
          Get a count of Domains.
 Collection<Domain> getDomains(Collection<String> domainNames, EntityStatus status)
          Get a collection of all Domains matching the parameters.
 Collection<Domain> listDomains(String lastDomainName, int maxResults)
          Return a list of Domains matching the parameters.
 void removeDomain(String domainName)
          Remove a Domain.
 Collection<Domain> searchDomain(String domain, EntityStatus status)
          Return a collection of Domains matching the parameters.
 void updateDomain(Domain domain)
          Update a Domain.
 

Method Detail

addDomain

void addDomain(Domain domain)
               throws ConfigurationServiceException
Add a new Domain.

Parameters:
domain - The Domain to add.
Throws:
ConfigurationServiceException

updateDomain

void updateDomain(Domain domain)
                  throws ConfigurationServiceException
Update a Domain.

Parameters:
domain - The Domain to update.
Throws:
ConfigurationServiceException

getDomainCount

int getDomainCount()
                   throws ConfigurationServiceException
Get a count of Domains.

Returns:
a count of Domains.
Throws:
ConfigurationServiceException

getDomains

Collection<Domain> getDomains(Collection<String> domainNames,
                              EntityStatus status)
                              throws ConfigurationServiceException
Get a collection of all Domains matching the parameters.

Parameters:
domainNames - A collection of domain names.
status - An EntityStatus object.
Returns:
a collection of all Domains matching the parameters.
Throws:
ConfigurationServiceException

removeDomain

void removeDomain(String domainName)
                  throws ConfigurationServiceException
Remove a Domain.

Parameters:
domainName - The name of the Domain to remove.
Throws:
ConfigurationServiceException

listDomains

Collection<Domain> listDomains(String lastDomainName,
                               int maxResults)
                               throws ConfigurationServiceException
Return a list of Domains matching the parameters.

Parameters:
lastDomainName - The last domain name.
maxResults - The maximum number of results.
Returns:
a List of Domains matching the parameters.
Throws:
ConfigurationServiceException

searchDomain

Collection<Domain> searchDomain(String domain,
                                EntityStatus status)
Return a collection of Domains matching the parameters.

Parameters:
domain - The Domain name.
status - The Domain EntityStatus.
Returns:
a collection of Domains matching the parameters.

getDomain

Domain getDomain(Long id)
Return a Domain matching the given ID.

Parameters:
id - The ID of the Domain.
Returns:
a Domain matching the given ID.


Copyright © 2010. All Rights Reserved.