net.bluemind.core.container.service

Interface IContainerStoreService<T>

All Known Implementing Classes:

BaseDirStoreService, ContainerCalendarViewStoreService, ContainerDeferredActionStoreService, ContainerGroupStoreService, ContainerMailshareStoreService, ContainerStoreService, ContainerUserStoreService, ContainerWithoutChangelogService, ConversationStoreService, DeviceStoreService, DirEntryStoreService, DirValueStoreService, DomainStoreService, ExternalUserContainerStoreService, MailboxStoreService, OrgUnitContainerStoreService, ResourceContainerStoreService, RoomContainerStoreService, ServerStoreService, VCardContainerStoreService, VEventContainerStoreService, VTodoContainerStoreService

public interface IContainerStoreService<T>

Method Summary

Modifier and Type	Method and Description
ListResult<java.lang.Long>	allIds(IdQuery query)
java.util.List<java.lang.String>	allUids()
void	attach(java.lang.String uid, java.lang.String displayName, T value)
ContainerChangelog	changelog(java.lang.Long from, long to)
ItemChangelog	changelog(java.lang.String itemUid, java.lang.Long from, long to)
ItemVersion	create(Item item, T value) Create item from an existing one
ItemVersion	create(java.lang.String uid, java.lang.String extId, java.lang.String displayName, T value) Create item with external ID
ItemVersion	create(java.lang.String uid, java.lang.String displayName, T value) Create item without external ID
ItemVersion	createWithId(java.lang.String uid, java.lang.Long internalId, java.lang.String extId, java.lang.String displayName, T value) Create item with external and a given internal ID.
ItemVersion	delete(long id)
ItemVersion	delete(java.lang.String uid)
void	deleteAll() Delete all values (changelog is available for deleted values).
void	detach(java.lang.String uid)
ItemValue<T>	get(long id, java.lang.Long version)
ItemValue<T>	get(java.lang.String uid, java.lang.Long version)
ItemValue<T>	getByExtId(java.lang.String extId) Get item by external ID
void	prepareContainerDelete() Delete all values.
long	setExtId(java.lang.String uid, java.lang.String extId)
void	touch(java.lang.String uid)
ItemVersion	update(Item item, java.lang.String displayName, T value)
ItemVersion	update(long id, java.lang.String displayName, T value)
ItemVersion	update(java.lang.String uid, java.lang.String displayName, T value)
void	xfer(javax.sql.DataSource targetDataSource, Container targetContainer, IItemValueStore<T> targetItemValueStore)

Method Detail

changelog

ContainerChangelog changelog(java.lang.Long from,
                             long to)

changelog

ItemChangelog changelog(java.lang.String itemUid,
                        java.lang.Long from,
                        long to)

get

ItemValue<T> get(java.lang.String uid,
                 java.lang.Long version)

get

ItemValue<T> get(long id,
                 java.lang.Long version)

getByExtId

ItemValue<T> getByExtId(java.lang.String extId)

Get item by external ID

Parameters:

extId -

Returns:

null if the given external id is not found

Throws:

ServerFault

create

ItemVersion create(java.lang.String uid,
                   java.lang.String displayName,
                   T value)

Create item without external ID

Parameters:

uid -

displayName -

value -

Throws:

ServerFault

create

ItemVersion create(Item item,
                   T value)

Create item from an existing one

Parameters:

item -

displayName -

value -

Throws:

ServerFault

attach

void attach(java.lang.String uid,
            java.lang.String displayName,
            T value)

create

ItemVersion create(java.lang.String uid,
                   java.lang.String extId,
                   java.lang.String displayName,
                   T value)

Create item with external ID

Parameters:

uid -

extId -

displayName -

value -

Throws:

ServerFault

createWithId

ItemVersion createWithId(java.lang.String uid,
                         java.lang.Long internalId,
                         java.lang.String extId,
                         java.lang.String displayName,
                         T value)

Create item with external and a given internal ID. Use this only if you are sure that the internal ID is available (because you pre-allocated some ids). If internalId is null, this is identical to create.

Parameters:

uid -

internalId -

extId -

displayName -

value -

Throws:

ServerFault

update

ItemVersion update(java.lang.String uid,
                   java.lang.String displayName,
                   T value)

update

ItemVersion update(long id,
                   java.lang.String displayName,
                   T value)

update

ItemVersion update(Item item,
                   java.lang.String displayName,
                   T value)

delete

ItemVersion delete(java.lang.String uid)

Parameters:

uid -

Returns:

the id & version of the deleted item or null if nothing was deleted

Throws:

ServerFault

delete

ItemVersion delete(long id)

Parameters:

id -

Returns:

the id & version of the deleted item or null if nothing was deleted

Throws:

ServerFault

detach

void detach(java.lang.String uid)

deleteAll

void deleteAll()

Delete all values (changelog is available for deleted values). Consider IContainerStoreService#prepareContainerDelete()) when container deletion is your next step.

Throws:

ServerFault

touch

void touch(java.lang.String uid)

allUids

java.util.List<java.lang.String> allUids()

allIds

ListResult<java.lang.Long> allIds(IdQuery query)

prepareContainerDelete

void prepareContainerDelete()

Delete all values. Prefer it to deleteAll() when you want to drop the container after the call.

Throws:

ServerFault

setExtId

long setExtId(java.lang.String uid,
              java.lang.String extId)

xfer

void xfer(javax.sql.DataSource targetDataSource,
          Container targetContainer,
          IItemValueStore<T> targetItemValueStore)