Module qilletni.api

Package dev.qilletni.api.lang.types

Interface CollectionType

All Superinterfaces:

AnyType, QilletniType

public non-sealed interface CollectionType
extends AnyType

Represents a collection type in Qilletni. This is essentially an abstracted playlist, or list of songs. This may be created by the "Collection Name" collection by "Creator Name" expression syntax.

Method Summary

Modifier and Type	Method	Description
CollectionDefinition	getCollectionDefinition()	Retrieves the current collection definition associated with the implementing object.
EntityType	getCreator(EntityDefinitionManager entityDefinitionManager)	Retrieves the creator as a User EntityType using the given entity definition manager.
CollectionOrder	getOrder()	Retrieves the current ordering of the collection when it is played.
Playlist	getPlaylist()	Gets the current Playlist instance associated with the current collection for the current service provider.
String	getSuppliedCreator()	Retrieves the supplied creator for a specific collection, if the creator's name was provided.
String	getSuppliedName()	Retrieves the supplied title for a specific collection, if the title was provided.
String	getSuppliedUrl()	Retrieves the supplied URL for a specific collection, if the URL was provided.
WeightsType	getWeights()	Gets the weights applied to the collection.
boolean	isSpotifyDataPopulated()	Checks whether service provider data has been successfully populated for the current instance.
void	populateSpotifyData(Playlist playlist)	Populates the music provider instance of the Playlist stored in the CollectionType.
void	setCollectionDefinition(CollectionDefinition collectionDefinition)	Sets the collection definition for the implementing object.
void	setOrder(CollectionOrder order)	Sets the ordering of the collection when it is played.
void	setWeights(WeightsType weights)	Sets the weights for the collection.

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

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

Method Details

getCollectionDefinition

CollectionDefinition getCollectionDefinition()

Retrieves the current collection definition associated with the implementing object. The collection definition determines how the collection data is classified or resolved, such as by URL, name and creator, prepopulated data, or a list of specific songs.

Returns:

The CollectionDefinition representing the current method of collection classification or resolution

setCollectionDefinition

void setCollectionDefinition(CollectionDefinition collectionDefinition)

Sets the collection definition for the implementing object. The collection definition determines how the collection data is classified or resolved, such as by URL, name and creator, prepopulated data, or a list of specific songs.

Parameters:

collectionDefinition - The CollectionDefinition representing the classification method to be set

getSuppliedUrl

String getSuppliedUrl()

Retrieves the supplied URL for a specific collection, if the URL was provided.

Returns:

A string representing the user-supplied URL

getSuppliedName

String getSuppliedName()

Retrieves the supplied title for a specific collection, if the title was provided.

Returns:

A string representing the user-supplied title

getSuppliedCreator

String getSuppliedCreator()

Retrieves the supplied creator for a specific collection, if the creator's name was provided.

Returns:

A string representing the user-supplied creator's name

getOrder

CollectionOrder getOrder()

Retrieves the current ordering of the collection when it is played. The order specifies how the collection items are arranged, such as in a sequential manner or shuffled.

Returns:

The CollectionOrder representing the current ordering of the collection

setOrder

void setOrder(CollectionOrder order)

Sets the ordering of the collection when it is played. The order specifies how the items in the collection are arranged, such as sequentially or shuffled.

Parameters:

order - The CollectionOrder to set for the collection

getWeights

WeightsType getWeights()

Gets the weights applied to the collection.

Returns:

The weights applied to the collection

setWeights

void setWeights(WeightsType weights)

Sets the weights for the collection.

Parameters:

weights - The WeightsType object to be associated with the collection

getCreator

EntityType getCreator(EntityDefinitionManager entityDefinitionManager)

Retrieves the creator as a User EntityType using the given entity definition manager. The creator is resolved using the provided EntityDefinitionManager.

Parameters:

entityDefinitionManager - The manager responsible for defining and resolving entity definitions

Returns:

The EntityType representing the creator resolved through the entity definition manager

getPlaylist

Playlist getPlaylist()

Gets the current Playlist instance associated with the current collection for the current service provider.

Returns:

An instance of Playlist backing the collection

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(Playlist playlist)

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

Parameters:

playlist - The Playlist instance to populate