org.ametys.plugins.repository.metadata

Interface ModifiableCompositeMetadata

All Superinterfaces:

CompositeMetadata

All Known Implementing Classes:

JCRCompositeMetadata

public interface ModifiableCompositeMetadata
extends CompositeMetadata

Modifiable CompositeMetadata.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.repository.metadata.CompositeMetadata

CompositeMetadata.MetadataType

Method Summary

Modifier and Type	Method and Description
ModifiableBinaryMetadata	getBinaryMetadata(String metadataName) Returns the named metadata's value as BinaryMetadata. If the metadata does not exist, an UnknownMetadataException is thrown.
ModifiableBinaryMetadata	getBinaryMetadata(String metadataName, boolean createNew) Returns the named metadata's value as BinaryMetadata. If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown.
ModifiableCompositeMetadata	getCompositeMetadata(String metadataName) Returns the named metadata's value as CompositeMetadata. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist an UnknownMetadataException is thrown.
ModifiableCompositeMetadata	getCompositeMetadata(String metadataName, boolean createNew) Returns the named metadata's value as CompositeMetadata. If the metadata is multi-valued, one of the value is returned. If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown.
ModifiableTraversableAmetysObject	getObjectCollection(String metadataName) Returns an object collection metadata as a TraversableAmetysObject .
ModifiableTraversableAmetysObject	getObjectCollection(String metadataName, boolean createNew) Returns an object collection metadata as a TraversableAmetysObject .
ModifiableRichText	getRichText(String metadataName) Returns the named metadata's value as RichText. If the metadata does not exist, an UnknownMetadataException is thrown.
ModifiableRichText	getRichText(String metadataName, boolean createNew) Returns the named metadata's value as RichText. If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown.
void	removeMetadata(String metadataName) Removes the given metadata.
void	rename(String newName) Rename the current metadata
void	setMetadata(String metadataName, boolean value) Set a boolean metadata.
void	setMetadata(String metadataName, boolean[] values) Set a multi-valued boolean metadata.
void	setMetadata(String metadataName, Date value) Set a date metadata.
void	setMetadata(String metadataName, Date[] values) Set a multi-valued date metadata.
void	setMetadata(String metadataName, double value) Set a double metadata.
void	setMetadata(String metadataName, double[] values) Set a multi-valued double metadata.
void	setMetadata(String metadataName, long value) Set a long metadata.
void	setMetadata(String metadataName, long[] values) Set a multi-valued long metadata.
void	setMetadata(String metadataName, MultilingualString value) Set a MultilingualString metadata.
void	setMetadata(String metadataName, String value) Set a string metadata.
void	setMetadata(String metadataName, String[] values) Set a multi-valued string metadata.
void	setMetadata(String metadataName, String value, Locale locale) Set a multilingual string metadata.
void	setMetadata(String metadataName, UserIdentity value) Set a UserIdentity metadata.
void	setMetadata(String metadataName, UserIdentity[] values) Set a multi-valued UserIdentity metadata.

Methods inherited from interface org.ametys.plugins.repository.metadata.CompositeMetadata

copyTo, getBoolean, getBoolean, getBooleanArray, getBooleanArray, getDate, getDate, getDateArray, getDateArray, getDouble, getDouble, getDoubleArray, getDoubleArray, getLocalizedString, getLocalizedString, getLong, getLong, getLongArray, getLongArray, getMetadataNames, getMultilingualString, getString, getString, getStringArray, getStringArray, getType, getUser, getUser, getUserArray, getUserArray, hasMetadata, isMultiple

Method Detail

rename

void rename(String newName)
     throws AmetysRepositoryException

Rename the current metadata

Parameters:

newName - the new name

Throws:

AmetysRepositoryException - if an error occurs.

removeMetadata

void removeMetadata(String metadataName)
             throws UnknownMetadataException,
                    AmetysRepositoryException

Removes the given metadata.

Parameters:

metadataName - metadata name.

Throws:

UnknownMetadataException - if the metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBinaryMetadata

ModifiableBinaryMetadata getBinaryMetadata(String metadataName,
                                           boolean createNew)
                                    throws UnknownMetadataException,
                                           AmetysRepositoryException

Returns the named metadata's value as BinaryMetadata.
If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the BinaryMetadata when missing.

Returns:

the metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getBinaryMetadata

ModifiableBinaryMetadata getBinaryMetadata(String metadataName)
                                    throws UnknownMetadataException,
                                           AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as BinaryMetadata.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getBinaryMetadata in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as BinaryMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getRichText

ModifiableRichText getRichText(String metadataName,
                               boolean createNew)
                        throws UnknownMetadataException,
                               AmetysRepositoryException

Returns the named metadata's value as RichText.
If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the BinaryMetadata when missing.

Returns:

the metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getRichText

ModifiableRichText getRichText(String metadataName)
                        throws UnknownMetadataException,
                               AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as RichText.
If the metadata does not exist, an UnknownMetadataException is thrown.

Specified by:

getRichText in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as RichText.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

ModifiableCompositeMetadata getCompositeMetadata(String metadataName)
                                          throws UnknownMetadataException,
                                                 AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns the named metadata's value as CompositeMetadata.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist an UnknownMetadataException is thrown.

Specified by:

getCompositeMetadata in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata value as CompositeMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getCompositeMetadata

ModifiableCompositeMetadata getCompositeMetadata(String metadataName,
                                                 boolean createNew)
                                          throws UnknownMetadataException,
                                                 AmetysRepositoryException

Returns the named metadata's value as CompositeMetadata.
If the metadata is multi-valued, one of the value is returned.
If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the CompositeMetadata when missing.

Returns:

the metadata value as CompositeMetadata.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getObjectCollection

ModifiableTraversableAmetysObject getObjectCollection(String metadataName)
                                               throws AmetysRepositoryException

Description copied from interface: CompositeMetadata

Returns an object collection metadata as a TraversableAmetysObject
.

Specified by:

getObjectCollection in interface CompositeMetadata

Parameters:

metadataName - the metadata name.

Returns:

the metadata as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

getObjectCollection

ModifiableTraversableAmetysObject getObjectCollection(String metadataName,
                                                      boolean createNew)
                                               throws AmetysRepositoryException

Returns an object collection metadata as a TraversableAmetysObject
. If the metadata does not exist and createNew is false, an UnknownMetadataException is thrown. Otherwise, the metadata is automatically created.

Parameters:

metadataName - the metadata name.

createNew - true to create automatically the CompositeMetadata when missing.

Returns:

the metadata as a TraversableAmetysObject.

Throws:

UnknownMetadataException - if the named metadata does not exist.

AmetysRepositoryException - if an error occurs.

setMetadata

void setMetadata(String metadataName,
                 String value)
          throws AmetysRepositoryException

Set a string metadata.

Parameters:

metadataName - the metadata name.

value - the String value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 String value,
                 Locale locale)
          throws AmetysRepositoryException

Set a multilingual string metadata.

Parameters:

metadataName - the metadata name.

value - the String value of this metadata in the given locale.

locale - The value of locale

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 Date value)
          throws AmetysRepositoryException

Set a date metadata.

Parameters:

metadataName - the metadata name.

value - the Date value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 long value)
          throws AmetysRepositoryException

Set a long metadata.

Parameters:

metadataName - the metadata name.

value - the integer value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 double value)
          throws AmetysRepositoryException

Set a double metadata.

Parameters:

metadataName - the metadata name.

value - the integer value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 boolean value)
          throws AmetysRepositoryException

Set a boolean metadata.

Parameters:

metadataName - the metadata name.

value - the boolean value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 UserIdentity value)
          throws AmetysRepositoryException

Set a UserIdentity metadata.

Parameters:

metadataName - the metadata name.

value - the UserIdentity value of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 String[] values)
          throws AmetysRepositoryException

Set a multi-valued string metadata.

Parameters:

metadataName - the metadata name.

values - the String array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 Date[] values)
          throws AmetysRepositoryException

Set a multi-valued date metadata.

Parameters:

metadataName - the metadata name.

values - the Date array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 long[] values)
          throws AmetysRepositoryException

Set a multi-valued long metadata.

Parameters:

metadataName - the metadata name.

values - the integer array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 double[] values)
          throws AmetysRepositoryException

Set a multi-valued double metadata.

Parameters:

metadataName - the metadata name.

values - the integer array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 boolean[] values)
          throws AmetysRepositoryException

Set a multi-valued boolean metadata.

Parameters:

metadataName - the metadata name.

values - the boolean array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 UserIdentity[] values)
          throws AmetysRepositoryException

Set a multi-valued UserIdentity metadata.

Parameters:

metadataName - the metadata name.

values - the UserIdentity array containing values of this metadata.

Throws:

AmetysRepositoryException - if the metadata cannot be set.

setMetadata

void setMetadata(String metadataName,
                 MultilingualString value)
          throws AmetysRepositoryException

Set a MultilingualString metadata.

Parameters:

metadataName - the metadata name.

value - the MultilingualString value

Throws:

AmetysRepositoryException - if the metadata cannot be set.