org.jboss.shrinkwrap.descriptor.api.orm20.AssociationOverride Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.orm20;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.orm20.JoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm20.JoinTable;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmAssociationOverrideCommType;
import org.jboss.shrinkwrap.descriptor.api.orm20.JoinColumn;/**
* This interface defines the contract for the association-override
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface AssociationOverride extends Child,
OrmAssociationOverrideCommType,
JoinColumn>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: AssociationOverride 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 AssociationOverride
*/
public AssociationOverride 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 AssociationOverride
*/
public AssociationOverride removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: AssociationOverride ElementName: orm:join-column ElementType : join-column
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new join-column
element will be created and returned.
* Otherwise, the first existing join-column
element will be returned.
* @return the instance defined for the element join-column
*/
public JoinColumn> getOrCreateJoinColumn();
/**
* Creates a new join-column
element
* @return the new created instance of JoinColumn>
*/
public JoinColumn> createJoinColumn();
/**
* Returns all join-column
elements
* @return list of join-column
*/
public List>> getAllJoinColumn();
/**
* Removes all join-column
elements
* @return the current instance of JoinColumn>
*/
public AssociationOverride removeAllJoinColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: AssociationOverride ElementName: orm:join-table ElementType : join-table
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new join-table
element with the given value will be created.
* Otherwise, the existing join-table
element will be returned.
* @return a new or existing instance of JoinTable>
*/
public JoinTable> getOrCreateJoinTable();
/**
* Removes the join-table
element
* @return the current instance of AssociationOverride
*/
public AssociationOverride removeJoinTable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: AssociationOverride 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 AssociationOverride
*/
public AssociationOverride 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 AssociationOverride
*/
public AssociationOverride removeName();
}