org.jboss.shrinkwrap.descriptor.api.connector17.ConnectorDescriptor Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.connector17;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.connector17.LicenseType;
import org.jboss.shrinkwrap.descriptor.api.connector17.ResourceadapterType;
import org.jboss.shrinkwrap.descriptor.api.javaee7.IconType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.connector.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* ConnectorDescriptor descriptor = Descriptors.create(ConnectorDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface ConnectorDescriptor extends Descriptor, DescriptorNamespace,
ConnectorCommonDescriptor> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: false 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 ConnectorDescriptor
*/
public ConnectorDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: false 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 ConnectorDescriptor
*/
public ConnectorDescriptor 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 ConnectorDescriptor
*/
public ConnectorDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: false 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 ConnectorDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:token ElementType : module-name
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the module-name element
* @param moduleName the value for the element module-name
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor moduleName(String moduleName);
/**
* Returns the module-name element
* @return the node defined for the element module-name
*/
public String getModuleName();
/**
* Removes the module-name element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeModuleName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : vendor-name
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the vendor-name element
* @param vendorName the value for the element vendor-name
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor vendorName(String vendorName);
/**
* Returns the vendor-name element
* @return the node defined for the element vendor-name
*/
public String getVendorName();
/**
* Removes the vendor-name element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeVendorName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : eis-type
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the eis-type element
* @param eisType the value for the element eis-type
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor eisType(String eisType);
/**
* Returns the eis-type element
* @return the node defined for the element eis-type
*/
public String getEisType();
/**
* Removes the eis-type element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeEisType();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:string ElementType : resourceadapter-version
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the resourceadapter-version element
* @param resourceadapterVersion the value for the element resourceadapter-version
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor resourceadapterVersion(String resourceadapterVersion);
/**
* Returns the resourceadapter-version element
* @return the node defined for the element resourceadapter-version
*/
public String getResourceadapterVersion();
/**
* Removes the resourceadapter-version element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeResourceadapterVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: javaee:licenseType ElementType : license
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new license element with the given value will be created.
* Otherwise, the existing license element will be returned.
* @return a new or existing instance of LicenseType
*/
public LicenseType getOrCreateLicense();
/**
* Removes the license element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeLicense();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: javaee:resourceadapterType ElementType : resourceadapter
// MaxOccurs: - isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new resourceadapter element with the given value will be created.
* Otherwise, the existing resourceadapter element will be returned.
* @return a new or existing instance of ResourceadapterType
*/
public ResourceadapterType getOrCreateResourceadapter();
/**
* Removes the resourceadapter element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeResourceadapter();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:token ElementType : required-work-context
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing required-work-context elements,
* a new required-work-context element
* @param values list of required-work-context objects
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor requiredWorkContext(String ... values);
/**
* Returns all required-work-context elements
* @return list of required-work-context
*/
public List getAllRequiredWorkContext();
/**
* Removes the required-work-context element
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeAllRequiredWorkContext();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:token ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
public static final String VERSION = "1.7";
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public String getVersion();
/**
* Removes the version attribute
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:boolean ElementType : metadata-complete
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the metadata-complete attribute
* @param metadataComplete the value for the attribute metadata-complete
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor metadataComplete(Boolean metadataComplete);
/**
* Returns the metadata-complete attribute
* @return the value defined for the attribute metadata-complete
*/
public Boolean isMetadataComplete();
/**
* Removes the metadata-complete attribute
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor removeMetadataComplete();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ConnectorDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of ConnectorDescriptor
*/
public ConnectorDescriptor 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 ConnectorDescriptor
*/
public ConnectorDescriptor removeId();
}