org.openwms.common.account.AccountService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.openwms.common.service.lib Show documentation

A library with essential functionality on common resources like Locations, LocationGroups and TransportUnits

The newest version!

/*
 * Copyright 2005-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.openwms.common.account;

import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;

import java.util.List;
import java.util.Optional;

/**
 * A AccountService.
 *
 * @author Heiko Scherrer
 */
public interface AccountService {

    /**
     * Find and return a list of all existing {@link Account}s.
     *
     * @return A list, never {@literal null}
     */
    @NotNull List findAll();

    /**
     * Find and return a single {@link Account} instance identified by its persistent key.
     *
     * @param pKey The persistent key
     * @return The Account instance
     */
    @NotNull Account findByPKey(@NotBlank String pKey);

    /**
     * Find and return the {@link Account}.
     *
     * @param identifier The Account's identifier
     * @return The Account instance
     */
    Optional findByIdentifier(@NotBlank String identifier);

    /**
     * Find and return the {@link Account}.
     *
     * @param name The Account's name
     * @return The Account instance
     */
    Optional findByName(@NotBlank String name);

    /**
     *
     * @return
     */
    Optional findDefault();
}