org.jboss.shrinkwrap.descriptor.api.portletapp20.CustomPortletModeType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.portletapp20; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.PortalManagedType;
import org.jboss.shrinkwrap.descriptor.api.portletapp.*;
import org.jboss.shrinkwrap.descriptor.api.portletapp.PortletCustomPortletModeCommonType;
/**
 * This interface defines the contract for the  custom-portlet-modeType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface CustomPortletModeType extends Child, 
    PortletCustomPortletModeCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: CustomPortletModeType ElementName: string ElementType : description
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing description elements, 
    * a new description element 
    * @param values list of description objects 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType removeAllDescription();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: CustomPortletModeType ElementName: string ElementType : portlet-mode
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the portlet-mode element
    * @param portletMode the value for the element portlet-mode 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType portletMode(String portletMode);

   /**
    * Returns the portlet-mode element
    * @return the node defined for the element portlet-mode 
    */
   public String getPortletMode();

   /**
    * Removes the portlet-mode element 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType removePortletMode();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: CustomPortletModeType ElementName: portlet:portal-managedType ElementType : portal-managed
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the portal-managed element
    * @param portalManaged the value for the element portal-managed 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType portalManaged(PortalManagedType portalManaged);
   /**
    * Sets the portal-managed element
    * @param portalManaged the value for the element portal-managed 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType portalManaged(String portalManaged);

   /**
    * Returns the portal-managed element
    * @return the value found for the element portal-managed 
    */
   public PortalManagedType getPortalManaged();

   /**
    * Returns the portal-managed element
    * @return the value found for the element portal-managed 
    */
   public String  getPortalManagedAsString();

   /**
    * Removes the portal-managed attribute 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType removePortalManaged();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: CustomPortletModeType ElementName: string ElementType : id
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the id attribute
    * @param id the value for the attribute id 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType id(String id);

   /**
    * Returns the id attribute
    * @return the value defined for the attribute id 
    */
   public String getId();

   /**
    * Removes the id attribute 
    * @return the current instance of CustomPortletModeType 
    */
   public CustomPortletModeType removeId();
}