com.silverpeas.classifieds.control
Interface ClassifiedService

All Superinterfaces:

com.silverpeas.SilverpeasComponentService<ClassifiedDetail>

All Known Implementing Classes:

DefaultClassifiedService

public interface ClassifiedService
extends com.silverpeas.SilverpeasComponentService<ClassifiedDetail>

Services provided by the Classified Silverpeas component. It has to be managed by the IoC container under the name classifiedService.

Method Summary

String	createClassified(ClassifiedDetail classified) create a classified
void	createSubscribe(Subscribe subscribe) create a subscription
void	deleteAllClassifieds(String instanceId) delete all classifieds for the instance corresponding to instanceId
void	deleteAllSubscribes(String instanceId) delete all subscriptions for the instance corresponding to instanceId
void	deleteClassified(String instanceId, String classifiedId) delete the classified corresponding to classifiedId
void	deleteSubscribe(String subscribeId) delete a subscription corresponding to subscribeId
void	draftInClassified(String classifiedId) pass the classified corresponding to classifiedId in draft mode
void	draftOutClassified(String classifiedId, String profile, boolean isValidationEnabled) take out draft mode the classified corresponding to classified
Collection<ClassifiedDetail>	getAllClassifieds(String instanceId) get all classifieds for an instance corresponding to instanceId
Collection<ClassifiedDetail>	getAllClassifiedsToUnpublish(int nbDays, String instanceId) get all expiring classifieds (corresponding of a number of day nbDays)
Collection<ClassifiedDetail>	getAllValidClassifieds(String instanceId, Map<String,String> mapFields1, Map<String,String> mapFields2, String searchField1, String searchField2, int currentPage, int elementsPerPage) get all valid classifieds
Collection<ClassifiedDetail>	getClassifiedsByUser(String instanceId, String userId) get all classifieds for user and instance corresponding to userId and instanceId
Collection<ClassifiedDetail>	getClassifiedsToValidate(String instanceId) get all classifieds to validate for an instance corresponding to instanceId
String	getNbTotalClassifieds(String instanceId) get the number of classifieds for an instance corresponding to instanceId
Collection<Subscribe>	getSubscribesByUser(String instanceId, String userId) get all subscriptions for user and instance corresponding to userId and instanceId
Collection<ClassifiedDetail>	getUnpublishedClassifieds(String instanceId, String userId) get all classifieds unpublished for an instance corresponding to instanceId and for given user
Collection<String>	getUsersBySubscribe(String field1, String field2) get all subscribing users to a search corresponding to fields field1 and field2
void	indexClassifieds(String instanceId) index all the classifieds for the instance corresponding to instanceId
void	refusedClassified(String classifiedId, String userId, String refusalMotive) pass to status refused because the user corresponding to userId refused the classified corresponding to classifiedId for the motive ResusalMotive
List<ClassifiedDetail>	search(org.silverpeas.search.searchEngine.model.QueryDescription query) search all classifieds corresponding to the query
void	sendSubscriptionsNotification(String field1, String field2, ClassifiedDetail classified) send a notification for subscribers to field1 and field2 when classified modified
void	setClassification(ClassifiedDetail classified, String searchField1, String searchField2, String xmlFormName)
void	unpublishClassified(String classifiedId) unpublish a subscription corresponding to subscribeId
void	updateClassified(ClassifiedDetail classified, boolean notify) update the classified and send notification if notify is true
void	validateClassified(String classifiedId, String userId) pass to status validate because the user corresponding to userId validated the classified corresponding to classifiedId

Methods inherited from interface com.silverpeas.SilverpeasComponentService

getComponentMessages, getComponentSettings, getContentById

Method Detail

createClassified

String createClassified(ClassifiedDetail classified)

create a classified

Parameters:

classified - : ClassifiedDetail

Returns:

classifiedId : String

updateClassified

void updateClassified(ClassifiedDetail classified,
                      boolean notify)

update the classified and send notification if notify is true

Parameters:

classified - : ClassifiedDetail

notify - : boolean

deleteClassified

void deleteClassified(String instanceId,
                      String classifiedId)

delete the classified corresponding to classifiedId

Parameters:

instanceId - : String

classifiedId - : String

deleteAllClassifieds

void deleteAllClassifieds(String instanceId)

delete all classifieds for the instance corresponding to instanceId

Parameters:

instanceId - : String

draftInClassified

void draftInClassified(String classifiedId)

pass the classified corresponding to classifiedId in draft mode

Parameters:

classifiedId - : String

draftOutClassified

void draftOutClassified(String classifiedId,
                        String profile,
                        boolean isValidationEnabled)

take out draft mode the classified corresponding to classified

Parameters:

classifiedId - : String

profile - : String

isValidationEnabled - : boolean

getAllClassifieds

Collection<ClassifiedDetail> getAllClassifieds(String instanceId)

get all classifieds for an instance corresponding to instanceId

Parameters:

instanceId - : String

Returns:

a collection of ClassifiedDetail

getClassifiedsByUser

Collection<ClassifiedDetail> getClassifiedsByUser(String instanceId,
                                                  String userId)

get all classifieds for user and instance corresponding to userId and instanceId

Parameters:

instanceId - : String

userId - : String

Returns:

a collection of ClassifiedDetail

getNbTotalClassifieds

String getNbTotalClassifieds(String instanceId)

get the number of classifieds for an instance corresponding to instanceId

Parameters:

instanceId - : String

Returns:

the number of classified : String

getClassifiedsToValidate

Collection<ClassifiedDetail> getClassifiedsToValidate(String instanceId)

get all classifieds to validate for an instance corresponding to instanceId

Parameters:

instanceId - : String

Returns:

a Collection of ClassifiedDetail

refusedClassified

void refusedClassified(String classifiedId,
                       String userId,
                       String refusalMotive)

pass to status refused because the user corresponding to userId refused the classified corresponding to classifiedId for the motive ResusalMotive

Parameters:

classifiedId - : String

userId - : String

refusalMotive - : String

validateClassified

void validateClassified(String classifiedId,
                        String userId)

pass to status validate because the user corresponding to userId validated the classified corresponding to classifiedId

Parameters:

classifiedId -

userId -

search

List<ClassifiedDetail> search(org.silverpeas.search.searchEngine.model.QueryDescription query)

search all classifieds corresponding to the query

Parameters:

query - : QueryDescription

Returns:

a collection of ClassifiedDetail

indexClassifieds

void indexClassifieds(String instanceId)

index all the classifieds for the instance corresponding to instanceId

Parameters:

instanceId - : String

getAllClassifiedsToUnpublish

Collection<ClassifiedDetail> getAllClassifiedsToUnpublish(int nbDays,
                                                          String instanceId)

get all expiring classifieds (corresponding of a number of day nbDays)

Parameters:

nbDays - : int

instanceId - : classified component instance id

Returns:

a collection of ClassifiedDetail

createSubscribe

void createSubscribe(Subscribe subscribe)

create a subscription

Parameters:

subscribe - : Subscribe

deleteSubscribe

void deleteSubscribe(String subscribeId)

delete a subscription corresponding to subscribeId

Parameters:

subscribeId - : String

unpublishClassified

void unpublishClassified(String classifiedId)

unpublish a subscription corresponding to subscribeId

Parameters:

subscribeId - : String

getSubscribesByUser

Collection<Subscribe> getSubscribesByUser(String instanceId,
                                          String userId)

get all subscriptions for user and instance corresponding to userId and instanceId

Parameters:

instanceId - : String

userId - : String

Returns:

a collection of Subscribe

getUsersBySubscribe

Collection<String> getUsersBySubscribe(String field1,
                                       String field2)

get all subscribing users to a search corresponding to fields field1 and field2

Parameters:

field1 - : String

field2 - : String

Returns:

a collection of userId (String)

deleteAllSubscribes

void deleteAllSubscribes(String instanceId)

delete all subscriptions for the instance corresponding to instanceId

Parameters:

instanceId -

sendSubscriptionsNotification

void sendSubscriptionsNotification(String field1,
                                   String field2,
                                   ClassifiedDetail classified)

send a notification for subscribers to field1 and field2 when classified modified

Parameters:

field1 - : string

field2 - : String

classified - : ClassifiedDetail

Throws:

RemoteException

getUnpublishedClassifieds

Collection<ClassifiedDetail> getUnpublishedClassifieds(String instanceId,
                                                       String userId)

get all classifieds unpublished for an instance corresponding to instanceId and for given user

Parameters:

instanceId - : String

userId - : creator user id

Returns:

a collection of ClassifiedDetail

getAllValidClassifieds

Collection<ClassifiedDetail> getAllValidClassifieds(String instanceId,
                                                    Map<String,String> mapFields1,
                                                    Map<String,String> mapFields2,
                                                    String searchField1,
                                                    String searchField2,
                                                    int currentPage,
                                                    int elementsPerPage)

get all valid classifieds

Parameters:

instanceId - : String

mapFields1 - : HashMap des champs de recherche 1

mapFields2 - : HashMap des champs de recherche 1

searchField1 - : champ de recherche 1

searchField2 - : champ de recherche 2

currentPage - : numéro de page actuelle

elementsPerPage - : nombre d'éléments à afficher par page

Returns:

a collection of ClassifiedDetail

setClassification

void setClassification(ClassifiedDetail classified,
                       String searchField1,
                       String searchField2,
                       String xmlFormName)