org.jboss.shrinkwrap.descriptor.api.portletapp20.PortletType 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.InitParamType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.SupportsType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.PortletInfoType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.PortletPreferencesType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.SecurityRoleRefType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.EventDefinitionReferenceType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.EventDefinitionReferenceType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.ContainerRuntimeOptionType;
import org.jboss.shrinkwrap.descriptor.api.portletapp.*;
import org.jboss.shrinkwrap.descriptor.api.portletapp.PortletPortletCommonType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.InitParamType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.SupportsType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.PortletInfoType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.PortletPreferencesType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.SecurityRoleRefType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.EventDefinitionReferenceType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.EventDefinitionReferenceType;
import org.jboss.shrinkwrap.descriptor.api.portletapp20.ContainerRuntimeOptionType;/**
* This interface defines the contract for the portletType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface PortletType extends Child,
PortletPortletCommonType,
InitParamType>,
SupportsType>,
PortletInfoType>,
PortletPreferencesType>,
SecurityRoleRefType>,
EventDefinitionReferenceType>,
EventDefinitionReferenceType>,
ContainerRuntimeOptionType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType 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 PortletType
*/
public PortletType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of PortletType
*/
public PortletType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : portlet-name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the portlet-name element
* @param portletName the value for the element portlet-name
* @return the current instance of PortletType
*/
public PortletType portletName(String portletName);
/**
* Returns the portlet-name element
* @return the node defined for the element portlet-name
*/
public String getPortletName();
/**
* Removes the portlet-name element
* @return the current instance of PortletType
*/
public PortletType removePortletName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : display-name
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of PortletType
*/
public PortletType displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of PortletType
*/
public PortletType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : portlet-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the portlet-class element
* @param portletClass the value for the element portlet-class
* @return the current instance of PortletType
*/
public PortletType portletClass(String portletClass);
/**
* Returns the portlet-class element
* @return the node defined for the element portlet-class
*/
public String getPortletClass();
/**
* Removes the portlet-class element
* @return the current instance of PortletType
*/
public PortletType removePortletClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:init-paramType ElementType : init-param
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new init-param element will be created and returned.
* Otherwise, the first existing init-param element will be returned.
* @return the instance defined for the element init-param
*/
public InitParamType> getOrCreateInitParam();
/**
* Creates a new init-param element
* @return the new created instance of InitParamType>
*/
public InitParamType> createInitParam();
/**
* Returns all init-param elements
* @return list of init-param
*/
public List>> getAllInitParam();
/**
* Removes all init-param elements
* @return the current instance of InitParamType>
*/
public PortletType removeAllInitParam();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: xsd:int ElementType : expiration-cache
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the expiration-cache element
* @param expirationCache the value for the element expiration-cache
* @return the current instance of PortletType
*/
public PortletType expirationCache(Integer expirationCache);
/**
* Returns the expiration-cache element
* @return the node defined for the element expiration-cache
*/
public Integer getExpirationCache();
/**
* Removes the expiration-cache element
* @return the current instance of PortletType
*/
public PortletType removeExpirationCache();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : cache-scope
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the cache-scope element
* @param cacheScope the value for the element cache-scope
* @return the current instance of PortletType
*/
public PortletType cacheScope(String cacheScope);
/**
* Returns the cache-scope element
* @return the node defined for the element cache-scope
*/
public String getCacheScope();
/**
* Removes the cache-scope element
* @return the current instance of PortletType
*/
public PortletType removeCacheScope();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:supportsType ElementType : supports
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new supports element will be created and returned.
* Otherwise, the first existing supports element will be returned.
* @return the instance defined for the element supports
*/
public SupportsType> getOrCreateSupports();
/**
* Creates a new supports element
* @return the new created instance of SupportsType>
*/
public SupportsType> createSupports();
/**
* Returns all supports elements
* @return list of supports
*/
public List>> getAllSupports();
/**
* Removes all supports elements
* @return the current instance of SupportsType>
*/
public PortletType removeAllSupports();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : supported-locale
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing supported-locale elements,
* a new supported-locale element
* @param values list of supported-locale objects
* @return the current instance of PortletType
*/
public PortletType supportedLocale(String ... values);
/**
* Returns all supported-locale elements
* @return list of supported-locale
*/
public List getAllSupportedLocale();
/**
* Removes the supported-locale element
* @return the current instance of PortletType
*/
public PortletType removeAllSupportedLocale();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : resource-bundle
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the resource-bundle element
* @param resourceBundle the value for the element resource-bundle
* @return the current instance of PortletType
*/
public PortletType resourceBundle(String resourceBundle);
/**
* Returns the resource-bundle element
* @return the node defined for the element resource-bundle
*/
public String getResourceBundle();
/**
* Removes the resource-bundle element
* @return the current instance of PortletType
*/
public PortletType removeResourceBundle();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:portlet-infoType ElementType : portlet-info
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new portlet-info element with the given value will be created.
* Otherwise, the existing portlet-info element will be returned.
* @return a new or existing instance of PortletInfoType>
*/
public PortletInfoType> getOrCreatePortletInfo();
/**
* Removes the portlet-info element
* @return the current instance of PortletType
*/
public PortletType removePortletInfo();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:portlet-preferencesType ElementType : portlet-preferences
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new portlet-preferences element with the given value will be created.
* Otherwise, the existing portlet-preferences element will be returned.
* @return a new or existing instance of PortletPreferencesType>
*/
public PortletPreferencesType> getOrCreatePortletPreferences();
/**
* Removes the portlet-preferences element
* @return the current instance of PortletType
*/
public PortletType removePortletPreferences();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:security-role-refType ElementType : security-role-ref
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new security-role-ref element will be created and returned.
* Otherwise, the first existing security-role-ref element will be returned.
* @return the instance defined for the element security-role-ref
*/
public SecurityRoleRefType> getOrCreateSecurityRoleRef();
/**
* Creates a new security-role-ref element
* @return the new created instance of SecurityRoleRefType>
*/
public SecurityRoleRefType> createSecurityRoleRef();
/**
* Returns all security-role-ref elements
* @return list of security-role-ref
*/
public List>> getAllSecurityRoleRef();
/**
* Removes all security-role-ref elements
* @return the current instance of SecurityRoleRefType>
*/
public PortletType removeAllSecurityRoleRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:event-definition-referenceType ElementType : supported-processing-event
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new supported-processing-event element will be created and returned.
* Otherwise, the first existing supported-processing-event element will be returned.
* @return the instance defined for the element supported-processing-event
*/
public EventDefinitionReferenceType> getOrCreateSupportedProcessingEvent();
/**
* Creates a new supported-processing-event element
* @return the new created instance of EventDefinitionReferenceType>
*/
public EventDefinitionReferenceType> createSupportedProcessingEvent();
/**
* Returns all supported-processing-event elements
* @return list of supported-processing-event
*/
public List>> getAllSupportedProcessingEvent();
/**
* Removes all supported-processing-event elements
* @return the current instance of EventDefinitionReferenceType>
*/
public PortletType removeAllSupportedProcessingEvent();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:event-definition-referenceType ElementType : supported-publishing-event
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new supported-publishing-event element will be created and returned.
* Otherwise, the first existing supported-publishing-event element will be returned.
* @return the instance defined for the element supported-publishing-event
*/
public EventDefinitionReferenceType> getOrCreateSupportedPublishingEvent();
/**
* Creates a new supported-publishing-event element
* @return the new created instance of EventDefinitionReferenceType>
*/
public EventDefinitionReferenceType> createSupportedPublishingEvent();
/**
* Returns all supported-publishing-event elements
* @return list of supported-publishing-event
*/
public List>> getAllSupportedPublishingEvent();
/**
* Removes all supported-publishing-event elements
* @return the current instance of EventDefinitionReferenceType>
*/
public PortletType removeAllSupportedPublishingEvent();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: string ElementType : supported-public-render-parameter
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing supported-public-render-parameter elements,
* a new supported-public-render-parameter element
* @param values list of supported-public-render-parameter objects
* @return the current instance of PortletType
*/
public PortletType supportedPublicRenderParameter(String ... values);
/**
* Returns all supported-public-render-parameter elements
* @return list of supported-public-render-parameter
*/
public List getAllSupportedPublicRenderParameter();
/**
* Removes the supported-public-render-parameter element
* @return the current instance of PortletType
*/
public PortletType removeAllSupportedPublicRenderParameter();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType ElementName: portlet:container-runtime-optionType ElementType : container-runtime-option
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new container-runtime-option element will be created and returned.
* Otherwise, the first existing container-runtime-option element will be returned.
* @return the instance defined for the element container-runtime-option
*/
public ContainerRuntimeOptionType> getOrCreateContainerRuntimeOption();
/**
* Creates a new container-runtime-option element
* @return the new created instance of ContainerRuntimeOptionType>
*/
public ContainerRuntimeOptionType> createContainerRuntimeOption();
/**
* Returns all container-runtime-option elements
* @return list of container-runtime-option
*/
public List>> getAllContainerRuntimeOption();
/**
* Removes all container-runtime-option elements
* @return the current instance of ContainerRuntimeOptionType>
*/
public PortletType removeAllContainerRuntimeOption();
// --------------------------------------------------------------------------------------------------------||
// ClassName: PortletType 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 PortletType
*/
public PortletType 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 PortletType
*/
public PortletType removeId();
}