com.lexmark.saperion.client.administration

Interface TenantManagementClient

All Superinterfaces:

SearchClient<TenantListItemType>, SearchExecutionService<TenantListItemType>

All Known Implementing Classes:

TenantManagementClientImpl

public interface TenantManagementClient
extends SearchClient<TenantListItemType>

This client provides functionality to administrate tenants in a saperion system.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
TenantReferenceType	createTenant(String name, String adminPassword) This method creates a new tenant with the given name and returns a reference to the new tenant.
TenantReferenceType	createTenant(String name, String description, String adminPassword) This method creates a new tenant with the given name and description and returns a reference to the new tenant.
TenantClient	resolve(TenantReferenceType reference) This method returns a client capable to administrate the tenant with the given reference.
TenantClient	resolveName(String tenantName) This method returns a client capable to administrate the tenant with the given name.
SearchClient<TenantListItemType>	searchDeleted() This method returns a new SearchClient that can be used to search for deleted tenants.

Methods inherited from interface com.lexmark.saperion.client.SearchClient

exists, list, list, list, list, list, list, list, page, page, uniqueResult

Methods inherited from interface com.lexmark.saperion.search.SearchExecutionService

search

Method Detail

resolve

TenantClient resolve(TenantReferenceType reference)
              throws EcmException

This method returns a client capable to administrate the tenant with the given reference.

Parameters:

reference - a reference to the tenant to administrate

Returns:

a client capable to administrate the tenant with the given reference

Throws:

EcmException

resolveName

TenantClient resolveName(String tenantName)
                  throws EcmException

This method returns a client capable to administrate the tenant with the given name.

Parameters:

tenantName - the name of the tenant to administrate

Returns:

a client capable to administrate the tenant with the given name

Throws:

EcmException

createTenant

TenantReferenceType createTenant(String name,
                                 String description,
                                 String adminPassword)
                          throws EcmException

This method creates a new tenant with the given name and description and returns a reference to the new tenant. A tenant-administrator user with the given password will be created automatically.

Parameters:

name - the name of the tenant

description - a description of the tenant

adminPassword - the password for the tenant-administrator

Returns:

a reference to the newly created tenant

Throws:

EcmException - indicates that a system exception occurred

createTenant

TenantReferenceType createTenant(String name,
                                 String adminPassword)
                          throws EcmException

This method creates a new tenant with the given name and returns a reference to the new tenant. A tenant-administrator user with the given password will be created automatically.

Parameters:

name - the name of the tenant

adminPassword - the password for the tenant-administrator

Returns:

a reference to the newly created tenant

Throws:

EcmException - indicates that a system exception occurred

searchDeleted

SearchClient<TenantListItemType> searchDeleted()

This method returns a new SearchClient that can be used to search for deleted tenants.

Returns:

a search client for deleted tenants