/******************************************************************************
 * Copyright (c) 2016 Oracle
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Konstantin Komissarchik - initial implementation and ongoing maintenance
 ******************************************************************************/

package org.eclipse.sapphire.samples.uml;

import org.eclipse.sapphire.ElementList;
import org.eclipse.sapphire.ElementType;
import org.eclipse.sapphire.ListProperty;
import org.eclipse.sapphire.Type;
import org.eclipse.sapphire.Value;
import org.eclipse.sapphire.ValueProperty;
import org.eclipse.sapphire.modeling.annotations.DefaultValue;
import org.eclipse.sapphire.modeling.annotations.Enablement;
import org.eclipse.sapphire.modeling.annotations.Label;
import org.eclipse.sapphire.modeling.annotations.Required;

/**
 * @author <a href="mailto:konstantin.komissarchik@oracle.com">Konstantin Komissarchik</a>
 */

public interface Method extends Accessible
{
    ElementType TYPE = new ElementType( Method.class );
    
    // *** Name ***
    
    @Label( standard = "name" )
    @Required
    
    ValueProperty PROP_NAME = new ValueProperty( TYPE, "Name" );
    
    Value<String> getName();
    void setName( String value );
    
    // *** ReturnType ***
    
    @Label( standard = "return type" )
    @Required
    
    ValueProperty PROP_RETURN_TYPE = new ValueProperty( TYPE, "ReturnType" );
    
    Value<String> getReturnType();
    void setReturnType( String value );
    
    // *** Parameters ***
    
    @Type( base = Parameter.class )
    @Label( standard = "parameters" )
    
    ListProperty PROP_PARAMETERS = new ListProperty( TYPE, "Parameters" );
    
    ElementList<Parameter> getParameters();
    
    // *** Static ***
    
    @Type( base = Boolean.class )
    @Label( standard = "static" )
    @DefaultValue( text = "false" )
    @Enablement( expr = "${ Parent.Kind == 'class' }" )
    
    ValueProperty PROP_STATIC = new ValueProperty( TYPE, "Static" );
    
    Value<Boolean> getStatic();
    void setStatic( String value );
    void setStatic( Boolean value );
    
    // *** Abstract ***
    
    @Type( base = Boolean.class )
    @Label( standard = "abstract" )
    @DefaultValue( text = "false" )
    @Enablement( expr = "${ Parent.Kind == 'class' }" )
    
    ValueProperty PROP_ABSTRACT = new ValueProperty( TYPE, "Abstract" );
    
    Value<Boolean> getAbstract();
    void setAbstract( String value );
    void setAbstract( Boolean value );
    
    // *** Final ***
    
    @Type( base = Boolean.class )
    @Label( standard = "final" )
    @DefaultValue( text = "false" )
    @Enablement( expr = "${ Parent.Kind == 'class' }" )
    
    ValueProperty PROP_FINAL = new ValueProperty( TYPE, "Final" );
    
    Value<Boolean> getFinal();
    
    void setFinal( String value );
    void setFinal( Boolean value );
    
    // *** Overrides ***
    
    @Type( base = Boolean.class )
    @Label( standard = "overrides" )
    @DefaultValue( text = "false" )
    
    // TODO: This should be a derived property.
    
    ValueProperty PROP_OVERRIDES = new ValueProperty( TYPE, "Overrides" );
    
    Value<Boolean> getOverrides();
    void setOverrides( String value );
    void setOverrides( Boolean value );
    
}