org.jboss.shrinkwrap.descriptor.api.orm20.ManyToOne 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.orm20.CascadeType;
import org.jboss.shrinkwrap.descriptor.api.orm20.FetchType;
import org.jboss.shrinkwrap.descriptor.api.orm20.AccessType;
import org.jboss.shrinkwrap.descriptor.api.orm.*;
import org.jboss.shrinkwrap.descriptor.api.orm.OrmManyToOneCommType;
import org.jboss.shrinkwrap.descriptor.api.orm20.JoinColumn;
import org.jboss.shrinkwrap.descriptor.api.orm20.JoinTable;
import org.jboss.shrinkwrap.descriptor.api.orm20.CascadeType;/**
* This interface defines the contract for the many-to-one xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface ManyToOne extends Child,
OrmManyToOneCommType,
JoinColumn>,
JoinTable>,
CascadeType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne 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 ManyToOne removeAllJoinColumn();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne 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 ManyToOne
*/
public ManyToOne removeJoinTable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: orm:cascade-type ElementType : cascade
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new cascade element with the given value will be created.
* Otherwise, the existing cascade element will be returned.
* @return a new or existing instance of CascadeType>
*/
public CascadeType> getOrCreateCascade();
/**
* Removes the cascade element
* @return the current instance of ManyToOne
*/
public ManyToOne removeCascade();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne 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 ManyToOne
*/
public ManyToOne 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 ManyToOne
*/
public ManyToOne removeName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: xsd:string ElementType : target-entity
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the target-entity attribute
* @param targetEntity the value for the attribute target-entity
* @return the current instance of ManyToOne
*/
public ManyToOne targetEntity(String targetEntity);
/**
* Returns the target-entity attribute
* @return the value defined for the attribute target-entity
*/
public String getTargetEntity();
/**
* Removes the target-entity attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeTargetEntity();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: orm:fetch-type ElementType : fetch
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the fetch attribute
* @param fetch the value for the attribute fetch
* @return the current instance of ManyToOne
*/
public ManyToOne fetch(FetchType fetch);
/**
* Sets the fetch attribute
* @param fetch the value for the attribute fetch
* @return the current instance of ManyToOne
*/
public ManyToOne fetch(String fetch);
/**
* Returns the fetch attribute
* @return the value defined for the attribute fetch
*/
public FetchType getFetch();
/**
* Returns the fetch attribute
* @return the value found for the element fetch
*/
public String getFetchAsString();
/**
* Removes the fetch attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeFetch();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: xsd:boolean ElementType : optional
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the optional attribute
* @param optional the value for the attribute optional
* @return the current instance of ManyToOne
*/
public ManyToOne optional(Boolean optional);
/**
* Returns the optional attribute
* @return the value defined for the attribute optional
*/
public Boolean isOptional();
/**
* Removes the optional attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeOptional();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: orm:access-type ElementType : access
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the access attribute
* @param access the value for the attribute access
* @return the current instance of ManyToOne
*/
public ManyToOne access(AccessType access);
/**
* Sets the access attribute
* @param access the value for the attribute access
* @return the current instance of ManyToOne
*/
public ManyToOne access(String access);
/**
* Returns the access attribute
* @return the value defined for the attribute access
*/
public AccessType getAccess();
/**
* Returns the access attribute
* @return the value found for the element access
*/
public String getAccessAsString();
/**
* Removes the access attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeAccess();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: xsd:string ElementType : maps-id
// MaxOccurs: - isGeneric: true isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the maps-id attribute
* @param mapsId the value for the attribute maps-id
* @return the current instance of ManyToOne
*/
public ManyToOne mapsId(String mapsId);
/**
* Returns the maps-id attribute
* @return the value defined for the attribute maps-id
*/
public String getMapsId();
/**
* Removes the maps-id attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeMapsId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ManyToOne ElementName: xsd:boolean 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 ManyToOne
*/
public ManyToOne id(Boolean id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public Boolean isId();
/**
* Removes the id attribute
* @return the current instance of ManyToOne
*/
public ManyToOne removeId();
}