Module qilletni.api

Package dev.qilletni.api.lang.types

Interface AlbumType

All Superinterfaces:

AnyType, QilletniType

public non-sealed interface AlbumType
extends AnyType

Represents an album type in Qilletni. This may be created by the "Album Name" album by "Artist Name" expression syntax. The internal service provider's type is dynamic, changing how the data is fetched when the service provider is changed.

Method Summary

Modifier and Type	Method	Description
Album	getAlbum()	Retrieves the current album instance associated with the implementing object for the current service provider.
AlbumDefinition	getAlbumDefinition()	Retrieves the current album definition associated with the implementing object.
EntityType	getArtist(EntityDefinitionManager entityDefinitionManager)	Retrieves the artist as an Artist EntityType for the given entity definition manager.
ListType	getArtists(EntityDefinitionManager entityDefinitionManager)	Retrieves a list of artists as a ListType, resolved using the given EntityDefinitionManager.
String	getSuppliedArtist()	Retrieves the supplied artist name for the album, if the artist was provided.
String	getSuppliedTitle()	Retrieves the supplied title for the album, if the title was provided.
String	getSuppliedUrl()	Retrieves the supplied URL for the album, if the URL was provided.
boolean	isSpotifyDataPopulated()	Checks whether service provider data has been successfully populated for the current instance.
void	populateSpotifyData(Album album)	Populates the music provider instance of the Album stored in the AlbumType.
void	setAlbumDefinition(AlbumDefinition albumDefinition)	Sets the album definition for the implementing object.

Methods inherited from interface dev.qilletni.api.lang.types.QilletniType

getTypeClass, minusOperator, minusOperatorInPlace, plusOperator, plusOperatorInPlace, qilletniEquals, stringValue, typeName

Method Details

getAlbumDefinition

AlbumDefinition getAlbumDefinition()

Retrieves the current album definition associated with the implementing object. The album definition determines the method by which album data is classified or resolved, such as by URL, title and artist, or prepopulated data.

Returns:

The AlbumDefinition representing the current album classification method

setAlbumDefinition

void setAlbumDefinition(AlbumDefinition albumDefinition)

Sets the album definition for the implementing object. The album definition determines how the album data is classified or resolved, such as by URL, title and artist, or prepopulated data.

Parameters:

albumDefinition - The AlbumDefinition representing the classification method to be set

getSuppliedUrl

String getSuppliedUrl()

Retrieves the supplied URL for the album, if the URL was provided.

Returns:

A string representing the user-supplied URL

getSuppliedTitle

String getSuppliedTitle()

Retrieves the supplied title for the album, if the title was provided.

Returns:

A string representing the user-supplied title

getSuppliedArtist

String getSuppliedArtist()

Retrieves the supplied artist name for the album, if the artist was provided.

Returns:

A string representing the user-supplied artist

getArtist

EntityType getArtist(EntityDefinitionManager entityDefinitionManager)

Retrieves the artist as an Artist EntityType for the given entity definition manager. The artist entity is resolved using the provided EntityDefinitionManager.

Parameters:

entityDefinitionManager - The manager responsible for defining and looking up entity definitions

Returns:

The EntityType representing the artist resolved through the entity definition manager

getArtists

ListType getArtists(EntityDefinitionManager entityDefinitionManager)

Retrieves a list of artists as a ListType, resolved using the given EntityDefinitionManager.

Parameters:

entityDefinitionManager - The manager responsible for defining and resolving entity definitions

Returns:

A ListType representing the artists resolved through the entity definition manager

getAlbum

Album getAlbum()

Retrieves the current album instance associated with the implementing object for the current service provider.

Returns:

An instance of the Album backing the album.

isSpotifyDataPopulated

boolean isSpotifyDataPopulated()

Checks whether service provider data has been successfully populated for the current instance.

Returns:

true if service provider data is populated, false otherwise

populateSpotifyData

void populateSpotifyData(Album album)

Populates the music provider instance of the Album stored in the AlbumType. This must be called before invoking methods that deal with the actual contents of the Album, such as getting artists.

Parameters:

album - The Album instance to populate