spcp7.imagegallery.contentprovider.face
Interface ContentRetrievalFace

All Superinterfaces:

ContentConnectionFace

All Known Implementing Classes:

AlfrescoContentRetrievalImpl

public interface ContentRetrievalFace
extends ContentConnectionFace

This interface specifies methods which are used to retrieve content of this content provider.

Method Summary

ContentFace	getParent(java.lang.String proprietaryId, java.util.Map<java.lang.String,PropertyModelFace> properties)
java.util.List<ContentFace>	getVolumes(java.util.Map<java.lang.String,PropertyModelFace> properties, boolean isFolder) With this method you can get volumes from the specified absolute path.
java.util.List<ContentFace>	getVolumesFromTo(int lowerLimit, int upperLimit, java.util.Map<java.lang.String,PropertyModelFace> properties, boolean isFolder) With this method you can get volumes from the specified absolute path.

Methods inherited from interface spcp7.imagegallery.contentprovider.face.ContentConnectionFace

close, open

Method Detail

getVolumes

java.util.List<ContentFace> getVolumes(java.util.Map<java.lang.String,PropertyModelFace> properties,
                                       boolean isFolder)
                                       throws PropertyValidationException,
                                              ContentCouldNotBeAccessedException,
                                              NoContentFoundException

With this method you can get volumes from the specified absolute path. The DefaultProperties#SPCP7_CURRENT_PATH#toString() property defines this path. For instructions of the used properties within this method consider the documentation of the specific content provider.

Parameters:

properties - the properties of the specified path.

isFolder - True if the path specifies a folder, false otherwise.

Returns:

A List with ContentFaces or a List with only one element if param isFolder was false.

Throws:

PropertyValidationException - If a property is missing or has the wrong value.

ContentCouldNotBeAccessedException - If the content could not be accessed. This may hav several reasons. Look at the exception message to get the details.

NoContentFoundException - If the query was correct but no content was found.

getVolumesFromTo

java.util.List<ContentFace> getVolumesFromTo(int lowerLimit,
                                             int upperLimit,
                                             java.util.Map<java.lang.String,PropertyModelFace> properties,
                                             boolean isFolder)
                                             throws RangeNotValidException,
                                                    PropertyValidationException,
                                                    ContentCouldNotBeAccessedException,
                                                    NoContentFoundException

With this method you can get volumes from the specified absolute path. The DefaultProperties#SPCP7_CURRENT_PATH#toString() property defines this path. For instructions of the used properties within this method consider the documentation of the specific content provider. This method allows the user to get only contents of a specific range. To know how many

Parameters:

lowerLimit - The lower limit of the result set

upperLimit - The upper limit of the result set

properties - the properties of the specified path.

isFolder - True if the path specifies a folder, false otherwise.

Returns:

A List with ContentFaces

Throws:

PropertyValidationException - If a property is missing or has the wrong value.

ContentCouldNotBeAccessedException - If the content could not be accessed. This may hav several reasons. Look at the exception message to get the details.

NoContentFoundException - If the query was correct but no content was found.

RangeNotValidException - if the specified range is not valid.

getParent

ContentFace getParent(java.lang.String proprietaryId,
                      java.util.Map<java.lang.String,PropertyModelFace> properties)
                      throws ContentCouldNotBeAccessedException,
                             NoContentFoundException

Parameters:

proprietaryId -

properties -

Returns:

Throws:

ContentCouldNotBeAccessedException

NoContentFoundException