Resources.java

package org.intellimate.izou.system.context;

import org.intellimate.izou.identification.Identification;
import org.intellimate.izou.identification.IllegalIDException;
import org.intellimate.izou.resource.ResourceModel;
import org.intellimate.izou.resource.ResourceBuilderModel;
import ro.fortsoft.pf4j.AddonAccessible;

import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;

/**
 * @author Leander Kurscheidt
 * @version 1.0
 */
@AddonAccessible
public interface Resources {
    /**
     * registers a ResourceBuilder.
     * <p>
     *  this method registers all the events, resourcesID etc.
     * </p>
     * @param resourceBuilder an instance of the ResourceBuilder
     * @throws IllegalIDException not yet implemented
     */
    void registerResourceBuilder(ResourceBuilderModel resourceBuilder) throws IllegalIDException;

    /**
     * unregister a ResourceBuilder.
     * <p>
     * this method unregisters all the events, resourcesID etc.
     * @param resourceBuilder an instance of the ResourceBuilder
     */
    void unregisterResourceBuilder(ResourceBuilderModel resourceBuilder);

    /**
     * generates a resources
     * <p>
     * @param resource the resource to request
     * @param consumer the callback when the ResourceBuilder finishes
     *  @throws IllegalIDException not yet implemented
     */
    @Deprecated
    void generateResource(ResourceModel resource, Consumer<List<ResourceModel>> consumer) throws IllegalIDException;

    /**
     * generates a resources
     * <p>
     * It will use the first matching resource! So if you really want to be sure, set the provider
     * Identification
     * </p>
     * @param resource the resource to request
     * @return an optional of an CompletableFuture
     * @throws IllegalIDException not yet implemented
     */
    Optional<CompletableFuture<List<ResourceModel>>> generateResource(ResourceModel resource) throws IllegalIDException;

    /**
     * returns the ID of the Manager
     * @return an instance of Identification
     */
    Identification getManagerIdentification();
}