com.communote.server.api.core.property

Interface PropertyManagement

All Known Implementing Classes:

PropertyManagementImpl

public interface PropertyManagement

This service provides means to create, read, update and remove properties including the generic binary property and the properties which are associated with an object like a note or a user.

When accessing properties a filter is applied on the group and key to decide whether the property is accessible. Only properties whose group and key were registered with addObjectPropertyFilter(PropertyType, String, String) will be accessible.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_GROUP Common key group for internal properties.

Method Summary

Modifier and Type	Method and Description
void	addObjectPropertyFilter(PropertyType propertyType, String keyGroup, String propertyKey) Add a combination of a property key group and property key to the accessible properties of the given property type.
Set<StringPropertyTO>	getAllObjectProperties(PropertyType propertyType, Long objectId) Get all filtered properties from a given object for the given property type
BinaryProperty	getBinaryProperty(String keyGroup, String key) Get a binary property not bound to any context
Date	getBinaryPropertyLastModificationDate(String keyGroup, String key) Get last modification date of a binary property.
StringProperty	getGlobalObjectProperty(PropertyType propertyType, Long objectId, String key) Get a global property which is a property with the predefined key group "global"
StringProperty	getObjectProperty(PropertyType propertyType, Long objectId, String keyGroup, String key) Get an object property
StringProperty	getObjectPropertyUnfiltered(PropertyType propertyType, Long objectId, String keyGroup, String key) Get an object property.
<T> Collection<T>	getUsersOfProperty(Long noteId, String keyGroup, String key, String value, Converter<User,T> converter) Return the users that have a specific note property set for a note.
boolean	hasBinaryProperty(String keyGroup, String key) Test whether a binary property exists.
boolean	hasUserNoteProperty(Long noteId, String keyGroup, String key, String value) Test whether the current user has a given property for a note.
void	removeBinaryProperty(String keyGroup, String propertyKey) Remove a binary property.
void	removeObjectPropertyFilter(PropertyType propertyType, String keyGroup, String propertyKey) Remove a combination of a property key group and property key from the accessible properties of the given type.
BinaryProperty	setBinaryProperty(String keyGroup, String key, byte[] value) Set a binary property.
StringProperty	setGlobalObjectProperty(PropertyType propertyType, Long objectId, String key, String value) Set a global property which is a property with the predefined key group will be "global".
void	setObjectProperties(PropertyType propertyType, Long objectId, Set<StringPropertyTO> properties) Set several properties of an object.
StringProperty	setObjectProperty(PropertyType propertyType, Long objectId, String keyGroup, String key, String value) Set a new value of a property.

Field Detail

KEY_GROUP

static final String KEY_GROUP

Common key group for internal properties.

See Also:

Constant Field Values

Method Detail

addObjectPropertyFilter

void addObjectPropertyFilter(PropertyType propertyType,
                             String keyGroup,
                             String propertyKey)

Add a combination of a property key group and property key to the accessible properties of the given property type.

Parameters:

propertyType - the property type

keyGroup - the key group of the property

propertyKey - the key of the property

getAllObjectProperties

Set<StringPropertyTO> getAllObjectProperties(PropertyType propertyType,
                                             Long objectId)
                                      throws NotFoundException,
                                             AuthorizationException

Get all filtered properties from a given object for the given property type

Parameters:

propertyType - the property type

objectId - the object id

Returns:

all filtered properties from the object

Throws:

AuthorizationException - in case the user is not allowed to access the properties of the object

NotFoundException - in case the object does not exist

getBinaryProperty

BinaryProperty getBinaryProperty(String keyGroup,
                                 String key)

Get a binary property not bound to any context

Parameters:

keyGroup - the key group

key - the key of the property

Returns:

the property (or null)

getBinaryPropertyLastModificationDate

Date getBinaryPropertyLastModificationDate(String keyGroup,
                                           String key)

Get last modification date of a binary property.

Parameters:

keyGroup - group of the property key

key - the key of the property

Returns:

the last modification date or null if the property does not exist

getGlobalObjectProperty

StringProperty getGlobalObjectProperty(PropertyType propertyType,
                                       Long objectId,
                                       String key)
                                throws NotFoundException,
                                       AuthorizationException

Get a global property which is a property with the predefined key group "global"

Parameters:

propertyType - the type of property

objectId - the id of the object to get the property for

key - the key of the property

Returns:

the property (or null)

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object

getObjectProperty

StringProperty getObjectProperty(PropertyType propertyType,
                                 Long objectId,
                                 String keyGroup,
                                 String key)
                          throws NotFoundException,
                                 AuthorizationException

Get an object property

Parameters:

propertyType - the type of property

objectId - the ID of the object whose property should be retrieved

keyGroup - the key group of the property

key - the key of the property

Returns:

the property or null if there is no such property or the key and group combination is not in the allowed filters

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object

getObjectPropertyUnfiltered

StringProperty getObjectPropertyUnfiltered(PropertyType propertyType,
                                           Long objectId,
                                           String keyGroup,
                                           String key)
                                    throws NotFoundException,
                                           AuthorizationException

Get an object property. The filter of will not be applied.

Parameters:

propertyType - the type of property

objectId - the ID of the object whose property should be retrieved

keyGroup - the key group of the property

key - the key of the property

Returns:

the property or null if there is no such property

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object

getUsersOfProperty

<T> Collection<T> getUsersOfProperty(Long noteId,
                                     String keyGroup,
                                     String key,
                                     String value,
                                     Converter<User,T> converter)
                              throws NotFoundException,
                                     AuthorizationException

Return the users that have a specific note property set for a note. The found users are converted into the target type of the provided converter. Deleted users won't be included.

Type Parameters:

T - the target type of the conversion

Parameters:

noteId - the ID of the note for which the users that have the property should be returned

keyGroup - the group key of the searched property

key - the group of the searched property

value - the value of the searched property

converter - the converter to convert the found users

Returns:

the found users or an empty list

Throws:

NotFoundException - in case the note does not exist

AuthorizationException - in case the current user is not allowed to read the property

hasBinaryProperty

boolean hasBinaryProperty(String keyGroup,
                          String key)

Test whether a binary property exists.

Parameters:

keyGroup - the key group

key - the key of the property

Returns:

True, if this property exists.

hasUserNoteProperty

boolean hasUserNoteProperty(Long noteId,
                            String keyGroup,
                            String key,
                            String value)
                     throws NotFoundException,
                            AuthorizationException

Test whether the current user has a given property for a note.

Parameters:

noteId - the ID of the note for which the existence of the property should be checked

keyGroup - the group key of the searched property

key - the group of the searched property

value - the value of the searched property

Returns:

true if the user has the property otherwise false

Throws:

AuthorizationException - in case the current user is not allowed to read the property

NotFoundException - in case the note does not exist

removeBinaryProperty

void removeBinaryProperty(String keyGroup,
                          String propertyKey)

Remove a binary property.

Parameters:

keyGroup - The group of the property key.

propertyKey - The properties key.

removeObjectPropertyFilter

void removeObjectPropertyFilter(PropertyType propertyType,
                                String keyGroup,
                                String propertyKey)

Remove a combination of a property key group and property key from the accessible properties of the given type.

Parameters:

propertyType - the property type

keyGroup - the key group of the property

propertyKey - the key of the property

setBinaryProperty

BinaryProperty setBinaryProperty(String keyGroup,
                                 String key,
                                 byte[] value)
                          throws AuthorizationException

Set a binary property.

Parameters:

keyGroup - the key group

key - the key of the property

value - the value to set

Returns:

the property

Throws:

AuthorizationException - in case the user is not allowed to access the properties of the object

setGlobalObjectProperty

StringProperty setGlobalObjectProperty(PropertyType propertyType,
                                       Long objectId,
                                       String key,
                                       String value)
                                throws NotFoundException,
                                       AuthorizationException

Set a global property which is a property with the predefined key group will be "global".

Parameters:

propertyType - the type of property

objectId - the id of the object to set the property for

key - the key of the property

value - the value to set

Returns:

the property

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object

setObjectProperties

void setObjectProperties(PropertyType propertyType,
                         Long objectId,
                         Set<StringPropertyTO> properties)
                  throws NotFoundException,
                         AuthorizationException

Set several properties of an object.

Parameters:

propertyType - the type of property

objectId - the id of the object to set the property for

properties - Set of transfer objects describing the new properties or property values

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object

setObjectProperty

StringProperty setObjectProperty(PropertyType propertyType,
                                 Long objectId,
                                 String keyGroup,
                                 String key,
                                 String value)
                          throws NotFoundException,
                                 AuthorizationException

Set a new value of a property. If the property does not exist it will be created and assigned to the object. If the value to set is null, an existing property will be removed. In case the property does not exist nothing will happen.

Parameters:

propertyType - the type of property

objectId - the id of the object to set the property for

keyGroup - the key group of the property

key - the key of the property

value - the value to set. Can be null to remove an existing property.

Returns:

the created or modified property. Can be null if the value was null and the property did not exist.

Throws:

NotFoundException - in case there is no object of the given property type and id

AuthorizationException - in case the user is not allowed to access the properties of the object