Package com.lexmark.saperion.client.implementation.administration

Class TenantClientImpl

  • All Implemented Interfaces:
    TenantClient
    public class TenantClientImpl
extends java.lang.Object
implements TenantClient
    This is the default implementation of TenantClient.
    Author:
    jschwarz

    • Constructor Summary

      Constructors 
      Constructor Description
      TenantClientImpl​(com.lexmark.saperion.administration.TenantManagementService tenantManagementService, com.lexmark.saperion.administration.TenantReferenceType reference)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()
      This method deletes the tenant.
      void deleteExtension()
      This method deletes the schema-extension properties of the tenant.
      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.
      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​(java.lang.String description)
      This method updates the tenant with the given properties.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TenantClientImpl

        public TenantClientImpl​(com.lexmark.saperion.administration.TenantManagementService tenantManagementService,
                        com.lexmark.saperion.administration.TenantReferenceType reference)

    • Method Detail

      • delete

        public void delete()
            throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method deletes the tenant.
        Specified by:
        delete in interface TenantClient
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • undelete

        public void undelete()
              throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method un-deletes the tenant.
        Specified by:
        undelete in interface TenantClient
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • load

        public com.lexmark.saperion.administration.TenantType load()
                                                    throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method loads the tenant.
        Specified by:
        load in interface TenantClient
        Returns:
        the tenant this service is bound to
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • update

        public void update​(java.lang.String description)
            throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method updates the tenant with the given properties.
        Specified by:
        update in interface TenantClient
        Parameters:
        description - a description of the tenant
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • setSchemaExtension

        public void setSchemaExtension​(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
                        throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        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.
        Specified by:
        setSchemaExtension in interface TenantClient
        Parameters:
        extension - schema-extension properties
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

      • getSchemaExtension

        public com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension()
                                                                               throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method returns the schema-extension properties of the tenant.
        Specified by:
        getSchemaExtension in interface TenantClient
        Returns:
        schema-extension properties of the tenant
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

      • deleteExtension

        public void deleteExtension()
                     throws com.lexmark.saperion.exceptions.EcmException
        Description copied from interface: TenantClient
        This method deletes the schema-extension properties of the tenant.
        Specified by:
        deleteExtension in interface TenantClient
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted