com.lexmark.saperion.client.administration

Interface TenantClient

All Known Implementing Classes:

TenantClientImpl

public interface TenantClient

This client provides functionality to administrate a given tenant.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the tenant.
void	deleteExtension() This method deletes the schema-extension properties of the tenant.
default Map<String,com.lexmark.saperion.PropertyType>	getExtension() Deprecated. use getSchemaExtension() instead
com.lexmark.saperion.administration.ExtensionPropertiesType	getSchemaExtension() This method returns the schema-extension properties of the tenant.
com.lexmark.saperion.administration.TenantType	load() This method loads the tenant.
default void	setExtension(Map<String,com.lexmark.saperion.PropertyType> extension) Deprecated. use setSchemaExtension(ExtensionPropertiesType) instead
void	setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension) This method sets the schema-extension properties of the tenant.
void	undelete() This method un-deletes the tenant.
void	update(String description) This method updates the tenant with the given properties.

Method Detail

delete

void delete()
     throws com.lexmark.saperion.exceptions.EcmException

This method deletes the tenant.

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

undelete

void undelete()
       throws com.lexmark.saperion.exceptions.EcmException

This method un-deletes the tenant.

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

load

com.lexmark.saperion.administration.TenantType load()
                                             throws com.lexmark.saperion.exceptions.EcmException

This method loads the tenant.

Returns:

the tenant this service is bound to

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

update

void update(String description)
     throws com.lexmark.saperion.exceptions.EcmException

This method updates the tenant with the given properties.

Parameters:

description - a description of the tenant

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

setExtension

@Deprecated
default void setExtension(Map<String,com.lexmark.saperion.PropertyType> extension)
                                throws com.lexmark.saperion.exceptions.EcmException

Deprecated. use setSchemaExtension(ExtensionPropertiesType) instead

This method sets the schema-extension properties of the tenant. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

extension - schema-extension properties

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

setSchemaExtension

void setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
                 throws com.lexmark.saperion.exceptions.EcmException

This method sets the schema-extension properties of the tenant. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

extension - schema-extension properties

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

getExtension

@Deprecated
default Map<String,com.lexmark.saperion.PropertyType> getExtension()
                                                                         throws com.lexmark.saperion.exceptions.EcmException

Deprecated. use getSchemaExtension() instead

This method returns the schema-extension properties of the tenant.

Returns:

schema-extension properties of the tenant

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

getSchemaExtension

com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension()
                                                                        throws com.lexmark.saperion.exceptions.EcmException

This method returns the schema-extension properties of the tenant.

Returns:

schema-extension properties of the tenant

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

deleteExtension

void deleteExtension()
              throws com.lexmark.saperion.exceptions.EcmException

This method deletes the schema-extension properties of the tenant.

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted