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(org.nhindirect.config.store.Domain domain) Add a new Domain.
org.nhindirect.config.store.Domain	getDomain(Long id) Return a Domain matching the given ID.
int	getDomainCount() Get a count of Domains.
Collection<org.nhindirect.config.store.Domain>	getDomains(Collection<String> domainNames, org.nhindirect.config.store.EntityStatus status) Get a collection of all Domains matching the parameters.
Collection<org.nhindirect.config.store.Domain>	listDomains(String lastDomainName, int maxResults) Return a list of Domains matching the parameters.
void	removeDomain(String domainName) Deprecated. Use of removeDomain(Long domainId) is preferred.
void	removeDomainById(Long domainId) Remove a Domain.
Collection<org.nhindirect.config.store.Domain>	searchDomain(String domain, org.nhindirect.config.store.EntityStatus status) Return a collection of Domains matching the parameters.
void	updateDomain(org.nhindirect.config.store.Domain domain) Update a Domain.

Method Detail

addDomain

void addDomain(org.nhindirect.config.store.Domain domain)
               throws ConfigurationServiceException

Add a new Domain.

Parameters:

domain - The Domain to add.

Throws:

ConfigurationServiceException

updateDomain

void updateDomain(org.nhindirect.config.store.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<org.nhindirect.config.store.Domain> getDomains(Collection<String> domainNames,
                                                          org.nhindirect.config.store.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

@Deprecated
void removeDomain(String domainName)
                  throws ConfigurationServiceException

Deprecated. Use of removeDomain(Long domainId) is preferred.

Remove a Domain.

Parameters:

domainName - The name of the Domain to remove.

Throws:

ConfigurationServiceException

removeDomainById

void removeDomainById(Long domainId)
                      throws ConfigurationServiceException

Remove a Domain.

Parameters:

domainId - The id of the Domain to remove.

Throws:

ConfigurationServiceException

listDomains

Collection<org.nhindirect.config.store.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<org.nhindirect.config.store.Domain> searchDomain(String domain,
                                                            org.nhindirect.config.store.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

org.nhindirect.config.store.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.