org.jboss.shrinkwrap.descriptor.api.orm20

Interface EmbeddedId<T>

All Superinterfaces:

Child<T>, OrmEmbeddedIdCommType<T,EmbeddedId<T>,AttributeOverride<EmbeddedId<T>>>

public interface EmbeddedId<T>
extends Child<T>, OrmEmbeddedIdCommType<T,EmbeddedId<T>,AttributeOverride<EmbeddedId<T>>>

This interface defines the contract for the embedded-id xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
EmbeddedId<T>	access(AccessType access) Sets the access attribute
EmbeddedId<T>	access(String access) Sets the access attribute
AttributeOverride<EmbeddedId<T>>	createAttributeOverride() Creates a new attribute-override element
AccessType	getAccess() Returns the access attribute
String	getAccessAsString() Returns the access attribute
List<AttributeOverride<EmbeddedId<T>>>	getAllAttributeOverride() Returns all attribute-override elements
String	getName() Returns the name attribute
AttributeOverride<EmbeddedId<T>>	getOrCreateAttributeOverride() If not already created, a new attribute-override element will be created and returned.
EmbeddedId<T>	name(String name) Sets the name attribute
EmbeddedId<T>	removeAccess() Removes the access attribute
EmbeddedId<T>	removeAllAttributeOverride() Removes all attribute-override elements
EmbeddedId<T>	removeName() Removes the name attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

getOrCreateAttributeOverride

AttributeOverride<EmbeddedId<T>> getOrCreateAttributeOverride()

If not already created, a new attribute-override element will be created and returned. Otherwise, the first existing attribute-override element will be returned.

Returns:

the instance defined for the element attribute-override

createAttributeOverride

AttributeOverride<EmbeddedId<T>> createAttributeOverride()

Creates a new attribute-override element

Returns:

the new created instance of AttributeOverride>

getAllAttributeOverride

List<AttributeOverride<EmbeddedId<T>>> getAllAttributeOverride()

Returns all attribute-override elements

Returns:

list of attribute-override

removeAllAttributeOverride

EmbeddedId<T> removeAllAttributeOverride()

Removes all attribute-override elements

Returns:

the current instance of AttributeOverride>

name

EmbeddedId<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of EmbeddedId

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

EmbeddedId<T> removeName()

Removes the name attribute

Returns:

the current instance of EmbeddedId

access

EmbeddedId<T> access(AccessType access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of EmbeddedId

access

EmbeddedId<T> access(String access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of EmbeddedId

getAccess

AccessType getAccess()

Returns the access attribute

Returns:

the value defined for the attribute access

getAccessAsString

String getAccessAsString()

Returns the access attribute

Returns:

the value found for the element access

removeAccess

EmbeddedId<T> removeAccess()

Removes the access attribute

Returns:

the current instance of EmbeddedId