com.silverpeas.formsonline.model
Interface FormsOnlineService

All Superinterfaces:

com.silverpeas.SilverpeasComponentService<FormInstance>

All Known Implementing Classes:

DefaultFormsOnlineService

public interface FormsOnlineService
extends com.silverpeas.SilverpeasComponentService<FormInstance>

Method Summary

void	archiveRequest(RequestPK pk)
void	deleteForm(FormPK pk)
void	deleteRequest(RequestPK pk)
List<FormDetail>	getAllForms(String appId, String userId, boolean withSendInfo)
RequestsByStatus	getAllUserRequests(String appId, String userId)
RequestsByStatus	getAllValidatorRequests(String appId, boolean allRequests, String userId)
List<String>	getAvailableFormIdsAsReceiver(String appId, String userId)
List<FormDetail>	getAvailableFormsToSend(String appId, String userId)
List<FormInstance>	getUserRequestsByForm(FormPK pk, String userId)
FormDetail	loadForm(FormPK pk)
FormInstance	loadRequest(RequestPK pk, String userId)
void	publishForm(FormPK pk)
void	saveRequest(FormPK pk, String userId, List<org.apache.commons.fileupload.FileItem> items)
void	setValidationStatus(RequestPK pk, String userId, String decision, String comments)
FormDetail	storeForm(FormDetail form, String[] senderUserIds, String[] senderGroupIds, String[] receiverUserIds, String[] receiverGroupIds)
void	unpublishForm(FormPK pk)

Methods inherited from interface com.silverpeas.SilverpeasComponentService

getComponentMessages, getComponentSettings, getContentById

Method Detail

getAllForms

List<FormDetail> getAllForms(String appId,
                             String userId,
                             boolean withSendInfo)
                             throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

loadForm

FormDetail loadForm(FormPK pk)
                    throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

storeForm

FormDetail storeForm(FormDetail form,
                     String[] senderUserIds,
                     String[] senderGroupIds,
                     String[] receiverUserIds,
                     String[] receiverGroupIds)
                     throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

deleteForm

void deleteForm(FormPK pk)
                throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

publishForm

void publishForm(FormPK pk)
                 throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

unpublishForm

void unpublishForm(FormPK pk)
                   throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

getAvailableFormsToSend

List<FormDetail> getAvailableFormsToSend(String appId,
                                         String userId)
                                         throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

getAllUserRequests

RequestsByStatus getAllUserRequests(String appId,
                                    String userId)
                                    throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

getUserRequestsByForm

List<FormInstance> getUserRequestsByForm(FormPK pk,
                                         String userId)
                                         throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

getAllValidatorRequests

RequestsByStatus getAllValidatorRequests(String appId,
                                         boolean allRequests,
                                         String userId)
                                         throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

getAvailableFormIdsAsReceiver

List<String> getAvailableFormIdsAsReceiver(String appId,
                                           String userId)
                                           throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

loadRequest

FormInstance loadRequest(RequestPK pk,
                         String userId)
                         throws FormsOnlineDatabaseException,
                                com.silverpeas.publicationTemplate.PublicationTemplateException,
                                com.silverpeas.form.FormException

Throws:

FormsOnlineDatabaseException

com.silverpeas.publicationTemplate.PublicationTemplateException

com.silverpeas.form.FormException

saveRequest

void saveRequest(FormPK pk,
                 String userId,
                 List<org.apache.commons.fileupload.FileItem> items)
                 throws FormsOnlineDatabaseException,
                        com.silverpeas.publicationTemplate.PublicationTemplateException,
                        com.silverpeas.form.FormException

Throws:

FormsOnlineDatabaseException

com.silverpeas.publicationTemplate.PublicationTemplateException

com.silverpeas.form.FormException

setValidationStatus

void setValidationStatus(RequestPK pk,
                         String userId,
                         String decision,
                         String comments)
                         throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

archiveRequest

void archiveRequest(RequestPK pk)
                    throws FormsOnlineDatabaseException

Throws:

FormsOnlineDatabaseException

deleteRequest

void deleteRequest(RequestPK pk)
                   throws FormsOnlineDatabaseException,
                          com.silverpeas.form.FormException,
                          com.silverpeas.publicationTemplate.PublicationTemplateException

Throws:

FormsOnlineDatabaseException

com.silverpeas.form.FormException

com.silverpeas.publicationTemplate.PublicationTemplateException