Package com.lariflix.jemm.reports
Class JellyfinReportInventoryItem
java.lang.Object
com.lariflix.jemm.dtos.JellyfinFolder
com.lariflix.jemm.reports.JellyfinReportInventoryItem
The JellyfinReportInventoryItem class extends the JellyfinFolder class and is used to represent an inventory item in a report.
This class contains the details of an inventory item, such as the name, the number of items in the category, and other relevant details.
It also contains a list of sub-items for the item, if any.
- Author:
- Cesar Bianchi
- See Also:
-
Field Summary
Fields inherited from class com.lariflix.jemm.dtos.JellyfinFolder
backdropImageTags, channelId, collectionType, communityRating, criticRating, folderContent, id, isFolder, locationType, metadata, name, officialRating, premiereDate, productionYear, serverId, type
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor for the JellyfinReportInventoryItem class. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves the genres property of this JellyfinReportInventoryItem.Retrieves the itemMetadata property of this JellyfinReportInventoryItem.Retrieves the subItems property of this JellyfinReportInventoryItem.getTags()
Retrieves the tags property of this JellyfinReportInventoryItem.int
Retrieves the totalsubItems property of this JellyfinReportInventoryItem.void
Sets the genres property of this JellyfinReportInventoryItem.void
Transforms a JellyfinFolder into a JellyfinReportInventoryItem.void
setItemMetadata
(JellyfinItemMetadata itemMetadata) Sets the itemMetadata property of this JellyfinReportInventoryItem.void
setSubItems
(JellyfinItems subItems) Transforms a JellyfinItems into a list of JellyfinReportInventorySubItem and sets it as the sub-items of this JellyfinReportInventoryItem.void
setSubItems
(ArrayList<JellyfinReportInventorySubItem> subItems) Sets the subItems property of this JellyfinReportInventoryItem.void
setTags()
Sets the tags property of this JellyfinReportInventoryItem.void
setTotalsubItems
(int totalsubItems) Sets the totalsubItems property of this JellyfinReportInventoryItem.Methods inherited from class com.lariflix.jemm.dtos.JellyfinFolder
getChannelId, getCollectionType, getCommunityRating, getCriticRating, getFolderContent, getFolderLevel, getId, getLocationType, getMetadata, getName, getOfficialRating, getPremiereDate, getProductionYear, getServerId, getType, IsFolder, mySetCommunityRating, mySetCriticRating, mySetPremiereDate, mySetProductionYear, setChannelId, setCollectionType, setCommunityRating, setCriticRating, setFolderContent, setFolderLevel, setId, setIsFolder, setLocationType, setMetadata, setName, setOfficialRating, setPremiereDate, setProductionYear, setServerId, setType
-
Constructor Details
-
JellyfinReportInventoryItem
public JellyfinReportInventoryItem()Constructor for the JellyfinReportInventoryItem class. This is a no-argument constructor that initializes a new instance of the JellyfinReportInventoryItem class. It doesn't perform any specific actions.- Since:
- 1.1
-
-
Method Details
-
getSubItems
Retrieves the subItems property of this JellyfinReportInventoryItem.- Returns:
- An ArrayList of JellyfinReportInventorySubItem objects representing the sub-items of this JellyfinReportInventoryItem.
- Since:
- 1.1
-
setSubItems
Sets the subItems property of this JellyfinReportInventoryItem.- Parameters:
subItems
- An ArrayList of JellyfinReportInventorySubItem objects that should be used as the new sub-items for this JellyfinReportInventoryItem.- Since:
- 1.1
-
getTotalsubItems
public int getTotalsubItems()Retrieves the totalsubItems property of this JellyfinReportInventoryItem.- Returns:
- An integer representing the total number of sub-items of this JellyfinReportInventoryItem.
- Since:
- 1.1
-
setTotalsubItems
public void setTotalsubItems(int totalsubItems) Sets the totalsubItems property of this JellyfinReportInventoryItem.- Parameters:
totalsubItems
- An integer that should be used as the new total number of sub-items for this JellyfinReportInventoryItem.- Since:
- 1.1
-
setItemMetadata
Sets the itemMetadata property of this JellyfinReportInventoryItem. This method also sets the genres and tags properties based on the given itemMetadata.- Parameters:
itemMetadata
- A JellyfinItemMetadata object that should be used as the new metadata for this JellyfinReportInventoryItem. This includes the name, server ID, ID, channel ID, type, location type, premiere date, critic rating, official rating, and community rating.- Since:
- 1.1
-
getItemMetadata
Retrieves the itemMetadata property of this JellyfinReportInventoryItem.- Returns:
- A JellyfinItemMetadata object representing the metadata of this JellyfinReportInventoryItem. This includes the name, server ID, ID, channel ID, type, location type, premiere date, critic rating, official rating, and community rating.
- Since:
- 1.1
-
getGenres
Retrieves the genres property of this JellyfinReportInventoryItem.- Returns:
- A String representing the genres of this JellyfinReportInventoryItem. The genres are returned as a comma-separated list.
- Since:
- 1.1
-
setGenres
public void setGenres()Sets the genres property of this JellyfinReportInventoryItem. This method retrieves the genre names from the itemMetadata property and concatenates them into a comma-separated list. This list is then used as the new genres for this JellyfinReportInventoryItem.- Since:
- 1.1
-
getTags
Retrieves the tags property of this JellyfinReportInventoryItem.- Returns:
- A String representing the tags of this JellyfinReportInventoryItem. The tags are returned as a comma-separated list.
- Since:
- 1.1
-
setTags
public void setTags()Sets the tags property of this JellyfinReportInventoryItem. This method retrieves the tags from the itemMetadata property and concatenates them into a comma-separated list. This list is then used as the new tags for this JellyfinReportInventoryItem.- Since:
- 1.1
-
setItem
Transforms a JellyfinFolder into a JellyfinReportInventoryItem. This method sets the properties of this JellyfinReportInventoryItem based on the given JellyfinFolder. This includes the channel ID, collection type, community rating, critic rating, folder content, ID, whether it is a folder, location type, metadata, name, official rating, premiere date, production year, server ID, and type.- Parameters:
it
- A JellyfinFolder object that should be transformed into a JellyfinReportInventoryItem.- Since:
- 1.1
-
setSubItems
Transforms a JellyfinItems into a list of JellyfinReportInventorySubItem and sets it as the sub-items of this JellyfinReportInventoryItem. This method creates a new JellyfinReportInventorySubItem for each item in the given JellyfinItems, sets the sub-item of the JellyfinReportInventorySubItem to the item, and adds the JellyfinReportInventorySubItem to a list. This list is then used as the new sub-items for this JellyfinReportInventoryItem. The method also sets the total number of sub-items to the size of the list.- Parameters:
subItems
- A JellyfinItems object that should be transformed into a list of JellyfinReportInventorySubItem.- Since:
- 1.0
-