Package lumis.portal.bigdata

Interface IBigDataManager

All Known Subinterfaces:

IBigDataManagerSPI

All Known Implementing Classes:

BigDataManager

@StableMinor(version="17.0",
             sinceVersion="8.1")
public interface IBigDataManager

Provides big data operations.

Since:

8.1.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
void	addSynonym(ISynonym synonym)	Adds the given synonyms to be used during document creation.
ISynonym	createSynonym()	Creates a new instance of ISynonym to be added later.
void	deleteSynonyms(java.lang.String... synonymIds)	Removes the synonyms with the given identifiers.
IBigDataRepository	getDefaultRepository()	Returns the default big data repository.
ISynonym	getSynonymById(java.lang.String synonymId)	Returns the synonym with the given identifier.
void	updateSynonym(ISynonym synonym)	Updates the given synonyms to be used during document creation.

Method Detail

getDefaultRepository

IBigDataRepository getDefaultRepository()

Returns the default big data repository.

Returns:

the default big data repository.

Since:

8.1.0

createSynonym

ISynonym createSynonym()

Creates a new instance of ISynonym to be added later.

Returns:

a new instance of ISynonym to be added later.

Since:

11.1.0

addSynonym

void addSynonym(ISynonym synonym)
         throws AccessDeniedException,
                java.lang.IllegalArgumentException,
                TransactionRequiredException,
                PortalException

Adds the given synonyms to be used during document creation. This operation, however, may not have an instant effect.
Before call this method, createSynonym() must be called to create a new instance, so it can be added.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Parameters:

synonym - the synonyms to be added.

Throws:

java.lang.IllegalArgumentException - if the given synonym is null or invalid.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

Since:

11.1.0

updateSynonym

void updateSynonym(ISynonym synonym)
            throws AccessDeniedException,
                   java.lang.IllegalArgumentException,
                   TransactionRequiredException,
                   PortalException

Updates the given synonyms to be used during document creation. This operation, however, may not have an instant effect.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Parameters:

synonym - the synonyms to be updated -- it must have been gotten through getSynonymById(String).

Throws:

java.lang.IllegalArgumentException - if the given synonym is null or invalid.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

Since:

11.1.0

deleteSynonyms

void deleteSynonyms(java.lang.String... synonymIds)
             throws AccessDeniedException,
                    java.lang.IllegalArgumentException,
                    TransactionRequiredException,
                    PortalException

Removes the synonyms with the given identifiers. This operation, however, may not have an instant effect.

When calling this method, there must be an active transaction and an active user's session. The user calling this, must have the manage portal permission.

Parameters:

synonymIds - the synonyms identifier.

Throws:

java.lang.IllegalArgumentException - if synonymId is null.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session or the given session does not have the required permission.

PortalException - if other error occur.

Since:

11.1.0

getSynonymById

ISynonym getSynonymById(java.lang.String synonymId)
                 throws AccessDeniedException,
                        java.lang.IllegalArgumentException,
                        TransactionRequiredException,
                        PortalObjectNotFoundException

Returns the synonym with the given identifier.

When calling this method, there must be an active transaction and an active user's session.

Parameters:

synonymId - the synonym identifier.

Returns:

the synonym with the given identifier.

Throws:

java.lang.IllegalArgumentException - if synonymId is null.

TransactionRequiredException - if there's no active transaction.

AccessDeniedException - if there's no active user session.

PortalObjectNotFoundException - if there's no synonym with the given identifier.

Since:

11.1.0