com.helger.photon.basic.favorites

Class Favorite

java.lang.Object

com.helger.photon.basic.favorites.Favorite

All Implemented Interfaces:

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

@NotThreadSafe
public class Favorite
extends Object
implements IFavorite

Default implementation of favourites for bookmarks.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static com.helger.commons.type.ObjectType	OT_FAVOURITE

Constructor Summary

Constructors

Constructor and Description
Favorite(String sUserID, String sApplicationID, String sMenuItemID, String sDisplayName, Map<String,String> aAdditionalParams)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAdditionalParams()
String	getApplicationID()
String	getDisplayName()
String	getID()
String	getMenuItemID()
String	getUserID()
boolean	hasSameContent(String sAppID, String sMenuItemID, Map<String,String> aAdditionalParams)
com.helger.commons.state.EChange	setDisplayName(String sDisplayName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OT_FAVOURITE

public static final com.helger.commons.type.ObjectType OT_FAVOURITE

Constructor Detail

Favorite

public Favorite(@Nonnull@Nonempty
        String sUserID,
        @Nonnull@Nonempty
        String sApplicationID,
        @Nonnull@Nonempty
        String sMenuItemID,
        @Nonnull@Nonempty
        String sDisplayName,
        @Nullable
        Map<String,String> aAdditionalParams)

Method Detail

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getUserID

@Nonnull
@Nonempty
public String getUserID()

Specified by:

getUserID in interface IFavorite

Returns:

The ID of the user owning the favorite.

getApplicationID

@Nonnull
@Nonempty
public String getApplicationID()

Specified by:

getApplicationID in interface IFavorite

Returns:

The internal application ID to which this favorite belongs.

getMenuItemID

@Nonnull
@Nonempty
public String getMenuItemID()

Specified by:

getMenuItemID in interface IFavorite

Returns:

The menu item to which this favorite bookmark points to.

getDisplayName

@Nonnull
@Nonempty
public String getDisplayName()

Specified by:

getDisplayName in interface com.helger.commons.name.IHasDisplayName

setDisplayName

@Nonnull
public com.helger.commons.state.EChange setDisplayName(@Nonnull@Nonempty
                                                      String sDisplayName)

getAdditionalParams

@Nonnull
@ReturnsMutableCopy
public Map<String,String> getAdditionalParams()

Specified by:

getAdditionalParams in interface IFavorite

Returns:

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

hasSameContent

public boolean hasSameContent(@Nullable
                     String sAppID,
                     @Nullable
                     String sMenuItemID,
                     @Nullable
                     Map<String,String> aAdditionalParams)

Specified by:

hasSameContent in interface IFavorite

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.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object