org.jboss.shrinkwrap.descriptor.api.javaeewebservicesclient13.HandlerType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.javaeewebservicesclient13;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ParamValueType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.IconType;
/**
* This interface defines the contract for the handlerType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface HandlerType extends Child {
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd: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 HandlerType
*/
public HandlerType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of HandlerType
*/
public HandlerType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:token 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 HandlerType
*/
public HandlerType 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 HandlerType
*/
public HandlerType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType> getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType>
*/
public IconType> createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List>> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType>
*/
public HandlerType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:token ElementType : handler-name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the handler-name element
* @param handlerName the value for the element handler-name
* @return the current instance of HandlerType
*/
public HandlerType handlerName(String handlerName);
/**
* Returns the handler-name element
* @return the node defined for the element handler-name
*/
public String getHandlerName();
/**
* Removes the handler-name element
* @return the current instance of HandlerType
*/
public HandlerType removeHandlerName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:token ElementType : handler-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the handler-class element
* @param handlerClass the value for the element handler-class
* @return the current instance of HandlerType
*/
public HandlerType handlerClass(String handlerClass);
/**
* Returns the handler-class element
* @return the node defined for the element handler-class
*/
public String getHandlerClass();
/**
* Removes the handler-class element
* @return the current instance of HandlerType
*/
public HandlerType removeHandlerClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: javaee:param-valueType 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 ParamValueType> getOrCreateInitParam();
/**
* Creates a new init-param element
* @return the new created instance of ParamValueType>
*/
public ParamValueType> createInitParam();
/**
* Returns all init-param elements
* @return list of init-param
*/
public List>> getAllInitParam();
/**
* Removes all init-param elements
* @return the current instance of ParamValueType>
*/
public HandlerType removeAllInitParam();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:QName ElementType : soap-header
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing soap-header elements,
* a new soap-header element
* @param values list of soap-header objects
* @return the current instance of HandlerType
*/
public HandlerType soapHeader(String ... values);
/**
* Returns all soap-header elements
* @return list of soap-header
*/
public List getAllSoapHeader();
/**
* Removes the soap-header element
* @return the current instance of HandlerType
*/
public HandlerType removeAllSoapHeader();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:token ElementType : soap-role
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing soap-role elements,
* a new soap-role element
* @param values list of soap-role objects
* @return the current instance of HandlerType
*/
public HandlerType soapRole(String ... values);
/**
* Returns all soap-role elements
* @return list of soap-role
*/
public List getAllSoapRole();
/**
* Removes the soap-role element
* @return the current instance of HandlerType
*/
public HandlerType removeAllSoapRole();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:token ElementType : port-name
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing port-name elements,
* a new port-name element
* @param values list of port-name objects
* @return the current instance of HandlerType
*/
public HandlerType portName(String ... values);
/**
* Returns all port-name elements
* @return list of port-name
*/
public List getAllPortName();
/**
* Removes the port-name element
* @return the current instance of HandlerType
*/
public HandlerType removeAllPortName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: HandlerType ElementName: xsd:ID 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 HandlerType
*/
public HandlerType 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 HandlerType
*/
public HandlerType removeId();
}