de.tsl2.nano.action.IActivable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tsl2.nano.common Show documentation

TSL2 Framework Commons (Collections, Actions/Excecution, Readers, Xml, Print, Mail, FuzzyFinder, Proxies, Network-Structure)

There is a newer version: 2.5.2

Show newest version

/*
 * Copyright © 2002-2009 Thomas Schneider
 * Alle Rechte vorbehalten.
 * Weiterverbreitung, Benutzung, Vervielfältigung oder Offenlegung,
 * auch auszugsweise, nur mit Genehmigung.
 * 
 * $Id$ 
 */
package de.tsl2.nano.action;

import java.io.Serializable;

import org.simpleframework.xml.Attribute;

/**
 * Implementors of this interface provide the possibility to check if a component should be active or not. will be used
 * as callback by the tsl2nano framework.
 * 
 * @author ts 06.03.2009
 * @version $Revision$
 */
public interface IActivable extends Serializable {

    /**
     * used as callback by framework to check for activation/enabling. may be called more than one time for refreshings.
     * implementation should be fast - please don't call remote services.
     * 
     * @return true if the component should be activated (enabled and visible).
     */
    boolean isActive();

    /** {@link #isActive()} will return always true */
    static final IActivable ACTIVE = new IActivable() {
        /** serialVersionUID */
        private static final long serialVersionUID = -8362817368656975730L;
        //workaround to have at least one member for simple-xml to serialize
        @Attribute
        boolean active = true;
        
        @Override
        public boolean isActive() {
            return active;
        }
        @Override
        public String toString() {
            return "Always Active";
        }
    };

    /** {@link #isActive()} will return always false */
    static final IActivable INACTIVE = new IActivable() {
        /** serialVersionUID */
        private static final long serialVersionUID = 5470534334831173886L;
        //workaround to have at least one member for simple-xml to serialize
        @Attribute
        boolean active = false;
        
        @Override
        public boolean isActive() {
            return active;
        }
        @Override
        public String toString() {
            return "Always Inactive";
        }
    };
}