com.helger.photon.basic.favorites

Interface IFavorite

All Superinterfaces:

com.helger.commons.name.IHasDisplayName, com.helger.commons.id.IHasID<String>, Serializable

All Known Implementing Classes:

Favorite

public interface IFavorite
extends com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayName, Serializable

Base interface for a single favorite bookmark.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.ext.ICommonsMap<String,String>	getAllAdditionalParams()
String	getApplicationID()
String	getMenuItemID()
String	getUserID()
boolean	hasSameContent(String sAppID, String sMenuItemID, com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams)

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID, getID

Methods inherited from interface com.helger.commons.name.IHasDisplayName

getComparatorCollating, getDisplayName

Method Detail

getUserID

@Nonnull
 @Nonempty
String getUserID()

Returns:

The ID of the user owning the favorite.

getApplicationID

@Nonnull
 @Nonempty
String getApplicationID()

Returns:

The internal application ID to which this favorite belongs.

getMenuItemID

@Nonnull
 @Nonempty
String getMenuItemID()

Returns:

The menu item to which this favorite bookmark points to.

getAllAdditionalParams

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.ext.ICommonsMap<String,String> getAllAdditionalParams()

Returns:

The additional optional parameters of this favorite. May be empty but never be null.

hasSameContent

boolean hasSameContent(@Nullable
                       String sAppID,
                       @Nullable
                       String sMenuItemID,
                       @Nullable
                       com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams)

Parameters:

sAppID - The application ID to compare to.

sMenuItemID - Menu item ID

aAdditionalParams - Additional params. May be null.

Returns:

true if the passed favourite has the same application ID, menuitem ID and additional params, false otherwise.