com.silverpeas.classifieds.control
Class ClassifiedsSessionController

java.lang.Object
  com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
      com.silverpeas.classifieds.control.ClassifiedsSessionController

All Implemented Interfaces:

com.stratelia.silverpeas.peasCore.ComponentSessionController

public final class ClassifiedsSessionController
extends com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

Field Summary

Fields inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

CHARACTER_ENCODING, context

Constructor Summary

ClassifiedsSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl, com.stratelia.silverpeas.peasCore.ComponentContext componentContext)
Standard Session Controller Constructeur

Method Summary

String	createClassified(ClassifiedDetail classified, Collection<org.apache.commons.fileupload.FileItem> listImage, ClassifiedsRole profile) create classified
void	createClassifiedImage(org.apache.commons.fileupload.FileItem fileImage, String classifiedId) create classified image
void	createSubscribe(Subscribe subscribe) create a subscription
void	deleteClassified(String classifiedId) delete the classified corresponding to classifiedId
void	deleteClassifiedImage(String imageId) delete classified image
void	deleteSubscribe(String subscribeId) delete the subscription corresponding to subscribeId
void	draftInClassified(String classifiedId) pass the classified corresponding to classifiedId in draft mode
void	draftOutClassified(String classifiedId, ClassifiedsRole highestRole) take out draft mode the classified corresponding to classified
Collection<ClassifiedDetail>	getAllValidClassifieds(int currentPage) get all valid classifieds
ClassifiedDetail	getClassified(String classifiedId) get classified corresponding to classifiedId
List<ClassifiedDetail>	getClassifieds(org.silverpeas.search.searchEngine.model.QueryDescription query, int nb)
Collection<ClassifiedDetail>	getClassifiedsByUser() get all classifieds for the current user and this instance
Collection<ClassifiedDetail>	getClassifiedsToValidate() get all classifieds to validate for this instance
ClassifiedDetail	getClassifiedWithImages(String classifiedId) get classified corresponding to classifiedId including images
int	getCurrentPage()
String	getNbPages(String nbClassifieds) get the number of pages to display
String	getNbTotalClassifieds() get the number of classifieds for this instance
Collection<ClassifiedDetail>	getPage(int itemIndex)
com.stratelia.webactiv.util.viewGenerator.html.pagination.Pagination	getPagination()
com.silverpeas.publicationTemplate.PublicationTemplate	getPublicationTemplate() Gets the template of the publication based on the classified XML form.
com.stratelia.silverpeas.util.ResourcesWrapper	getResources() Gets the resources associated with this session controller.
SearchContext	getSearchContext()
String	getSearchFields1() get the name of search field1
String	getSearchFields2() get the name of search field2
Collection<ClassifiedDetail>	getSessionClassifieds()
Collection<Subscribe>	getSubscribesByUser() get all subscriptions for the current user and this instance
String	getWysiwygHeader() return wysiwyg header html code
String	getXMLFormName() get the name of xmlForm
boolean	isCommentsEnabled() return true if comments feature is enabled
boolean	isDraftEnabled() return true if draft mode is enabled
boolean	isHomePageDisplayCategorized() return true if Home page displays classifieds organized by category
boolean	isValidationEnabled()
boolean	isWysiwygHeaderEnabled() return true if wysiwyg header feature is enabled
void	refusedClassified(String classifiedId, String motive) pass to status refused because the user corresponding to userId refused the classified corresponding to classifiedId for the motive ResusalMotive
void	search(org.silverpeas.search.searchEngine.model.QueryDescription query) search all classifieds corresponding to the query
void	sendSubscriptionsNotification(String classifiedId) send a notification for subscribers when classified (corresponding to classifiedId) is modified
void	setCurrentPage(int currentPage)
void	setPagination(com.stratelia.webactiv.util.viewGenerator.html.pagination.Pagination pagination)
void	setSearchContext(SearchContext context)
void	updateClassified(ClassifiedDetail classified, boolean isUpdate, boolean isAdmin) update the classified and send notification if isUpdate is true and, if isAdmin is true and classified is in status valid
void	updateClassifiedImage(org.apache.commons.fileupload.FileItem fileImage, String imageId, String classifiedId) update classified image
void	validateClassified(String classifiedId) pass to status validate because the user corresponding to userId validated the classified corresponding to classifiedId

Methods inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getAlertUser, getClipboardCount, getClipboardErrorMessage, getClipboardExceptionError, getClipboardName, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameters, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getFavoriteSpace, getGenericPanel, getHighestSilverpeasUserRole, getIcon, getLanguage, getLastResults, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getServerNameAndPort, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserAvailSpaceIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoleLevel, getUserRoles, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardError, setClipboardSelectedElement, setComponentRootName, setFavoriteSpaceToMainSessionController, setGenericPanel, setIconFileName, setLastResults, setMultilangFileName, setResourceFileName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassifiedsSessionController

public ClassifiedsSessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl,
                                    com.stratelia.silverpeas.peasCore.ComponentContext componentContext)

Standard Session Controller Constructeur

Parameters:

mainSessionCtrl - The user's profile

componentContext - The component's profile

See Also:

Method Detail

setPagination

public void setPagination(com.stratelia.webactiv.util.viewGenerator.html.pagination.Pagination pagination)

getPagination

public com.stratelia.webactiv.util.viewGenerator.html.pagination.Pagination getPagination()

getResources

public com.stratelia.silverpeas.util.ResourcesWrapper getResources()

Gets the resources associated with this session controller.

Returns:

all of the resources (messages, settings, icons, ...)

getClassified

public ClassifiedDetail getClassified(String classifiedId)

get classified corresponding to classifiedId

Parameters:

classifiedId - : String

Returns:

classified : ClassifiedDetail

getNbTotalClassifieds

public String getNbTotalClassifieds()

get the number of classifieds for this instance

Returns:

number : String

search

public void search(org.silverpeas.search.searchEngine.model.QueryDescription query)

search all classifieds corresponding to the query

Parameters:

query - : QueryDescription

getClassifieds

public List<ClassifiedDetail> getClassifieds(org.silverpeas.search.searchEngine.model.QueryDescription query,
                                             int nb)

getSessionClassifieds

public Collection<ClassifiedDetail> getSessionClassifieds()

getPage

public Collection<ClassifiedDetail> getPage(int itemIndex)

getClassifiedsByUser

public Collection<ClassifiedDetail> getClassifiedsByUser()

get all classifieds for the current user and this instance

Returns:

a collection of ClassifiedDetail

getClassifiedsToValidate

public Collection<ClassifiedDetail> getClassifiedsToValidate()

get all classifieds to validate for this instance

Returns:

a collection of ClassifiedDetail

draftOutClassified

public void draftOutClassified(String classifiedId,
                               ClassifiedsRole highestRole)
                        throws com.silverpeas.publicationTemplate.PublicationTemplateException,
                               com.silverpeas.form.FormException

take out draft mode the classified corresponding to classified

Parameters:

classifiedId - : String

highestRole - : ClassifiedsRole

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException

com.silverpeas.form.FormException

draftInClassified

public void draftInClassified(String classifiedId)

pass the classified corresponding to classifiedId in draft mode

Parameters:

classifiedId - : String

validateClassified

public void validateClassified(String classifiedId)
                        throws com.silverpeas.publicationTemplate.PublicationTemplateException,
                               com.silverpeas.form.FormException

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

Parameters:

classifiedId - : String

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException

com.silverpeas.form.FormException

refusedClassified

public void refusedClassified(String classifiedId,
                              String motive)

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

Parameters:

classifiedId - : String

motive - : String

getXMLFormName

public String getXMLFormName()

get the name of xmlForm

Returns:

name : String

getSearchFields1

public String getSearchFields1()

get the name of search field1

Returns:

search field1 name : String

getSearchFields2

public String getSearchFields2()

get the name of search field2

Returns:

search field2 name : String

createClassified

public String createClassified(ClassifiedDetail classified,
                               Collection<org.apache.commons.fileupload.FileItem> listImage,
                               ClassifiedsRole profile)

create classified

Parameters:

classified - : classifiedDetail

profile - : ClassifiedsRole

Returns:

classifiedId : String

deleteClassified

public void deleteClassified(String classifiedId)

delete the classified corresponding to classifiedId

Parameters:

classifiedId - : String

updateClassified

public void updateClassified(ClassifiedDetail classified,
                             boolean isUpdate,
                             boolean isAdmin)

update the classified and send notification if isUpdate is true and, if isAdmin is true and classified is in status valid

Parameters:

classified - : ClassifiedDetail

isUpdate - : boolean

isAdmin - : boolean

sendSubscriptionsNotification

public void sendSubscriptionsNotification(String classifiedId)
                                   throws com.silverpeas.publicationTemplate.PublicationTemplateException,
                                          com.silverpeas.form.FormException

send a notification for subscribers when classified (corresponding to classifiedId) is modified

Parameters:

classifiedId - : String

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException

com.silverpeas.form.FormException

createSubscribe

public void createSubscribe(Subscribe subscribe)

create a subscription

Parameters:

subscribe - : Subscribe

deleteSubscribe

public void deleteSubscribe(String subscribeId)

delete the subscription corresponding to subscribeId

Parameters:

subscribeId - : String

getSubscribesByUser

public Collection<Subscribe> getSubscribesByUser()

get all subscriptions for the current user and this instance

Returns:

a collection of Subscribe

setCurrentPage

public void setCurrentPage(int currentPage)

getCurrentPage

public int getCurrentPage()

isDraftEnabled

public boolean isDraftEnabled()

return true if draft mode is enabled

Returns:

boolean

isValidationEnabled

public boolean isValidationEnabled()

isCommentsEnabled

public boolean isCommentsEnabled()

return true if comments feature is enabled

Returns:

boolean

isWysiwygHeaderEnabled

public boolean isWysiwygHeaderEnabled()

return true if wysiwyg header feature is enabled

Returns:

boolean

getWysiwygHeader

public String getWysiwygHeader()

return wysiwyg header html code

Returns:

wysiwyg header html code

createClassifiedImage

public void createClassifiedImage(org.apache.commons.fileupload.FileItem fileImage,
                                  String classifiedId)

create classified image

Parameters:

fileImage - : FileItem

classifiedId - : String

getClassifiedWithImages

public ClassifiedDetail getClassifiedWithImages(String classifiedId)

get classified corresponding to classifiedId including images

Parameters:

classifiedId - : String

Returns:

classified : ClassifiedDetail

updateClassifiedImage

public void updateClassifiedImage(org.apache.commons.fileupload.FileItem fileImage,
                                  String imageId,
                                  String classifiedId)

update classified image

Parameters:

fileImage - : FileItem

imageId - : String

classifiedId - : String

deleteClassifiedImage

public void deleteClassifiedImage(String imageId)

delete classified image

Parameters:

imageId - : String

isHomePageDisplayCategorized

public boolean isHomePageDisplayCategorized()

return true if Home page displays classifieds organized by category

Returns:

boolean

getAllValidClassifieds

public Collection<ClassifiedDetail> getAllValidClassifieds(int currentPage)

get all valid classifieds

Parameters:

currentPage -

Returns:

a collection of ClassifiedDetail

getNbPages

public String getNbPages(String nbClassifieds)

get the number of pages to display

Returns:

number : String

getPublicationTemplate

public com.silverpeas.publicationTemplate.PublicationTemplate getPublicationTemplate()
                                                                              throws com.silverpeas.publicationTemplate.PublicationTemplateException

Gets the template of the publication based on the classified XML form.

Parameters:

classifiedsSC - the session controller.

Returns:

the publication template for classifieds.

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException - if an error occurs while getting the publication template.

setSearchContext

public void setSearchContext(SearchContext context)

getSearchContext

public SearchContext getSearchContext()