org.eclipse.higgins.sync.meta
Interface IResourceMetaDataService

public interface IResourceMetaDataService

IResourceMetaDataService represents API for managing resource meta information (revision).

Author:

Alexander Yuhimenko

Field Summary

static String	CARD_CATEGORY_RESOURCE_TYPE Define CardCategory resource type.
static String	CARD_CREDENTIALS_RESOURCE_TYPE Define CardCategory resource type.
static String	CARD_HISTORY_RESOURCE_TYPE Define CardHistory resource type.
static String	CARD_RESOURCE_TYPE Define ICard resource type.
static String	ROOT_RESOURCE_TYPE Define Root resource type.
static String	USER_PROFILE_RESOURCE_TYPE Define UserProfile resource type.

Method Summary

void	deleteResourceRevisionEntity(RevisionEntity revisionEntity) Delete RevisionEntity.
RevisionEntity	findMaxRevisionEntity(RevisionEntity revisionEntity) Return RevisionEntity with maximal number which satisfied the following conditions: RevisionEntity.resourceType=revisionEntity.resourceType. RevisionEntity.userId=revisionEntity.userId.
RevisionEntity	findResourceRevisionEntity(RevisionEntity revisionEntity) * Return RevisionEntity which satisfied the following conditions: RevisionEntity.resourceId=revisionEntity.resourceId; RevisionEntity.resourceType=revisionEntity.resourceType. RevisionEntity.userId=revisionEntity.userId.
RevisionEntity	getResourceRevisionEntity(Long id) Return RevisionEntity by Id
List	getResourceRevisionEntityList(RevisionEntity clientRootRevision, String resourceType) Return list of ResourceRevisionEntity with number more than @clientRootRevision.number.
void	persistResourceRevisionEntity(RevisionEntity revisionEntity) Save or update RevisionEntity.

Field Detail

ROOT_RESOURCE_TYPE

static final String ROOT_RESOURCE_TYPE

Define Root resource type.

See Also:

Constant Field Values

USER_PROFILE_RESOURCE_TYPE

static final String USER_PROFILE_RESOURCE_TYPE

Define UserProfile resource type.

See Also:

Constant Field Values

CARD_RESOURCE_TYPE

static final String CARD_RESOURCE_TYPE

Define ICard resource type.

See Also:

Constant Field Values

CARD_HISTORY_RESOURCE_TYPE

static final String CARD_HISTORY_RESOURCE_TYPE

Define CardHistory resource type.

See Also:

Constant Field Values

CARD_CATEGORY_RESOURCE_TYPE

static final String CARD_CATEGORY_RESOURCE_TYPE

Define CardCategory resource type.

See Also:

Constant Field Values

CARD_CREDENTIALS_RESOURCE_TYPE

static final String CARD_CREDENTIALS_RESOURCE_TYPE

Define CardCategory resource type.

See Also:

Constant Field Values

Method Detail

getResourceRevisionEntity

RevisionEntity getResourceRevisionEntity(Long id)
                                         throws ResourceMetaDataException

Return RevisionEntity by Id

Parameters:

id - RevisionEntity Id

Returns:

RevisionEntity

Throws:

ResourceMetaDataException - if couldn't find RevisionEntity.

findResourceRevisionEntity

RevisionEntity findResourceRevisionEntity(RevisionEntity revisionEntity)
                                          throws ResourceMetaDataException

* Return RevisionEntity which satisfied the following conditions:

1. RevisionEntity.resourceId=revisionEntity.resourceId;
2. RevisionEntity.resourceType=revisionEntity.resourceType.
3. RevisionEntity.userId=revisionEntity.userId.

Parameters:

revisionEntity -

Returns:

RevisionEntity or Null if couldn't find RevisionEntity.

Throws:

ResourceMetaDataException

NullPointerException - if revisionEntity or revisionEntity.resourceId or revisionEntity.resourceType are Null.

findMaxRevisionEntity

RevisionEntity findMaxRevisionEntity(RevisionEntity revisionEntity)
                                     throws ResourceMetaDataException

Return RevisionEntity with maximal number which satisfied the following conditions:

RevisionEntity.resourceType=revisionEntity.resourceType.

RevisionEntity.userId=revisionEntity.userId.

Parameters:

revisionEntity -

Returns:

Throws:

ResourceMetaDataException

getResourceRevisionEntityList

List getResourceRevisionEntityList(RevisionEntity clientRootRevision,
                                   String resourceType)
                                   throws ResourceMetaDataException

Return list of ResourceRevisionEntity with number more than @clientRootRevision.number.

Parameters:

clientRootRevision -

resourceType, - if resourceType is null or "%", have to return for all resource types.

Returns:

Throws:

ResourceMetaDataException

persistResourceRevisionEntity

void persistResourceRevisionEntity(RevisionEntity revisionEntity)
                                   throws ResourceMetaDataException

Save or update RevisionEntity.

Parameters:

revisionEntity -

Throws:

ResourceMetaDataException - if couldn't persist revisionEntity.

NullPointerException - if revisionEntity or revisionEntity.resourceId or revisionEntity.resourceType are Null.

deleteResourceRevisionEntity

void deleteResourceRevisionEntity(RevisionEntity revisionEntity)

Delete RevisionEntity. It finds RevisionEntity by Id or by resourceId and resourceType.

Parameters:

revisionEntity -