PortletApp.java example

Explorer
liferay-ide-master
/*******************************************************************************
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * Contributors:
 *      Kamesh Sampath - initial implementation
 *      Gregory Amerson - initial implementation review and ongoing maintenance
 *******************************************************************************/

package com.liferay.ide.portlet.core.model;

import org.eclipse.sapphire.ElementList;
import org.eclipse.sapphire.ElementType;
import org.eclipse.sapphire.ListProperty;
import org.eclipse.sapphire.Type;
import org.eclipse.sapphire.Unique;
import org.eclipse.sapphire.Value;
import org.eclipse.sapphire.ValueProperty;
import org.eclipse.sapphire.modeling.annotations.Image;
import org.eclipse.sapphire.modeling.annotations.Label;
import org.eclipse.sapphire.modeling.xml.annotations.XmlBinding;
import org.eclipse.sapphire.modeling.xml.annotations.XmlListBinding;
import org.eclipse.sapphire.modeling.xml.annotations.XmlNamespace;
import org.eclipse.sapphire.modeling.xml.annotations.XmlSchema;

/**
 * The root container model class that will have <portlet-app>
 *
 * @author Kamesh Sampath <br/>
 * @author Gregory Amerson
 */
@Image( path = "images/obj16/portlet_model_obj.gif" )
@XmlNamespace( prefix = "", uri = "http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" )
@XmlSchema
(
    namespace = "http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd",
    location = "http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
)
@XmlBinding( path = "portlet-app" )
public interface PortletApp extends ResourceBundle, Identifiable
{

    ElementType TYPE = new ElementType( PortletApp.class );

    /*
     * Portlets
     */

    @Type( base = Portlet.class )
    @XmlListBinding( mappings = @XmlListBinding.Mapping( element = "portlet", type = Portlet.class ) )
    ListProperty PROP_PORTLETS = new ListProperty( TYPE, "Portlets" ); //$NON-NLS-1$

    ElementList<Portlet> getPortlets();

    // *** CustomPortletMode ***

    @Type( base = CustomPortletMode.class )
    @XmlListBinding
    (
        mappings = @XmlListBinding.Mapping
        (
            element = "custom-portlet-mode",
            type = CustomPortletMode.class
        )
    )
    ListProperty PROP_CUSTOM_PORTLET_MODES = new ListProperty( TYPE, "CustomPortletModes" ); //$NON-NLS-1$

    ElementList<CustomPortletMode> getCustomPortletModes();

    // *** CustomWindowStates ***

    @Type( base = CustomWindowState.class )
    @XmlListBinding
    (
        mappings = @XmlListBinding.Mapping
        (
            element = "custom-window-state",
            type = CustomWindowState.class
        )
    )
    ListProperty PROP_CUSTOM_WINDOW_STATES = new ListProperty( TYPE, "CustomWindowStates" ); //$NON-NLS-1$

    ElementList<CustomWindowState> getCustomWindowStates();

    // *** UserAttributes ***

    @Type( base = UserAttribute.class )
    @Label( standard = "User Attribute" )
    @XmlListBinding( mappings = { @XmlListBinding.Mapping( type = UserAttribute.class, element = "user-attribute" ) } )
    ListProperty PROP_USER_ATTRIBUTES = new ListProperty( TYPE, "UserAttributes" ); //$NON-NLS-1$

    ElementList<UserAttribute> getUserAttributes();

    // *** SecurityConstraints ***

    @Type( base = SecurityConstraint.class )
    @Label( standard = "Security Constraints" )
    @XmlListBinding
    (
        mappings = @XmlListBinding.Mapping
        (
            type = SecurityConstraint.class,
            element = "security-constraint"
        )
    )
    ListProperty PROP_SECURITY_CONSTRAINTS = new ListProperty( TYPE, "SecurityConstraints" ); //$NON-NLS-1$

    ElementList<SecurityConstraint> getSecurityConstraints();

    // *** Filters ***

    @Type( base = Filter.class )
    @Label( standard = "filters" )
    @XmlListBinding( mappings = @XmlListBinding.Mapping( element = "filter", type = Filter.class ) )
    ListProperty PROP_FILTERS = new ListProperty( TYPE, "Filters" ); //$NON-NLS-1$

    ElementList<Filter> getFilters();

    // *** FilterMappings ***

    @Type( base = FilterMapping.class )
    @Label( standard = "filter mappings" )
    @XmlListBinding( mappings = @XmlListBinding.Mapping( element = "filter-mapping", type = FilterMapping.class ) )
    ListProperty PROP_FILTER_MAPPINGS = new ListProperty( TYPE, "FilterMappings" ); //$NON-NLS-1$

    ElementList<FilterMapping> getFilterMappings();

    // *** DefaultNameSpace ***

    @Label( standard = "Default Namespace" )
    @Unique
    @XmlBinding( path = "default-namespace" )
    ValueProperty PROP_DEFAULT_NAMESPACE = new ValueProperty( TYPE, "DefaultNameSpace" ); //$NON-NLS-1$

    Value<String> getDefaultNameSpace();

    void setDefaultNameSpace( String value );

    // *** EventDefinitions ***

    @Type( base = EventDefinition.class )
    @Label( standard = "Event Definitions" )
    @XmlListBinding( mappings = @XmlListBinding.Mapping( element = "event-definition", type = EventDefinition.class ) )
    ListProperty PROP_EVENT_DEFINITIONS = new ListProperty( TYPE, "EventDefinitions" ); //$NON-NLS-1$

    ElementList<EventDefinition> getEventDefinitions();

    // *** PublicRenderParameters ***

    @Type( base = PublicRenderParameter.class )
    @Label( standard = "Public Render Parameters" )
    @XmlListBinding
    (
        mappings = @XmlListBinding.Mapping
        (
            element = "public-render-parameter",
            type = PublicRenderParameter.class
        )
    )
    ListProperty PROP_PUBLIC_RENDER_PARAMETERS = new ListProperty( TYPE, "PublicRenderParameters" ); //$NON-NLS-1$

    ElementList<PublicRenderParameter> getPublicRenderParameters();

    // *** Listeners ***

    @Type( base = Listener.class )
    @Label( standard = "listeners" )
    @XmlListBinding( mappings = @XmlListBinding.Mapping( element = "listener", type = Listener.class ) )
    ListProperty PROP_LISTENERS = new ListProperty( TYPE, "Listeners" ); //$NON-NLS-1$

    ElementList<Listener> getListeners();

    // *** ContainerRuntimeOptions ***

    @Type( base = ContainerRuntimeOption.class )
    @Label( standard = "Container Runtime Options" )
    @XmlListBinding
    (
        mappings = @XmlListBinding.Mapping
        (
            element = "container-runtime-option",
            type = ContainerRuntimeOption.class
        )
    )
    ListProperty PROP_CONTAINER_RUNTIME_OPTIONS = new ListProperty( TYPE, "ContainerRuntimeOptions" ); //$NON-NLS-1$

    ElementList<ContainerRuntimeOption> getContainerRuntimeOptions();

}