Package com.foreach.across.modules.entity.web.links

Class SingleEntityViewLinkBuilder

java.lang.Object

com.foreach.across.modules.entity.web.links.EntityViewLinkBuilderSupport<SingleEntityViewLinkBuilder>

com.foreach.across.modules.entity.web.links.SingleEntityViewLinkBuilder

Direct Known Subclasses:

SingleEntityViewLinkBuilder.ForEntityAssociation, SingleEntityViewLinkBuilder.ForEntityConfiguration

public abstract class SingleEntityViewLinkBuilder
extends EntityViewLinkBuilderSupport<SingleEntityViewLinkBuilder>

Since:

3.0.0

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingleEntityViewLinkBuilder.ForEntityAssociation
static class	SingleEntityViewLinkBuilder.ForEntityConfiguration

Field Summary

Fields inherited from class com.foreach.across.modules.entity.web.links.EntityViewLinkBuilderSupport

links

Method Summary

Modifier and Type	Method	Description
abstract EntityViewLinkBuilder	association(@NonNull EntityConfiguration targetConfiguration)	Create a link builder for an association.
final EntityViewLinkBuilder	association(@NonNull Class<?> targetType)	Create a link builder for an association.
abstract SingleEntityViewLinkBuilder	association(Object target)	Create a link builder for an associated entity.
abstract EntityViewLinkBuilder	association(String associationName)	Create a link builder for an association.
SingleEntityViewLinkBuilder	deleteView()
SingleEntityViewLinkBuilder	updateView()

Methods inherited from class com.foreach.across.modules.entity.web.links.EntityViewLinkBuilderSupport

cloneLinkBuilder, root, slash, toString, toUri, toUriComponents, toUriComponentsBuilder, toUriString, withFromUrl, withPartial, withQueryParam, withViewName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

updateView

public SingleEntityViewLinkBuilder updateView()

Returns:

update view for the current instance

deleteView

public SingleEntityViewLinkBuilder deleteView()

Returns:

delete view for the current instance

association

public abstract EntityViewLinkBuilder association(String associationName)

Create a link builder for an association. If there is no actual EntityAssociation available, the name will be interpreted as a regular EntityConfiguration instead and a link builder with a from parameter will be returned to the target entity configuration.

Parameters:

associationName - name of the association

Returns:

new link builder

association

public final EntityViewLinkBuilder association(@NonNull
 @NonNull Class<?> targetType)

Create a link builder for an association. Will use the first non-hidden association for the target type. If there is more than one, you should use association(String) instead.

If there is no actual EntityAssociation available, the name will be interpreted as a regular EntityConfiguration instead and a link builder with a from parameter will be returned to the target entity configuration.

Parameters:

targetType - of the association

Returns:

new link builder

association

public abstract EntityViewLinkBuilder association(@NonNull
 @NonNull EntityConfiguration targetConfiguration)

Create a link builder for an association. Will use the first non-hidden association for the target configuration. If there is more than one, you should use association(String) instead.

If there is no actual EntityAssociation available, the name will be interpreted as a regular EntityConfiguration instead and a link builder with a from parameter will be returned to the target entity configuration.

Parameters:

targetConfiguration - of the association

Returns:

new link builder

association

public abstract SingleEntityViewLinkBuilder association(Object target)

Create a link builder for an associated entity. Will use the first non-hidden association for the target type. If there is more than one, you should use association(String).forInstance(Object) instead.

If there is no actual EntityAssociation available, the name will be interpreted as a regular EntityConfiguration instead and a link builder with a from parameter will be returned to the target entity configuration.

Parameters:

target - associated entity

Returns:

new link builder