org.gcube.common.homelibrary.home.workspace.folder

Interface FolderBulkCreator

public interface FolderBulkCreator

Author:

Federico De Faveri defaveri@isti.cnr.it

Method Summary

Modifier and Type	Method and Description
void	commit() Commit all requested changes.
void	createAnnotation(URI uri) Create a new annotation into this folder.
void	createDocumentAlternativeItem(URI uri) Create a new document alternative into this folder.
void	createDocumentItem(URI uri) Create a new document into this folder.
void	createDocumentPartItem(URI uri) Create a new document part into this folder.
void	createExternalUrl(String url) Create an external url.
void	createMetadata(URI uri) Create a new metadata into this folder.
void	createQuery(String name, String query, QueryType queryType) Create a new query.
WorkspaceFolder	getDestinationFolder() Return the destination folder where all items will be created.
int	getFailures()
String	getId() Return this FolderBulkCreator id.
int	getNumberOfRequests() Return the number of requests processed by this FolderBulkCreator.
float	getStatus()
void	remove()

Method Detail

getId

String getId()

Return this FolderBulkCreator id.

Returns:

the id.

createMetadata

void createMetadata(URI uri)
             throws InsufficientPrivilegesException,
                    InternalErrorException

Create a new metadata into this folder.

Parameters:

uri - the metadata uri.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

createAnnotation

void createAnnotation(URI uri)
               throws InsufficientPrivilegesException,
                      InternalErrorException

Create a new annotation into this folder.

Parameters:

uri - the annotation uri.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

createDocumentPartItem

void createDocumentPartItem(URI uri)
                     throws InsufficientPrivilegesException,
                            InternalErrorException

Create a new document part into this folder. The item name is retrieved from the document name.

Parameters:

uri - the part uri.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

createDocumentAlternativeItem

void createDocumentAlternativeItem(URI uri)
                            throws InsufficientPrivilegesException,
                                   InternalErrorException

Create a new document alternative into this folder. The item name is retrieved from the document name.

Parameters:

uri - the alternative uri.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

createDocumentItem

void createDocumentItem(URI uri)
                 throws InsufficientPrivilegesException,
                        InternalErrorException

Create a new document into this folder.

Parameters:

uri - the document uri.

Throws:

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

InternalErrorException - if an internal error occurs.

createExternalUrl

void createExternalUrl(String url)
                throws InternalErrorException

Create an external url.

Parameters:

url - the url.

Throws:

InternalErrorException

createQuery

void createQuery(String name,
                 String query,
                 QueryType queryType)
          throws InternalErrorException

Create a new query.

Parameters:

name - the item name.

query - the query.

queryType - the query type.

Throws:

InternalErrorException

commit

void commit()
     throws InternalErrorException

Commit all requested changes.

Throws:

InternalErrorException - if an internal error occurs.

getDestinationFolder

WorkspaceFolder getDestinationFolder()

Return the destination folder where all items will be created.

Returns:

the destination folder.

getNumberOfRequests

int getNumberOfRequests()
                 throws InternalErrorException

Return the number of requests processed by this FolderBulkCreator.

Returns:

the number of requests.

Throws:

InternalErrorException

getStatus

float getStatus()
         throws InternalErrorException

Returns:

Throws:

InternalErrorException

remove

void remove()
     throws InternalErrorException

Throws:

InternalErrorException

getFailures

int getFailures()
         throws InternalErrorException

Returns:

Throws:

InternalErrorException