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

Class EntityViewLinkBuilder

java.lang.Object

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

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

All Implemented Interfaces:

EntityLinkBuilder

Direct Known Subclasses:

EntityViewLinkBuilder.ForEntityAssociation, EntityViewLinkBuilder.ForEntityConfiguration

public abstract class EntityViewLinkBuilder
extends EntityViewLinkBuilderSupport<EntityViewLinkBuilder>
implements EntityLinkBuilder

Core link building entry point for an entity type. Implements the deprecated EntityLinkBuilder to ensure backwards compatibility.

Since:

3.0.0

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

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

Field Summary

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

links

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityViewLinkBuilder(org.springframework.web.util.UriComponentsBuilder uriComponents, EntityViewLinks links)

Method Summary

Modifier and Type	Method	Description
abstract EntityLinkBuilder	asAssociationFor(EntityLinkBuilder sourceLinkBuilder, Object sourceEntity)	Deprecated.
String	associations(Object entity)	Deprecated.
String	create()	Deprecated.
EntityViewLinkBuilderSupport	createView()
String	delete(Object entity)	Deprecated.
abstract SingleEntityViewLinkBuilder	forInstance(@NonNull Object entity)
EntityViewLinkBuilderSupport	listView()
String	overview()	Deprecated.
String	update(Object entity)	Deprecated.
String	view(Object entity)	Deprecated.
abstract SingleEntityViewLinkBuilder	withId(@NonNull Object id)

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

Constructor Details

EntityViewLinkBuilder

protected EntityViewLinkBuilder(org.springframework.web.util.UriComponentsBuilder uriComponents,
 EntityViewLinks links)

Method Details

listView

public EntityViewLinkBuilderSupport listView()

Returns:

default list view for the instance

createView

public EntityViewLinkBuilderSupport createView()

Returns:

create new instance view

overview

@Deprecated
public String overview()

Deprecated.

Specified by:

overview in interface EntityLinkBuilder

Returns:

link to the overview/list page

create

@Deprecated
public String create()

Deprecated.

Specified by:

create in interface EntityLinkBuilder

Returns:

link to create-new page

update

@Deprecated
public String update(Object entity)

Deprecated.

Specified by:

update in interface EntityLinkBuilder

Parameters:

entity - being updated

Returns:

link to update page for entity

delete

@Deprecated
public String delete(Object entity)

Deprecated.

Specified by:

delete in interface EntityLinkBuilder

Parameters:

entity - being deleted

Returns:

link to delete page for entity

view

@Deprecated
public String view(Object entity)

Deprecated.

Specified by:

view in interface EntityLinkBuilder

Parameters:

entity - being viewed

Returns:

link to view page for entity

associations

@Deprecated
public String associations(Object entity)

Deprecated.

Specified by:

associations in interface EntityLinkBuilder

Parameters:

entity - being viewed

Returns:

base link for associations

asAssociationFor

@Deprecated
public abstract EntityLinkBuilder asAssociationFor(EntityLinkBuilder sourceLinkBuilder,
 Object sourceEntity)

Deprecated.

Description copied from interface: EntityLinkBuilder

Creates a new link builder that represents the current linkbuilder as an association from a source entity, this will use EntityLinkBuilder.associations(Object) on the source link builder for prefixing the current link builder.

Specified by:

asAssociationFor in interface EntityLinkBuilder

forInstance

public abstract SingleEntityViewLinkBuilder forInstance(@NonNull
 @NonNull Object entity)

Parameters:

entity - of the entity that is the base of the uri path

Returns:

existing entity view

withId

public abstract SingleEntityViewLinkBuilder withId(@NonNull
 @NonNull Object id)

Parameters:

id - of the entity that is the base of the uri path

Returns:

existing entity view