org.jboss.shrinkwrap.descriptor.api.orm21.NamedStoredProcedureQuery Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.orm21;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm21.StoredProcedureParameter;
import org.jboss.shrinkwrap.descriptor.api.orm21.QueryHint;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmNamedStoredProcedureQueryCommType;
import org.jboss.shrinkwrap.descriptor.api.orm21.StoredProcedureParameter;
import org.jboss.shrinkwrap.descriptor.api.orm21.QueryHint;/**
* This interface defines the contract for the named-stored-procedure-query xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
*/
public interface NamedStoredProcedureQuery extends Child,
OrmNamedStoredProcedureQueryCommType,
StoredProcedureParameter>,
QueryHint>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: xsd:string ElementType : description
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the description element
* @param description the value for the element description
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery description(String description);
/**
* Returns the description element
* @return the node defined for the element description
*/
public String getDescription();
/**
* Removes the description element
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: orm:stored-procedure-parameter ElementType : parameter
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new parameter element will be created and returned.
* Otherwise, the first existing parameter element will be returned.
* @return the instance defined for the element parameter
*/
public StoredProcedureParameter> getOrCreateParameter();
/**
* Creates a new parameter element
* @return the new created instance of StoredProcedureParameter>
*/
public StoredProcedureParameter> createParameter();
/**
* Returns all parameter elements
* @return list of parameter
*/
public List>> getAllParameter();
/**
* Removes all parameter elements
* @return the current instance of StoredProcedureParameter>
*/
public NamedStoredProcedureQuery removeAllParameter();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: xsd:string ElementType : result-class
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing result-class elements,
* a new result-class element
* @param values list of result-class objects
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery resultClass(String ... values);
/**
* Returns all result-class elements
* @return list of result-class
*/
public List getAllResultClass();
/**
* Removes the result-class element
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery removeAllResultClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: xsd:string ElementType : result-set-mapping
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing result-set-mapping elements,
* a new result-set-mapping element
* @param values list of result-set-mapping objects
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery resultSetMapping(String ... values);
/**
* Returns all result-set-mapping elements
* @return list of result-set-mapping
*/
public List getAllResultSetMapping();
/**
* Removes the result-set-mapping element
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery removeAllResultSetMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: orm:query-hint ElementType : hint
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new hint element will be created and returned.
* Otherwise, the first existing hint element will be returned.
* @return the instance defined for the element hint
*/
public QueryHint> getOrCreateHint();
/**
* Creates a new hint element
* @return the new created instance of QueryHint>
*/
public QueryHint> createHint();
/**
* Returns all hint elements
* @return list of hint
*/
public List>> getAllHint();
/**
* Removes all hint elements
* @return the current instance of QueryHint>
*/
public NamedStoredProcedureQuery removeAllHint();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: xsd:string ElementType : name
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the name attribute
* @param name the value for the attribute name
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery name(String name);
/**
* Returns the name attribute
* @return the value defined for the attribute name
*/
public String getName();
/**
* Removes the name attribute
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: NamedStoredProcedureQuery ElementName: xsd:string ElementType : procedure-name
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the procedure-name attribute
* @param procedureName the value for the attribute procedure-name
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery procedureName(String procedureName);
/**
* Returns the procedure-name attribute
* @return the value defined for the attribute procedure-name
*/
public String getProcedureName();
/**
* Removes the procedure-name attribute
* @return the current instance of NamedStoredProcedureQuery
*/
public NamedStoredProcedureQuery removeProcedureName();
}