org.unitedinternet.cosmo.service

Interface ContentService

All Superinterfaces:

Service

public interface ContentService
extends Service

Interface for services that manage access to user content.

Method Summary

Modifier and Type	Method and Description
void	addItemToCollection(Item item, CollectionItem collection) Add an item to a collection.
void	copyItem(Item item, CollectionItem targetParent, String path, boolean deepCopy) Copy an item to the given path
void	createBatchContentItems(CollectionItem parent, Set<ContentItem> contentItems) Create new content items in a parent collection.
CollectionItem	createCollection(CollectionItem parent, CollectionItem collection) Create a new collection.
CollectionItem	createCollection(CollectionItem parent, CollectionItem collection, Set<Item> children) Create a new collection with an initial set of items.
ContentItem	createContent(CollectionItem parent, ContentItem content) Create new content item.
void	createContentItems(CollectionItem parent, Set<ContentItem> contentItems) Create new content items in a parent collection.
void	createTicket(Item item, Ticket ticket) Creates a ticket on an item.
void	createTicket(String path, Ticket ticket) Creates a ticket on an item.
Set<CollectionItem>	findCollectionItems(CollectionItem collectionItem) find the set of collection items as children of the given collection item.
Item	findItemByPath(String path) Find content item by path.
Item	findItemByPath(String path, String parentUid) Find content item by path relative to the identified parent item.
Item	findItemByUid(String uid) Find an item with the specified uid.
Item	findItemParentByPath(String path) Find content item's parent by path.
Set<Item>	findItems(ItemFilter filter) Find items by filter.
SortedSet<NoteItem>	findNotesByTriageStatus(CollectionItem collection, TriageStatusQueryContext context) Find note items by triage status that belong to a collection.
SortedSet<NoteItem>	findNotesByTriageStatus(NoteItem note, TriageStatusQueryContext context) Find note items by triage status that belong to a recurring note series.
<STAMP_TYPE extends Stamp> STAMP_TYPE	findStampByInternalItemUid(String internalItemUid, Class<STAMP_TYPE> clazz) Searches for an item stamp by item uid.
HomeCollectionItem	getRootItem(User user) Get the root item for a user
HomeCollectionItem	getRootItem(User user, boolean forceReload) Get the root item for a user
Ticket	getTicket(Item item, String key)
Set<ContentItem>	loadChildren(CollectionItem collection, Date timestamp) Load all children for collection that have been updated since a given timestamp.
void	moveItem(Item item, CollectionItem oldParent, CollectionItem newParent) Move item from one collection to another
void	removeBatchContentItems(CollectionItem parent, Set<ContentItem> contentItems) remove existing content items in a parent collection.
void	removeCollection(CollectionItem collection) Remove collection item
void	removeContent(ContentItem content) Remove content item
void	removeItem(Item item) Remove an item.
void	removeItemFromCollection(Item item, CollectionItem collection) Remove an item from a collection.
void	removeItemsFromCollection(CollectionItem collection) Remove items from a collection.
void	removeTicket(Item item, String key) Removes a ticket from an item.
void	removeTicket(Item item, Ticket ticket) Removes a ticket from an item.
void	updateBatchContentItems(CollectionItem parent, Set<ContentItem> contentItems) updates existing content items in a parent collection.
CollectionItem	updateCollection(CollectionItem collection) Update collection item
CollectionItem	updateCollection(CollectionItem collection, Set<Item> children) Update a collection and set child items.
void	updateCollectionTimestamp(CollectionItem parent)
ContentItem	updateContent(ContentItem content) Update an existing content item.
void	updateContentItems(CollectionItem parent, Set<ContentItem> contentItems) Update content items.

Methods inherited from interface org.unitedinternet.cosmo.service.Service

destroy, init

Method Detail

getRootItem

HomeCollectionItem getRootItem(User user)

Get the root item for a user

Parameters:

user - The givern user.

Returns:

The root item for a user.

getRootItem

HomeCollectionItem getRootItem(User user,
                               boolean forceReload)

Get the root item for a user

Parameters:

user - The givern user.

forceReload - if true, cleans hibernate session before loading.

Returns:

The root item for a user.

findStampByInternalItemUid

<STAMP_TYPE extends Stamp> STAMP_TYPE findStampByInternalItemUid(String internalItemUid,
                                                                 Class<STAMP_TYPE> clazz)

Searches for an item stamp by item uid. The implementation will hit directly the the DB.

Parameters:

internalItemUid - item internal uid

clazz - stamp type

Returns:

the item's stamp from the db

findItemByUid

Item findItemByUid(String uid)

Find an item with the specified uid. The return type will be one of ContentItem, CollectionItem, CalendarCollectionItem, CalendarItem.

Parameters:

uid - uid of item to find

Returns:

item represented by uid

findItemByPath

Item findItemByPath(String path)

Find content item by path. Path is of the format: /username/parent1/parent2/itemname.

Parameters:

path - The given path.

Returns:

The content item.

findItemByPath

Item findItemByPath(String path,
                    String parentUid)

Find content item by path relative to the identified parent item.

Parameters:

path - The pathe relative.

parentUid - Identified parent item.

Returns:

The content item,.

findItemParentByPath

Item findItemParentByPath(String path)

Find content item's parent by path. Path is of the format: /username/parent1/parent2/itemname.

Parameters:

path - The given path.

Returns:

In this example, the item at /username/parent1/parent2 would be returned.

addItemToCollection

void addItemToCollection(Item item,
                         CollectionItem collection)

Add an item to a collection.

Parameters:

item - item to add to collection

collection - collection to add item to

copyItem

void copyItem(Item item,
              CollectionItem targetParent,
              String path,
              boolean deepCopy)

Copy an item to the given path

Parameters:

item - item to copy

targetParent - existing source collection

path - path to copy item to

deepCopy - true for deep copy, else shallow copy will be performed

Throws:

org.osaf.cosmo.dao.hibernate.ItemNotFoundException - if parent item specified by path does not exist

org.osaf.cosmo.dao.hibernate.DuplicateItemNameException - if path points to an item with the same path

moveItem

void moveItem(Item item,
              CollectionItem oldParent,
              CollectionItem newParent)

Move item from one collection to another

Parameters:

item - item to move

oldParent - parent to remove item from

newParent - parent to add item to

removeItem

void removeItem(Item item)

Remove an item. Removes item from all collections.

Parameters:

item - item to remove

removeItemFromCollection

void removeItemFromCollection(Item item,
                              CollectionItem collection)

Remove an item from a collection. The item will be removed if it belongs to no more collections.

Parameters:

item - item to remove from collection

collection - item to remove item from

loadChildren

Set<ContentItem> loadChildren(CollectionItem collection,
                              Date timestamp)

Load all children for collection that have been updated since a given timestamp. If no timestamp is specified, then return all children.

Parameters:

collection - collection

timestamp - timestamp

Returns:

children of collection that have been updated since timestamp, or all children if timestamp is null

createCollection

CollectionItem createCollection(CollectionItem parent,
                                CollectionItem collection)

Create a new collection.

Parameters:

parent - parent of collection.

collection - collection to create

Returns:

newly created collection

createCollection

CollectionItem createCollection(CollectionItem parent,
                                CollectionItem collection,
                                Set<Item> children)

Create a new collection with an initial set of items. The initial set of items can include new items and existing items. New items will be created and associated to the new collection and existing items will be updated and associated to the new collection.

Parameters:

parent - parent of collection.

collection - collection to create

children - collection children

Returns:

newly created collection

updateCollection

CollectionItem updateCollection(CollectionItem collection,
                                Set<Item> children)

Update a collection and set child items. The set of child items to be updated can include updates to existing children, new children, and removed children. A removal of a child Item is accomplished by setting Item.isActive to false for an existing Item. When an item is marked for removal, it is removed from the collection and removed from the server only if the item has no parent collections.

Parameters:

collection - collection to update

children - children to update

Returns:

updated collection

removeCollection

void removeCollection(CollectionItem collection)

Remove collection item

Parameters:

collection - collection item to remove

updateCollection

CollectionItem updateCollection(CollectionItem collection)

Update collection item

Parameters:

collection - collection item to update

Returns:

updated collection

createContent

ContentItem createContent(CollectionItem parent,
                          ContentItem content)

Create new content item. A content item represents a piece of content or file.

Parameters:

parent - parent collection of content. If null, content is assumed to live in the top-level user collection

content - content to create

Returns:

newly created content

createContentItems

void createContentItems(CollectionItem parent,
                        Set<ContentItem> contentItems)

Create new content items in a parent collection.

Parameters:

parent - parent collection of content items.

contentItems - content items to create

Throws:

org.osaf.cosmo.model.CollectionLockedException - if parent CollectionItem is locked

updateCollectionTimestamp

void updateCollectionTimestamp(CollectionItem parent)

Parameters:

parent - parent collection of content items.

createBatchContentItems

void createBatchContentItems(CollectionItem parent,
                             Set<ContentItem> contentItems)

Create new content items in a parent collection.

Parameters:

parent - parent collection of content items.

contentItems - content items to create

Throws:

org.osaf.cosmo.model.CollectionLockedException - if parent CollectionItem is locked

updateBatchContentItems

void updateBatchContentItems(CollectionItem parent,
                             Set<ContentItem> contentItems)

updates existing content items in a parent collection.

Parameters:

parent - parent collection of content items.

contentItems - content items to update

Throws:

org.osaf.cosmo.model.CollectionLockedException - if parent CollectionItem is locked

removeBatchContentItems

void removeBatchContentItems(CollectionItem parent,
                             Set<ContentItem> contentItems)

remove existing content items in a parent collection.

Parameters:

parent - parent collection of content items.

contentItems - content items to remove

Throws:

org.osaf.cosmo.model.CollectionLockedException - if parent CollectionItem is locked

updateContentItems

void updateContentItems(CollectionItem parent,
                        Set<ContentItem> contentItems)

Update content items. This includes creating new items, removing existing items, and updating existing items. ContentItem deletion is represented by setting ContentItem.isActive to false. ContentItem deletion removes item from system, not just from the parent collections. ContentItem creation adds the item to the specified parent collections.

Parameters:

parent - parent that new content items will be added to.

contentItems - to update

Throws:

org.osaf.cosmo.model.CollectionLockedException - if parent CollectionItem is locked

updateContent

ContentItem updateContent(ContentItem content)

Update an existing content item.

Parameters:

content - content item to update

Returns:

updated content item

removeContent

void removeContent(ContentItem content)

Remove content item

Parameters:

content - content item to remove

findCollectionItems

Set<CollectionItem> findCollectionItems(CollectionItem collectionItem)

find the set of collection items as children of the given collection item.

Parameters:

collectionItem - parent collection item

Returns:

set of children collection items or empty list of parent collection has no children

findItems

Set<Item> findItems(ItemFilter filter)

Find items by filter.

Parameters:

filter - filter to use in search

Returns:

set items matching specified filter.

findNotesByTriageStatus

SortedSet<NoteItem> findNotesByTriageStatus(CollectionItem collection,
                                            TriageStatusQueryContext context)

Find note items by triage status that belong to a collection.

Parameters:

collection - collection

context - the query context

Returns:

set of notes that match the specified triage status label and belong to the specified collection

findNotesByTriageStatus

SortedSet<NoteItem> findNotesByTriageStatus(NoteItem note,
                                            TriageStatusQueryContext context)

Find note items by triage status that belong to a recurring note series.

Parameters:

note - recurring note

context - the query context

Returns:

set of notes that match the specified triage status label and belong to the specified recurring note series

createTicket

void createTicket(Item item,
                  Ticket ticket)

Creates a ticket on an item.

Parameters:

item - the item to be ticketed

ticket - the ticket to be saved

createTicket

void createTicket(String path,
                  Ticket ticket)

Creates a ticket on an item.

Parameters:

path - the path of the item to be ticketed

ticket - the ticket to be saved

getTicket

Ticket getTicket(Item item,
                 String key)

Parameters:

item - the ticketed item

key - the ticket to return

Returns:

The identified ticket on the given item, or null if the ticket does not exists. Tickets are inherited, so if the specified item does not have the ticket but an ancestor does, it will still be returned.

removeTicket

void removeTicket(Item item,
                  Ticket ticket)

Removes a ticket from an item.

Parameters:

item - the item to be de-ticketed

ticket - the ticket to remove

removeTicket

void removeTicket(Item item,
                  String key)

Removes a ticket from an item.

Parameters:

item - the item to be de-ticketed

key - the key of the ticket to remove

removeItemsFromCollection

void removeItemsFromCollection(CollectionItem collection)

Remove items from a collection.

Parameters:

collection - The collection contains all items which will be removed.