IModule.java

/*
 * Copyright 2010, Maarten Billemont
 *
 *   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 com.lyndir.omicron.api;

import com.lyndir.omicron.api.error.OmicronException;


public interface IModule {

    /**
     * @return The resources required to construct this module.
     */
    ImmutableResourceCost getResourceCost();

    /**
     * @return The game object that hosts this module.
     */
    IGameObject getGameObject();

    /**
     * @return The type that defines the behavior of this module.
     */
    PublicModuleType<?> getType();

    /**
     * @return The controller that implements the operations supported by this module.
     */
    IModuleController<?> getController();

    class ImpossibleException extends OmicronException {

        ImpossibleException() {
            super( "Action not possible." );
        }
    }


    class InvalidatedException extends OmicronException {

        InvalidatedException() {
            super( "State change has invalidated this action." );
        }
    }
}