net.bluemind.notes.service.internal

Class NoteService

java.lang.Object

net.bluemind.notes.service.internal.NoteService

All Implemented Interfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VNote>, IDataShardSupport, IReadByIdSupport<VNote>, IRestoreCrudSupport<VNote>, IRestoreSupport<VNote>, ISortingSupport, INote

public class NoteService
extends java.lang.Object
implements INote

Constructor Summary

Constructors

Constructor and Description
NoteService(javax.sql.DataSource pool, org.elasticsearch.client.Client esearchClient, Container container, BmContext bmContext)

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<VNote>>	all() List all Notes of a container
java.util.List<java.lang.String>	allUids() Retrieve all VNote UIDs of this user
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since)
ContainerChangeset<java.lang.Long>	changesetById(java.lang.Long since)
ContainerChangelog	containerChangelog(java.lang.Long since)
Count	count(ItemFlagFilter filter) Count items matching an ItemFlagFilter
void	create(java.lang.String uid, VNote note) Creates a new VNote entry.
Ack	createById(long id, VNote value) Create a VNote
void	delete(java.lang.String uid) Delete a VNote
void	deleteById(long id) Delete a VNote
ContainerChangeset<ItemVersion>	filteredChangesetById(java.lang.Long since, ItemFlagFilter filter)
VNote	get(java.lang.String uid)
ItemValue<VNote>	getComplete(java.lang.String uid) Fetch a VNote by its unique UID
ItemValue<VNote>	getCompleteById(long id) Get ItemValue containing a VNote by its internal id
long	getVersion()
ItemChangelog	itemChangelog(java.lang.String itemUid, java.lang.Long since)
void	multipleDeleteById(java.util.List<java.lang.Long> ids)
java.util.List<ItemValue<VNote>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VNotes by their unique UIDs
java.util.List<ItemValue<VNote>>	multipleGetById(java.util.List<java.lang.Long> ids) Fetch multiple VNotes by their unique IDs
void	reset() Delete all VNotes of this user
void	restore(ItemValue<VNote> noteItem, boolean isCreate)
ListResult<ItemValue<VNote>>	search(VNoteQuery query) Search VNote's by VNoteQuery
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Get a sorted list (IDs according to the sorted list of items) of internal IDs
void	update(java.lang.String uid, VNote note) Modifies an existing VNote.
Ack	updateById(long id, VNote value) Update a VNote
ContainerUpdatesResult	updates(VNoteChanges changes) Updates multiple VNotes.
void	xfer(java.lang.String serverUid)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.bluemind.core.container.api.IChangelogSupport

allIds

Constructor Detail

NoteService

public NoteService(javax.sql.DataSource pool,
                   org.elasticsearch.client.Client esearchClient,
                   Container container,
                   BmContext bmContext)

Method Detail

all

public java.util.List<ItemValue<VNote>> all()
                                     throws ServerFault

Description copied from interface: INote

List all Notes of a container

Specified by:

all in interface INote

Returns:

All VNote of the container

Throws:

ServerFault - common error object

create

public void create(java.lang.String uid,
                   VNote note)
            throws ServerFault

Description copied from interface: INote

Creates a new VNote entry.

Specified by:

create in interface INote

Parameters:

uid - Unique entry UID

note - VNote values

Throws:

ServerFault - common error object

update

public void update(java.lang.String uid,
                   VNote note)
            throws ServerFault

Description copied from interface: INote

Modifies an existing VNote.

Specified by:

update in interface INote

Parameters:

uid - Unique entry UID

note - VNote values

Throws:

ServerFault - common error object

getComplete

public ItemValue<VNote> getComplete(java.lang.String uid)
                             throws ServerFault

Description copied from interface: INote

Fetch a VNote by its unique UID

Specified by:

getComplete in interface INote

Parameters:

uid - Unique entry UID

Returns:

ItemValue containing a VNote

Throws:

ServerFault - common error object

multipleGet

public java.util.List<ItemValue<VNote>> multipleGet(java.util.List<java.lang.String> uids)
                                             throws ServerFault

Description copied from interface: INote

Fetch multiple VNotes by their unique UIDs

Specified by:

multipleGet in interface INote

Parameters:

uids - list of unique UIDs

Returns:

list of ItemValues containing VNotes

Throws:

ServerFault - common error object

multipleGetById

public java.util.List<ItemValue<VNote>> multipleGetById(java.util.List<java.lang.Long> ids)
                                                 throws ServerFault

Description copied from interface: INote

Fetch multiple VNotes by their unique IDs

Specified by:

multipleGetById in interface IReadByIdSupport<VNote>

Specified by:

multipleGetById in interface INote

Parameters:

ids - list of unique IDs

Returns:

list of ItemValues containing VNotes

Throws:

ServerFault - common error object

delete

public void delete(java.lang.String uid)
            throws ServerFault

Description copied from interface: INote

Delete a VNote

Specified by:

delete in interface IRestoreCrudSupport<VNote>

Specified by:

delete in interface INote

Parameters:

uid - unique UID

Throws:

ServerFault - common error object

containerChangelog

public ContainerChangelog containerChangelog(java.lang.Long since)
                                      throws ServerFault

Specified by:

containerChangelog in interface IChangelogSupport

Returns:

if successful, return a ContainerChangelog

Throws:

ServerFault

changeset

public ContainerChangeset<java.lang.String> changeset(java.lang.Long since)
                                               throws ServerFault

Specified by:

changeset in interface IChangelogSupport

Returns:

if successful, return a ContainerChangeset

Throws:

ServerFault

changesetById

public ContainerChangeset<java.lang.Long> changesetById(java.lang.Long since)
                                                 throws ServerFault

Specified by:

changesetById in interface IChangelogSupport

Returns:

if successful, return a ContainerChangeset with internal numeric ids

Throws:

ServerFault

filteredChangesetById

public ContainerChangeset<ItemVersion> filteredChangesetById(java.lang.Long since,
                                                             ItemFlagFilter filter)
                                                      throws ServerFault

Specified by:

filteredChangesetById in interface IChangelogSupport

filter - to exclude some items (eg. deleted items)

Returns:

if successful, return a ContainerChangeset with internal numeric ids matching the given filter

Throws:

ServerFault

itemChangelog

public ItemChangelog itemChangelog(java.lang.String itemUid,
                                   java.lang.Long since)
                            throws ServerFault

Specified by:

itemChangelog in interface IChangelogSupport

Returns:

if successful, return a ContainerChangelog

Throws:

ServerFault

reset

public void reset()
           throws ServerFault

Description copied from interface: INote

Delete all VNotes of this user

Specified by:

reset in interface INote

Throws:

ServerFault - common error object

getVersion

public long getVersion()
                throws ServerFault

Specified by:

getVersion in interface IChangelogSupport

Throws:

ServerFault

count

public Count count(ItemFlagFilter filter)
            throws ServerFault

Description copied from interface: ICountingSupport

Count items matching an ItemFlagFilter

Specified by:

count in interface ICountingSupport

Returns:

the count of items matching the filter

Throws:

ServerFault

getCompleteById

public ItemValue<VNote> getCompleteById(long id)

Description copied from interface: INote

Get ItemValue containing a VNote by its internal id

Specified by:

getCompleteById in interface IReadByIdSupport<VNote>

Specified by:

getCompleteById in interface INote

Parameters:

id - internal id

Returns:

Matching ItemValue containing a VNote

updateById

public Ack updateById(long id,
                      VNote value)

Description copied from interface: INote

Update a VNote

Specified by:

updateById in interface ICrudByIdSupport<VNote>

Specified by:

updateById in interface INote

Parameters:

id - internal id

value - VNote

Returns:

Ack containing the new version number

createById

public Ack createById(long id,
                      VNote value)

Description copied from interface: INote

Create a VNote

Specified by:

createById in interface ICrudByIdSupport<VNote>

Specified by:

createById in interface INote

Parameters:

id - internal id

value - VNote

Returns:

Ack containing the new version number

deleteById

public void deleteById(long id)

Description copied from interface: INote

Delete a VNote

Specified by:

deleteById in interface ICrudByIdSupport<VNote>

Specified by:

deleteById in interface INote

Parameters:

id - internal id

allUids

public java.util.List<java.lang.String> allUids()
                                         throws ServerFault

Description copied from interface: INote

Retrieve all VNote UIDs of this user

Specified by:

allUids in interface INote

Returns:

List of UIDs

Throws:

ServerFault - common error object

sortedIds

public java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)
                                         throws ServerFault

Description copied from interface: INote

Get a sorted list (IDs according to the sorted list of items) of internal IDs

Specified by:

sortedIds in interface ISortingSupport

Specified by:

sortedIds in interface INote

Parameters:

sorted - sorting criteria

Returns:

List of internal IDs

Throws:

ServerFault - common error object

xfer

public void xfer(java.lang.String serverUid)
          throws ServerFault

Specified by:

xfer in interface IDataShardSupport

Throws:

ServerFault

multipleDeleteById

public void multipleDeleteById(java.util.List<java.lang.Long> ids)
                        throws ServerFault

Specified by:

multipleDeleteById in interface ICrudByIdSupport<VNote>

Throws:

ServerFault

search

public ListResult<ItemValue<VNote>> search(VNoteQuery query)
                                    throws ServerFault

Description copied from interface: INote

Search VNote's by VNoteQuery

Specified by:

search in interface INote

Parameters:

query - VNoteQuery

Returns:

ListResult of the matching ItemValues containing a VNote

Throws:

ServerFault - common error object

updates

public ContainerUpdatesResult updates(VNoteChanges changes)
                               throws ServerFault

Description copied from interface: INote

Updates multiple VNotes.

Specified by:

updates in interface INote

Parameters:

changes - VNoteChanges containing the requested updates

Returns:

ContainerUpdatesResult

Throws:

ServerFault - common error object

get

public VNote get(java.lang.String uid)

Specified by:

get in interface IRestoreSupport<VNote>

restore

public void restore(ItemValue<VNote> noteItem,
                    boolean isCreate)

Specified by:

restore in interface IRestoreSupport<VNote>