Class MandantAPI

java.lang.Object
de.xima.fc.api.ASubAPI
de.xima.fc.api.entity.AEntityAPI<Mandant>
de.xima.fc.api.entity.MandantAPI
public class MandantAPI extends AEntityAPI<Mandant>
API class for manipulation of Mandant entities.
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • MandantAPI

      public MandantAPI()

  • Method Details

    • getByName

      public Mandant getByName(UserContext uc, String name)
      Method for determining a Mandant by his name (case-insensitive).
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      name - String the name of the Mandant (case-insensitive).
      Returns:
      Mandant which was searched.
      Since:
      2.4.3

    • getAllByName

      public List<Mandant> getAllByName(UserContext uc, String name)
      Method for determining all Mandants by name (case-insensitive).
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      name - String the name which is to searched (case-insensitive).
      Returns:
      List of Mandant which were found.
      Since:
      2.4.3

    • getCustomAttributes

      @NotNull public @NotNull Map<String,String> getCustomAttributes(UserContext uc, Mandant client)
      Gets the custom properties of this client. This method is needed when the map of the custom properties hasn't yet been initialized.
      Parameters:
      uc - User context for database transactions.
      client - the client to get the custom properties for.
      Returns:
      a map of all the custom properties of the client.
      Since:
      8.0.0

    • getByUUID

      public Mandant getByUUID(UserContext uc, String uuid)

    • getByUUID

      public Mandant getByUUID(UserContext uc, UUID uuid)

    • isCreationAllowed

      public boolean isCreationAllowed(UserContext uc, Mandant mandant)
      Method for checking if the creation of a Mandant is allowed.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      mandant - Mandant which is to check.
      Returns:
      Boolean if the creation is allowed true, otherwise false.

    • updateClientLastUserLogin

      public void updateClientLastUserLogin(org.pac4j.core.profile.UserProfile profile)
      Updates the Mandant.getLastUserLogin() property to the current date, for all clients that the given user can access. This method should be called after a login.
      Parameters:
      profile - Profile of a user that has logged in.