de.hybris.platform.cockpit.daos

Interface CockpitObjectAbstractCollectionDao

All Superinterfaces:

Dao

All Known Implementing Classes:

DefaultCockpitObjectAbstractCollectionDao

public interface CockpitObjectAbstractCollectionDao
extends Dao

Method Summary

Modifier and Type	Method and Description
boolean	collectionContains(CockpitObjectAbstractCollectionModel collection, ItemModel item) Returns true if the collection contains at least one element with the given item, false otherwise.
java.util.List<CockpitObjectCollectionModel>	findCollectionsByUser(UserModel user) Returns all collections that belongs to the specified user.
java.util.List<ObjectCollectionItemReferenceModel>	findElements(CockpitObjectAbstractCollectionModel collection, int start, int count) Finds elements of the given object collection.
java.util.List<ObjectCollectionItemReferenceModel>	findElementsContainingItem(CockpitObjectAbstractCollectionModel collection, ItemModel item) Returns all elements of the collection that contain given item.
java.util.List<CockpitObjectAbstractCollectionModel>	findGlobalCollections() Gets the global collections that is collections that have no user set.
java.util.List<CockpitObjectCollectionModel>	findReadableCollectionsByUser(UserModel userModel) Gets the readable collections for user.
java.util.List<CockpitObjectSpecialCollectionModel>	findSpecialCollections(UserModel user, CockpitSpecialCollectionType collectionType) Returns all special collections af the specified type that belongs to the specified type.
java.util.List<CockpitObjectSpecialCollectionModel>	findSpecialCollectionsByUser(UserModel user) Returns all special collections af any type that belongs to the specified user.
java.util.List<CockpitObjectCollectionModel>	findWritableCollectionsByUser(UserModel userModel) Gets the writable collections for user.
java.util.List<CockpitObjectCollectionModel>	getCollectionsByUser(UserModel user) Deprecated. since 6.3, use findCollectionsByUser(UserModel) instead
int	getElementCount(CockpitObjectAbstractCollectionModel collection) Return total count of elements in the collection.
java.util.List<ObjectCollectionItemReferenceModel>	getElementsContainingItem(CockpitObjectAbstractCollectionModel collection, ItemModel item) Deprecated. since 6.3, use findElementsContainingItem(CockpitObjectAbstractCollectionModel, ItemModel) instead
java.util.List<CockpitObjectAbstractCollectionModel>	getGlobalCollections() Deprecated. since 6.3, use findGlobalCollections() instead
java.util.List<CockpitObjectCollectionModel>	getReadableCollectionsForUser(UserModel userModel) Deprecated. since 6.3, use findReadableCollectionsByUser(UserModel) instead
java.util.List<CockpitObjectSpecialCollectionModel>	getSpecialCollections(UserModel user, CockpitSpecialCollectionType collectionType) Deprecated. since 6.3, use findSpecialCollections(UserModel, CockpitSpecialCollectionType) instead
java.util.List<CockpitObjectSpecialCollectionModel>	getSpecialCollectionsByUser(UserModel user) Deprecated. since 6.3, use findSpecialCollectionsByUser(UserModel) instead
java.util.List<CockpitObjectCollectionModel>	getWritableCollectionsForUser(UserModel userModel) Deprecated. since 6.3, use findWritableCollectionsByUser(UserModel) instead

Method Detail

findElements

java.util.List<ObjectCollectionItemReferenceModel> findElements(CockpitObjectAbstractCollectionModel collection,
                                                                int start,
                                                                int count)

Finds elements of the given object collection.

Parameters:

collection - the object collection to search elements of

start - starting index of the search

count - max. count of elements to be found

Returns:

elements of the given object collection according to given offset and count

getElementCount

int getElementCount(CockpitObjectAbstractCollectionModel collection)

Return total count of elements in the collection.

Returns:

total count of elements in the collection

getElementsContainingItem

@Deprecated
java.util.List<ObjectCollectionItemReferenceModel> getElementsContainingItem(CockpitObjectAbstractCollectionModel collection,
                                                                                         ItemModel item)

Deprecated. since 6.3, use findElementsContainingItem(CockpitObjectAbstractCollectionModel, ItemModel) instead

Returns all elements of the collection that contain given item.

Parameters:

collection - the collection to search in

item - the item to search for

Returns:

all elements of the collection that contain given item

findElementsContainingItem

java.util.List<ObjectCollectionItemReferenceModel> findElementsContainingItem(CockpitObjectAbstractCollectionModel collection,
                                                                              ItemModel item)

Returns all elements of the collection that contain given item.

Parameters:

collection - the collection to search in

item - the item to search for

Returns:

all elements of the collection that contain given item

collectionContains

boolean collectionContains(CockpitObjectAbstractCollectionModel collection,
                           ItemModel item)

Returns true if the collection contains at least one element with the given item, false otherwise.

Parameters:

collection - the collection to search in

item - the item to search for

Returns:

true if the collection contains at least one element with the given item, false otherwise

getCollectionsByUser

@Deprecated
java.util.List<CockpitObjectCollectionModel> getCollectionsByUser(UserModel user)

Deprecated. since 6.3, use findCollectionsByUser(UserModel) instead

Returns all collections that belongs to the specified user.

Parameters:

user - the user we look collections

Returns:

the collections by user

findCollectionsByUser

java.util.List<CockpitObjectCollectionModel> findCollectionsByUser(UserModel user)

Returns all collections that belongs to the specified user.

Parameters:

user - the user we look collections

Returns:

the collections by user

getSpecialCollectionsByUser

@Deprecated
java.util.List<CockpitObjectSpecialCollectionModel> getSpecialCollectionsByUser(UserModel user)

Deprecated. since 6.3, use findSpecialCollectionsByUser(UserModel) instead

Returns all special collections af any type that belongs to the specified user.

Parameters:

user - the user we look collections

Returns:

the special collections by user

findSpecialCollectionsByUser

java.util.List<CockpitObjectSpecialCollectionModel> findSpecialCollectionsByUser(UserModel user)

Returns all special collections af any type that belongs to the specified user.

Parameters:

user - the user we look collections

Returns:

the special collections by user

getSpecialCollections

@Deprecated
java.util.List<CockpitObjectSpecialCollectionModel> getSpecialCollections(UserModel user,
                                                                                      CockpitSpecialCollectionType collectionType)

Deprecated. since 6.3, use findSpecialCollections(UserModel, CockpitSpecialCollectionType) instead

Returns all special collections af the specified type that belongs to the specified type.

Parameters:

user - the user we look collections

collectionType - the collection type we look for

Returns:

the special collections

findSpecialCollections

java.util.List<CockpitObjectSpecialCollectionModel> findSpecialCollections(UserModel user,
                                                                           CockpitSpecialCollectionType collectionType)

Returns all special collections af the specified type that belongs to the specified type.

Parameters:

user - the user we look collections

collectionType - the collection type we look for

Returns:

the special collections

getGlobalCollections

@Deprecated
java.util.List<CockpitObjectAbstractCollectionModel> getGlobalCollections()

Deprecated. since 6.3, use findGlobalCollections() instead

Gets the global collections that is collections that have no user set.

Returns:

the global collections

findGlobalCollections

java.util.List<CockpitObjectAbstractCollectionModel> findGlobalCollections()

Gets the global collections that is collections that have no user set.

Returns:

the global collections

getReadableCollectionsForUser

@Deprecated
java.util.List<CockpitObjectCollectionModel> getReadableCollectionsForUser(UserModel userModel)

Deprecated. since 6.3, use findReadableCollectionsByUser(UserModel) instead

Gets the readable collections for user.

Parameters:

userModel - the user model

Returns:

the readable collections for user

findReadableCollectionsByUser

java.util.List<CockpitObjectCollectionModel> findReadableCollectionsByUser(UserModel userModel)

Gets the readable collections for user.

Parameters:

userModel - the user model

Returns:

the readable collections for user

getWritableCollectionsForUser

@Deprecated
java.util.List<CockpitObjectCollectionModel> getWritableCollectionsForUser(UserModel userModel)

Deprecated. since 6.3, use findWritableCollectionsByUser(UserModel) instead

Gets the writable collections for user.

Parameters:

userModel - the user model

Returns:

the writable collections for user

findWritableCollectionsByUser

java.util.List<CockpitObjectCollectionModel> findWritableCollectionsByUser(UserModel userModel)

Gets the writable collections for user.

Parameters:

userModel - the user model

Returns:

the writable collections for user