com.stratelia.webactiv.kmelia.control.ejb
Interface KmeliaBm

All Superinterfaces:

com.silverpeas.SilverpeasComponentService<KmeliaPublication>

All Known Implementing Classes:

KmeliaBmEJB

public interface KmeliaBm
extends com.silverpeas.SilverpeasComponentService<KmeliaPublication>

This is the KMelia EJB-tier controller of the MVC. It is implemented as a session EJB. It controls all the activities that happen in a client session. It also provides mechanisms to access other session EJBs.

Author:

Nicolas Eysseric

Method Summary

void	addAttachmentToPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId, String filename, String description, byte[] contents)
com.stratelia.webactiv.util.node.model.NodePK	addAxis(com.stratelia.webactiv.util.node.model.NodeDetail axis, String componentId) Add an axis
void	addInfoLinks(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, List<com.silverpeas.util.ForeignPK> links) Updates the publication links
com.stratelia.webactiv.util.node.model.NodePK	addPosition(String fatherId, com.stratelia.webactiv.util.node.model.NodeDetail position, String componentId, String userId) Add position to a axis
void	addPublicationToCombination(String pubId, List<String> combination, String componentId) Add a combination for this publication
void	addPublicationToTopic(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK fatherPK, boolean isACreation) Add a publication to a topic and send email alerts to topic subscribers
void	addPublicationToTopicWithoutNotifications(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK fatherPK, boolean isACreation)
void	addSubscription(com.stratelia.webactiv.util.node.model.NodePK topicPK, String userId) Subscriptions - add a subscription
com.stratelia.webactiv.util.node.model.NodePK	addSubTopic(com.stratelia.webactiv.util.node.model.NodePK fatherPK, com.stratelia.webactiv.util.node.model.NodeDetail subtopic, String alertType) Add a subtopic to currentTopic and alert users - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK
com.stratelia.webactiv.util.node.model.NodePK	addToTopic(com.stratelia.webactiv.util.node.model.NodePK fatherPK, com.stratelia.webactiv.util.node.model.NodeDetail subtopic) Add a subtopic to a topic - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK
void	addUploadedFilesToPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail, Collection<org.silverpeas.upload.UploadedFile> uploadedFiles)
void	changeSubTopicsOrder(String way, com.stratelia.webactiv.util.node.model.NodePK nodePK, com.stratelia.webactiv.util.node.model.NodePK fatherPK)
void	changeTopicStatus(String newStatus, com.stratelia.webactiv.util.node.model.NodePK nodePK, boolean recursiveChanges)
boolean	checkSubscription(com.stratelia.webactiv.util.node.model.NodePK topicPK, String userId)
String	clonePublication(com.stratelia.webactiv.util.publication.model.CompletePublication refPubComplete, com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail, String nextStatus) Clone CompletePublication.
com.stratelia.webactiv.util.node.model.NodeDetail	copyNode(KmeliaCopyDetail copyDetail)
com.stratelia.webactiv.util.publication.model.PublicationPK	copyPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail publi, KmeliaCopyDetail copyDetail)
void	copyPublications(KmeliaCopyDetail copyDetail)
String	createKmaxPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail) Create a new Publication (only the header - parameters)
String	createPublicationIntoTopic(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail, com.stratelia.webactiv.util.node.model.NodePK fatherPK) Create a new Publication (only the header - parameters) to the current Topic
String	createPublicationIntoTopic(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail, com.stratelia.webactiv.util.node.model.NodePK fatherPK, com.silverpeas.pdc.model.PdcClassification classification) Creates a new publication into the specified topic and with the specified classification on the PdC.
String	createTopic(String componentId, String topicId, String spaceId, String userId, String name, String description)
void	deleteAllReadingControlsByPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) delete reading controls to a publication
void	deleteAxis(String axisId, String componentId) Delete axis
void	deleteCoordinates(com.stratelia.webactiv.util.coordinates.model.CoordinatePK coordinatePK, List<String> coordinates) Delete coordinates of a publication (ie: when publication is deleted)
void	deleteInfoLinks(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, List<com.silverpeas.util.ForeignPK> links) Removes links between publications and the specified publication
void	deletePosition(String positionId, String componentId) Delete a position in an axis
void	deletePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) Delete a publication If this publication is in the basket or in the DZ, it's deleted from the database Else it only send to the basket
void	deletePublicationFromAllTopics(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) Delete a path of publication
void	deletePublicationFromCombination(String pubId, String combinationId, String componentId) Remove a combination for this publication
void	deletePublicationFromTopic(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK fatherPK) Delete a path between publication and topic
List<String>	deletePublications(List<String> ids, com.stratelia.webactiv.util.node.model.NodePK nodePK, String userId)
void	deleteSilverContent(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
void	deleteTopic(com.stratelia.webactiv.util.node.model.NodePK nodePK) Delete a topic and all descendants.
void	doAutomaticDraftOut()
void	draftInPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) Change publication status from any state to draft
void	draftInPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId)
void	draftInPublication(String componentId, String xmlFormName, String fieldName, String fieldValue)
void	draftOutPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK topicPK, String userProfile) Change publication status from draft to valid (for publisher) or toValidate (for redactor)
com.stratelia.webactiv.util.publication.model.PublicationDetail	draftOutPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK topicPK, String userProfile, boolean forceUpdateDate)
com.stratelia.webactiv.util.publication.model.PublicationDetail	draftOutPublicationWithoutNotifications(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK topicPK, String userProfile)
void	externalElementsOfPublicationHaveChanged(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId, int action) alert that an external elements of publication (wysiwyg, attachment, versioning) has been created, updated or removed
List<KmeliaPublication>	filterPublications(List<KmeliaPublication> publications, String instanceId, com.stratelia.webactiv.SilverpeasRole profile, String userId)
String	findPublicationIdBySpecificValue(String componentId, String xmlFormName, String fieldName, String fieldValue, String topicId, String spaceId, String userId)
com.stratelia.silverpeas.notificationManager.NotificationMetaData	getAlertNotificationMetaData(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK topicPK, String senderName) Send an email to alert users of a publication creation
com.stratelia.silverpeas.notificationManager.NotificationMetaData	getAlertNotificationMetaData(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, org.silverpeas.attachment.model.SimpleDocumentPK documentPk, com.stratelia.webactiv.util.node.model.NodePK topicPK, String senderName) Send an email to alert users of a attachment
Collection<com.stratelia.webactiv.util.publication.model.Alias>	getAlias(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
List<com.stratelia.webactiv.util.node.model.NodeDetail>	getAllowedSubfolders(com.stratelia.webactiv.util.node.model.NodeDetail folder, String userId)
List<String>	getAllValidators(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
List<com.stratelia.webactiv.util.node.model.NodeDetail>	getAxis(String componentId) Get list of Axis
List<com.stratelia.webactiv.util.node.model.NodeDetail>	getAxisHeaders(String componentId) Get list of Axis Headers
com.stratelia.webactiv.util.publication.model.CompletePublication	getCompletePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
com.stratelia.webactiv.util.node.model.NodeDetail	getExpandedPathToNode(com.stratelia.webactiv.util.node.model.NodePK pk, String userId)
Collection<com.stratelia.webactiv.util.node.model.NodeDetail>	getFolderChildren(com.stratelia.webactiv.util.node.model.NodePK nodePK, String userId)
KmeliaPublication	getKmaxPublication(String pubId, String currentUserId) Get a publication of a user
List<com.stratelia.webactiv.util.statistic.model.HistoryObjectDetail>	getLastAccess(com.stratelia.webactiv.util.publication.model.PublicationPK pk, com.stratelia.webactiv.util.node.model.NodePK nodePK, String excludedUserId)
List<KmeliaPublication>	getLatestPublications(String instanceId, int nbPublisOnRoot, boolean isRightsOnTopicsUsed, String userId)
List<KmeliaPublication>	getLinkedPublications(KmeliaPublication publication) Gets all the publications linked with the specified one.
List<KmeliaPublication>	getLinkedPublications(KmeliaPublication publication, String userId) Gets the publications linked with the specified one and for which the specified user is authorized to access.
Collection<String>	getModelUsed(String instanceId, String nodeId)
com.stratelia.webactiv.util.node.model.NodeDetail	getNodeHeader(String id, String componentId) Get Node Header
Collection<com.stratelia.webactiv.util.node.model.NodeDetail>	getPath(String positionId, String componentId) Get path from a position
Collection<Collection<com.stratelia.webactiv.util.node.model.NodeDetail>>	getPathList(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) Return list of all path to this publication - it's a Collection of NodeDetail collection
KmeliaPublication	getPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
Collection<com.stratelia.webactiv.util.coordinates.model.Coordinate>	getPublicationCoordinates(String pubId, String componentId) Get Collection of coordinates for a publication
com.stratelia.webactiv.util.publication.model.PublicationDetail	getPublicationDetail(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK) Return the detail of a publication (only the Header)
Collection<com.stratelia.webactiv.util.publication.model.PublicationDetail>	getPublicationDetails(List<com.silverpeas.util.ForeignPK> links)
TopicDetail	getPublicationFather(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, boolean isTreeStructureUsed, String userId, boolean isRightsOnTopicsUsed)
com.stratelia.webactiv.util.node.model.NodePK	getPublicationFatherPK(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, boolean isTreeStructureUsed, String userId, boolean isRightsOnTopicsUsed)
Collection<com.stratelia.webactiv.util.node.model.NodePK>	getPublicationFathers(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
Collection<KmeliaPublication>	getPublications(List<com.silverpeas.util.ForeignPK> links, String userId, boolean isRightsOnTopicsUsed) gets a list of authorized publications
List<KmeliaPublication>	getPublicationsOfFolder(com.stratelia.webactiv.util.node.model.NodePK pk, String userProfile, String userId, boolean isTreeStructureUsed, boolean isRightsOnTopicsUsed)
Collection<String>	getPublicationsSpecificValues(String componentId, String xmlFormName, String fieldName)
List<KmeliaPublication>	getPublicationsToValidate(String componentId, String userId)
List<com.silverpeas.form.importExport.XMLField>	getPublicationXmlFields(String publicationId, String componentId, String spaceId, String userId)
List<com.silverpeas.form.importExport.XMLField>	getPublicationXmlFields(String publicationId, String componentId, String spaceId, String userId, String language)
com.stratelia.webactiv.util.node.model.NodeDetail	getRoot(String componentId, String userId)
int	getSilverObjectId(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
Collection<Collection<com.stratelia.webactiv.util.node.model.NodeDetail>>	getSubscriptionList(String userId, String componentId) Subscriptions - get the subscription list of the current user
com.stratelia.webactiv.util.node.model.NodeDetail	getSubTopicDetail(com.stratelia.webactiv.util.node.model.NodePK nodePK) Return a subtopic to currentTopic
List<com.stratelia.webactiv.util.node.model.NodeDetail>	getTreeview(com.stratelia.webactiv.util.node.model.NodePK nodePK, String profile, boolean coWritingEnable, boolean draftVisibleWithCoWriting, String userId, boolean displayNb, boolean isRightsOnTopicsUsed)
Collection<KmeliaPublication>	getUnbalancedPublications(String componentId) Get publications with no classement
List<String>	getUserIdsOfFolder(com.stratelia.webactiv.util.node.model.NodePK pk)
String	getUserTopicProfile(com.stratelia.webactiv.util.node.model.NodePK pk, String userId)
String	getWysiwyg(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String language)
TopicDetail	goTo(com.stratelia.webactiv.util.node.model.NodePK nodePK, String userId, boolean isTreeStructureUsed, String userProfile, boolean isRightsOnTopicsUsed) Return the detail of a topic.
boolean	importPublication(String componentId, String topicId, String userId, Map<String,String> publiParams, Map<String,String> formParams, String language, String xmlFormName, String discriminantParameterName, String userProfile, boolean ignoreMissingFormFields)
boolean	importPublication(String componentId, String topicId, String spaceId, String userId, Map<String,String> publiParams, Map<String,String> formParams, String language, String xmlFormName, String discrimatingParameterName, String userProfile)
boolean	importPublication(String publicationId, String componentId, String topicId, String spaceId, String userId, Map<String,String> publiParams, Map<String,String> formParams, String language, String xmlFormName, String userProfile)
void	importPublications(String componentId, String topicId, String spaceId, String userId, List<Map<String,String>> publiParamsList, List<Map<String,String>> formParamsList, String language, String xmlFormName, String discrimatingParameterName, String userProfile)
void	indexKmax(String componentId)
void	indexKmelia(String componentId)
boolean	isPublicationVisible(com.stratelia.webactiv.util.publication.model.PublicationDetail detail, com.stratelia.webactiv.SilverpeasRole profile, String userId)
boolean	isUserCanPublish(String componentId, String userId)
boolean	isUserCanValidate(String componentId, String userId)
boolean	isUserCanValidatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId)
boolean	isUserCanWrite(String componentId, String userId)
com.stratelia.webactiv.util.node.model.NodeDetail	moveNode(com.stratelia.webactiv.util.node.model.NodePK nodePK, com.stratelia.webactiv.util.node.model.NodePK to, String userId)
void	movePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK to, String userId)
void	movePublicationInAnotherApplication(com.stratelia.webactiv.util.publication.model.PublicationDetail pub, com.stratelia.webactiv.util.node.model.NodePK to, String userId)
void	movePublicationInSameApplication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, com.stratelia.webactiv.util.node.model.NodePK from, com.stratelia.webactiv.util.node.model.NodePK to, String userId)
void	removeContentOfPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
void	removeSubscriptionToCurrentUser(com.stratelia.webactiv.util.node.model.NodePK topicPK, String userId) Subscriptions - remove a subscription to the subscription list of the current user
List<KmeliaPublication>	search(List<String> combination, int nbDays, String componentId) Get publications in a combination with time criteria
List<KmeliaPublication>	search(List<String> combination, String componentId) Get publications in a combination
void	sendModificationAlert(int modificationScope, com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
void	sendPublicationToBasket(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)
void	sendPublicationToBasket(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, boolean kmaxMode)
void	setAlias(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, List<com.stratelia.webactiv.util.publication.model.Alias> alias)
void	setModelUsed(String[] models, String instanceId, String nodeId)
void	sortSubTopics(com.stratelia.webactiv.util.node.model.NodePK fatherPK)
void	sortSubTopics(com.stratelia.webactiv.util.node.model.NodePK fatherPK, boolean recursive, String[] criteria)
void	suspendPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String refusalMotive, String userId)
void	unvalidatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId, String refusalMotive, int validationType)
void	updateAxis(com.stratelia.webactiv.util.node.model.NodeDetail axis, String componentId) Update an axis
void	updatePosition(com.stratelia.webactiv.util.node.model.NodeDetail position, String componentId) Update a position in an axis
void	updatePublication(com.stratelia.webactiv.util.publication.model.PublicationDetail detail) Update a publication (only the header - parameters)
void	updatePublication(com.stratelia.webactiv.util.publication.model.PublicationDetail detail, boolean forceUpdateDate)
void	updatePublicationEndDate(String componentId, String spaceId, String userId, String xmlFormName, String fieldName, String fieldValue, Date endDate)
com.stratelia.webactiv.util.node.model.NodePK	updateTopic(com.stratelia.webactiv.util.node.model.NodeDetail topic, String alertType) Update a subtopic to currentTopic and alert users - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK
boolean	validatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK, String userId, boolean force)

Methods inherited from interface com.silverpeas.SilverpeasComponentService

getComponentMessages, getComponentSettings, getContentById

Method Detail

goTo

TopicDetail goTo(com.stratelia.webactiv.util.node.model.NodePK nodePK,
                 String userId,
                 boolean isTreeStructureUsed,
                 String userProfile,
                 boolean isRightsOnTopicsUsed)

Return the detail of a topic.

Parameters:

nodePK -

userId -

isTreeStructureUsed -

userProfile -

isRightsOnTopicsUsed -

Returns:

the detail of a topic.

getAllowedSubfolders

List<com.stratelia.webactiv.util.node.model.NodeDetail> getAllowedSubfolders(com.stratelia.webactiv.util.node.model.NodeDetail folder,
                                                                             String userId)

addToTopic

com.stratelia.webactiv.util.node.model.NodePK addToTopic(com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                                                         com.stratelia.webactiv.util.node.model.NodeDetail subtopic)

Add a subtopic to a topic - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Parameters:

fatherPK - the topic Id of the future father

subtopic - the NodeDetail of the new sub topic

Returns:

If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Since:

1.0

See Also:

NodeDetail, NodePK

addSubTopic

com.stratelia.webactiv.util.node.model.NodePK addSubTopic(com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                                                          com.stratelia.webactiv.util.node.model.NodeDetail subtopic,
                                                          String alertType)

Add a subtopic to currentTopic and alert users - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Parameters:

subtopic - the NodeDetail of the new sub topic

alertType - Alert all users, only publishers or nobody of the topic creation alertType = "All"|"Publisher"|"None"

Returns:

If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Since:

1.0

See Also:

NodeDetail, NodePK

updateTopic

com.stratelia.webactiv.util.node.model.NodePK updateTopic(com.stratelia.webactiv.util.node.model.NodeDetail topic,
                                                          String alertType)

Update a subtopic to currentTopic and alert users - If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Parameters:

topic - the NodeDetail of the updated sub topic

alertType - Alert all users, only publishers or nobody of the topic creation alertType = "All"|"Publisher"|"None"

Returns:

If a subtopic of same name already exists a NodePK with id=-1 is returned else the new topic NodePK

Since:

1.0

See Also:

NodeDetail, NodePK

getSubTopicDetail

com.stratelia.webactiv.util.node.model.NodeDetail getSubTopicDetail(com.stratelia.webactiv.util.node.model.NodePK nodePK)

Return a subtopic to currentTopic

Parameters:

nodePK - the id of the researched topic

Returns:

the detail of the specified topic

Since:

1.0

See Also:

NodeDetail

deleteTopic

void deleteTopic(com.stratelia.webactiv.util.node.model.NodePK nodePK)

Delete a topic and all descendants. Delete all links between descendants and publications. This publications will be visible in the Declassified zone. Delete All subscriptions and favorites on this topics and all descendants

Parameters:

nodePK - the id of the topic to delete

Since:

1.0

changeSubTopicsOrder

void changeSubTopicsOrder(String way,
                          com.stratelia.webactiv.util.node.model.NodePK nodePK,
                          com.stratelia.webactiv.util.node.model.NodePK fatherPK)

changeTopicStatus

void changeTopicStatus(String newStatus,
                       com.stratelia.webactiv.util.node.model.NodePK nodePK,
                       boolean recursiveChanges)

sortSubTopics

void sortSubTopics(com.stratelia.webactiv.util.node.model.NodePK fatherPK)

sortSubTopics

void sortSubTopics(com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                   boolean recursive,
                   String[] criteria)

getTreeview

List<com.stratelia.webactiv.util.node.model.NodeDetail> getTreeview(com.stratelia.webactiv.util.node.model.NodePK nodePK,
                                                                    String profile,
                                                                    boolean coWritingEnable,
                                                                    boolean draftVisibleWithCoWriting,
                                                                    String userId,
                                                                    boolean displayNb,
                                                                    boolean isRightsOnTopicsUsed)

getSubscriptionList

Collection<Collection<com.stratelia.webactiv.util.node.model.NodeDetail>> getSubscriptionList(String userId,
                                                                                              String componentId)

Subscriptions - get the subscription list of the current user

Returns:

a Path Collection - it's a Collection of NodeDetail collection

Since:

1.0

See Also:

NodeDetail

removeSubscriptionToCurrentUser

void removeSubscriptionToCurrentUser(com.stratelia.webactiv.util.node.model.NodePK topicPK,
                                     String userId)

Subscriptions - remove a subscription to the subscription list of the current user

Parameters:

topicPK - the subscribe topic Id to remove

Since:

1.0

addSubscription

void addSubscription(com.stratelia.webactiv.util.node.model.NodePK topicPK,
                     String userId)

Subscriptions - add a subscription

Parameters:

topicPK - the subscription topic Id to add

Since:

1.0

checkSubscription

boolean checkSubscription(com.stratelia.webactiv.util.node.model.NodePK topicPK,
                          String userId)

getPublicationDetail

com.stratelia.webactiv.util.publication.model.PublicationDetail getPublicationDetail(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

Return the detail of a publication (only the Header)

Parameters:

pubPK - the id of the publication

Returns:

a PublicationDetail

Since:

1.0

See Also:

PublicationDetail

getPublicationsOfFolder

List<KmeliaPublication> getPublicationsOfFolder(com.stratelia.webactiv.util.node.model.NodePK pk,
                                                String userProfile,
                                                String userId,
                                                boolean isTreeStructureUsed,
                                                boolean isRightsOnTopicsUsed)

getLatestPublications

List<KmeliaPublication> getLatestPublications(String instanceId,
                                              int nbPublisOnRoot,
                                              boolean isRightsOnTopicsUsed,
                                              String userId)

getPathList

Collection<Collection<com.stratelia.webactiv.util.node.model.NodeDetail>> getPathList(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

Return list of all path to this publication - it's a Collection of NodeDetail collection

Parameters:

pubPK - the id of the publication

Returns:

a Collection of NodeDetail collection

Since:

1.0

See Also:

NodeDetail

getPublicationFathers

Collection<com.stratelia.webactiv.util.node.model.NodePK> getPublicationFathers(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

createPublicationIntoTopic

String createPublicationIntoTopic(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail,
                                  com.stratelia.webactiv.util.node.model.NodePK fatherPK)

Create a new Publication (only the header - parameters) to the current Topic

Parameters:

pubDetail - a PublicationDetail

Returns:

the id of the new publication

Since:

1.0

See Also:

PublicationDetail

createPublicationIntoTopic

String createPublicationIntoTopic(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail,
                                  com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                                  com.silverpeas.pdc.model.PdcClassification classification)

Creates a new publication into the specified topic and with the specified classification on the PdC.

Parameters:

pubDetail - the detail about the publication to create.

fatherPK - the unique identifier of the topic into which the publication is published.

classification - the classification on the PdC of the publication content.

Returns:

the unique identifier of the created publication.

updatePublication

void updatePublication(com.stratelia.webactiv.util.publication.model.PublicationDetail detail)

Update a publication (only the header - parameters)

Parameters:

detail - a PublicationDetail

Since:

1.0

See Also:

PublicationDetail

updatePublication

void updatePublication(com.stratelia.webactiv.util.publication.model.PublicationDetail detail,
                       boolean forceUpdateDate)

deletePublication

void deletePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

Delete a publication If this publication is in the basket or in the DZ, it's deleted from the database Else it only send to the basket

Parameters:

pubPK - the id of the publication to delete

Since:

1.0

See Also:

TopicDetail

sendPublicationToBasket

void sendPublicationToBasket(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

sendPublicationToBasket

void sendPublicationToBasket(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                             boolean kmaxMode)

addPublicationToTopic

void addPublicationToTopic(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                           com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                           boolean isACreation)

Add a publication to a topic and send email alerts to topic subscribers

Parameters:

pubPK - the id of the publication

fatherPK - the id of the topic

Since:

1.0

addPublicationToTopicWithoutNotifications

void addPublicationToTopicWithoutNotifications(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                               com.stratelia.webactiv.util.node.model.NodePK fatherPK,
                                               boolean isACreation)

deletePublicationFromTopic

void deletePublicationFromTopic(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                com.stratelia.webactiv.util.node.model.NodePK fatherPK)

Delete a path between publication and topic

Parameters:

pubPK - the id of the publication

fatherPK - the id of the topic

Since:

1.0

deletePublicationFromAllTopics

void deletePublicationFromAllTopics(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

Delete a path of publication

Parameters:

pubPK - the id of the publication

Since:

1.0

addInfoLinks

void addInfoLinks(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                  List<com.silverpeas.util.ForeignPK> links)

Updates the publication links

Parameters:

pubPK - publication identifier which you want to update links

links - list of publication to link with current.

deleteInfoLinks

void deleteInfoLinks(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                     List<com.silverpeas.util.ForeignPK> links)

Removes links between publications and the specified publication

Parameters:

pubPK -

links - list of links to remove

getCompletePublication

com.stratelia.webactiv.util.publication.model.CompletePublication getCompletePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

getPublication

KmeliaPublication getPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

getPublicationFather

TopicDetail getPublicationFather(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                 boolean isTreeStructureUsed,
                                 String userId,
                                 boolean isRightsOnTopicsUsed)

getPublicationFatherPK

com.stratelia.webactiv.util.node.model.NodePK getPublicationFatherPK(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                                                     boolean isTreeStructureUsed,
                                                                     String userId,
                                                                     boolean isRightsOnTopicsUsed)

getPublicationDetails

Collection<com.stratelia.webactiv.util.publication.model.PublicationDetail> getPublicationDetails(List<com.silverpeas.util.ForeignPK> links)

getPublications

Collection<KmeliaPublication> getPublications(List<com.silverpeas.util.ForeignPK> links,
                                              String userId,
                                              boolean isRightsOnTopicsUsed)

gets a list of authorized publications

Parameters:

links - list of publication defined by his id and component id

userId - identifier User. allow to check if the publication is accessible for current user

isRightsOnTopicsUsed - indicates if the right must be checked

Returns:

a collection of Kmelia publications

Since:

1.0

getLinkedPublications

List<KmeliaPublication> getLinkedPublications(KmeliaPublication publication,
                                              String userId)

Gets the publications linked with the specified one and for which the specified user is authorized to access.

Parameters:

publication - the publication from which linked publications are get.

userId - the unique identifier of a user. It allows to check if a linked publication is accessible for the specified user.

Returns:

a list of Kmelia publications.

getLinkedPublications

List<KmeliaPublication> getLinkedPublications(KmeliaPublication publication)

Gets all the publications linked with the specified one.

Parameters:

publication - the publication from which linked publications are get.

Returns:

a list of Kmelia publications.

getPublicationsToValidate

List<KmeliaPublication> getPublicationsToValidate(String componentId,
                                                  String userId)

isUserCanValidatePublication

boolean isUserCanValidatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                     String userId)

getAllValidators

List<String> getAllValidators(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

validatePublication

boolean validatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                            String userId,
                            boolean force)

Parameters:

pubPK - id of the publication to validate. If publication is always visible, clone is processed.

userId - id of the user who validate

force - if true, force to validate publication (bypass pending validations)

Returns:

true if the validation process is complete (ie all validators have validate)

unvalidatePublication

void unvalidatePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                           String userId,
                           String refusalMotive,
                           int validationType)

suspendPublication

void suspendPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                        String refusalMotive,
                        String userId)

draftOutPublication

void draftOutPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                         com.stratelia.webactiv.util.node.model.NodePK topicPK,
                         String userProfile)

Change publication status from draft to valid (for publisher) or toValidate (for redactor)

Parameters:

pubPK - the id of the publication

draftOutPublicationWithoutNotifications

com.stratelia.webactiv.util.publication.model.PublicationDetail draftOutPublicationWithoutNotifications(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                                                                                        com.stratelia.webactiv.util.node.model.NodePK topicPK,
                                                                                                        String userProfile)

draftOutPublication

com.stratelia.webactiv.util.publication.model.PublicationDetail draftOutPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                                                                    com.stratelia.webactiv.util.node.model.NodePK topicPK,
                                                                                    String userProfile,
                                                                                    boolean forceUpdateDate)

draftInPublication

void draftInPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

Change publication status from any state to draft

Parameters:

pubPK - the id of the publication

draftInPublication

void draftInPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                        String userId)

movePublication

void movePublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                     com.stratelia.webactiv.util.node.model.NodePK to,
                     String userId)

movePublicationInSameApplication

void movePublicationInSameApplication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                      com.stratelia.webactiv.util.node.model.NodePK from,
                                      com.stratelia.webactiv.util.node.model.NodePK to,
                                      String userId)

movePublicationInAnotherApplication

void movePublicationInAnotherApplication(com.stratelia.webactiv.util.publication.model.PublicationDetail pub,
                                         com.stratelia.webactiv.util.node.model.NodePK to,
                                         String userId)

externalElementsOfPublicationHaveChanged

void externalElementsOfPublicationHaveChanged(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                              String userId,
                                              int action)

alert that an external elements of publication (wysiwyg, attachment, versioning) has been created, updated or removed

Parameters:

pubPK - - id of the publication which contains this external elements

sendModificationAlert

void sendModificationAlert(int modificationScope,
                           com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

getAlertNotificationMetaData

com.stratelia.silverpeas.notificationManager.NotificationMetaData getAlertNotificationMetaData(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                                                                               com.stratelia.webactiv.util.node.model.NodePK topicPK,
                                                                                               String senderName)

Send an email to alert users of a publication creation

Parameters:

pubPK - the publication Id

getAlertNotificationMetaData

com.stratelia.silverpeas.notificationManager.NotificationMetaData getAlertNotificationMetaData(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                                                                               org.silverpeas.attachment.model.SimpleDocumentPK documentPk,
                                                                                               com.stratelia.webactiv.util.node.model.NodePK topicPK,
                                                                                               String senderName)

Send an email to alert users of a attachment

Parameters:

pubPK - the publication Id

deleteAllReadingControlsByPublication

void deleteAllReadingControlsByPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

delete reading controls to a publication

Parameters:

pubPK - the id of a publication

Since:

1.0

indexKmelia

void indexKmelia(String componentId)

getSilverObjectId

int getSilverObjectId(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

deleteSilverContent

void deleteSilverContent(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

getWysiwyg

String getWysiwyg(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                  String language)

setModelUsed

void setModelUsed(String[] models,
                  String instanceId,
                  String nodeId)

getModelUsed

Collection<String> getModelUsed(String instanceId,
                                String nodeId)

getAxis

List<com.stratelia.webactiv.util.node.model.NodeDetail> getAxis(String componentId)

Get list of Axis

Parameters:

componentId -

Returns:

List of Axis

getAxisHeaders

List<com.stratelia.webactiv.util.node.model.NodeDetail> getAxisHeaders(String componentId)

Get list of Axis Headers

Parameters:

componentId -

Returns:

List of Axis Headers

addAxis

com.stratelia.webactiv.util.node.model.NodePK addAxis(com.stratelia.webactiv.util.node.model.NodeDetail axis,
                                                      String componentId)

Add an axis

Parameters:

axis -

componentId -

Returns:

updateAxis

void updateAxis(com.stratelia.webactiv.util.node.model.NodeDetail axis,
                String componentId)

Update an axis

Parameters:

axis -

componentId -

deleteAxis

void deleteAxis(String axisId,
                String componentId)

Delete axis

Parameters:

axisId -

componentId -

getNodeHeader

com.stratelia.webactiv.util.node.model.NodeDetail getNodeHeader(String id,
                                                                String componentId)

Get Node Header

Parameters:

id -

componentId -

Returns:

NodeDetail

addPosition

com.stratelia.webactiv.util.node.model.NodePK addPosition(String fatherId,
                                                          com.stratelia.webactiv.util.node.model.NodeDetail position,
                                                          String componentId,
                                                          String userId)

Add position to a axis

Parameters:

fatherId -

position -

componentId -

userId -

Returns:

NodePK

updatePosition

void updatePosition(com.stratelia.webactiv.util.node.model.NodeDetail position,
                    String componentId)

Update a position in an axis

Parameters:

position -

componentId -

deletePosition

void deletePosition(String positionId,
                    String componentId)

Delete a position in an axis

Parameters:

positionId -

componentId -

getPath

Collection<com.stratelia.webactiv.util.node.model.NodeDetail> getPath(String positionId,
                                                                      String componentId)

Get path from a position

Parameters:

positionId -

componentId -

Returns:

search

List<KmeliaPublication> search(List<String> combination,
                               String componentId)

Get publications in a combination

Parameters:

combination -

componentId -

Returns:

Collection of publication

search

List<KmeliaPublication> search(List<String> combination,
                               int nbDays,
                               String componentId)

Get publications in a combination with time criteria

Parameters:

combination -

componentId -

Returns:

Collection of publication

getUnbalancedPublications

Collection<KmeliaPublication> getUnbalancedPublications(String componentId)

Get publications with no classement

Parameters:

componentId -

Returns:

Collection of publication

indexKmax

void indexKmax(String componentId)

getKmaxPublication

KmeliaPublication getKmaxPublication(String pubId,
                                     String currentUserId)

Get a publication of a user

Parameters:

pubId - , pubId

Returns:

a Kmelia publication

getPublicationCoordinates

Collection<com.stratelia.webactiv.util.coordinates.model.Coordinate> getPublicationCoordinates(String pubId,
                                                                                               String componentId)

Get Collection of coordinates for a publication

Parameters:

pubId - , componentId

Returns:

a collection of coordinates

addPublicationToCombination

void addPublicationToCombination(String pubId,
                                 List<String> combination,
                                 String componentId)

Add a combination for this publication

Parameters:

pubId - , combination, componentId

deletePublicationFromCombination

void deletePublicationFromCombination(String pubId,
                                      String combinationId,
                                      String componentId)

Remove a combination for this publication

Parameters:

pubId - , combinationId, componentId

createKmaxPublication

String createKmaxPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail)

Create a new Publication (only the header - parameters)

Parameters:

pubDetail - a PublicationDetail

Returns:

the id of the new publication

Since:

1.0

See Also:

PublicationDetail

deleteCoordinates

void deleteCoordinates(com.stratelia.webactiv.util.coordinates.model.CoordinatePK coordinatePK,
                       List<String> coordinates)

Delete coordinates of a publication (ie: when publication is deleted)

Parameters:

coordinatePK -

coordinates -

getAlias

Collection<com.stratelia.webactiv.util.publication.model.Alias> getAlias(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

setAlias

void setAlias(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
              List<com.stratelia.webactiv.util.publication.model.Alias> alias)

addUploadedFilesToPublication

void addUploadedFilesToPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail,
                                   Collection<org.silverpeas.upload.UploadedFile> uploadedFiles)

addAttachmentToPublication

void addAttachmentToPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK,
                                String userId,
                                String filename,
                                String description,
                                byte[] contents)

importPublication

boolean importPublication(String componentId,
                          String topicId,
                          String spaceId,
                          String userId,
                          Map<String,String> publiParams,
                          Map<String,String> formParams,
                          String language,
                          String xmlFormName,
                          String discrimatingParameterName,
                          String userProfile)

importPublication

boolean importPublication(String componentId,
                          String topicId,
                          String userId,
                          Map<String,String> publiParams,
                          Map<String,String> formParams,
                          String language,
                          String xmlFormName,
                          String discriminantParameterName,
                          String userProfile,
                          boolean ignoreMissingFormFields)

importPublication

boolean importPublication(String publicationId,
                          String componentId,
                          String topicId,
                          String spaceId,
                          String userId,
                          Map<String,String> publiParams,
                          Map<String,String> formParams,
                          String language,
                          String xmlFormName,
                          String userProfile)

importPublications

void importPublications(String componentId,
                        String topicId,
                        String spaceId,
                        String userId,
                        List<Map<String,String>> publiParamsList,
                        List<Map<String,String>> formParamsList,
                        String language,
                        String xmlFormName,
                        String discrimatingParameterName,
                        String userProfile)

getPublicationXmlFields

List<com.silverpeas.form.importExport.XMLField> getPublicationXmlFields(String publicationId,
                                                                        String componentId,
                                                                        String spaceId,
                                                                        String userId)

getPublicationXmlFields

List<com.silverpeas.form.importExport.XMLField> getPublicationXmlFields(String publicationId,
                                                                        String componentId,
                                                                        String spaceId,
                                                                        String userId,
                                                                        String language)

createTopic

String createTopic(String componentId,
                   String topicId,
                   String spaceId,
                   String userId,
                   String name,
                   String description)

getPublicationsSpecificValues

Collection<String> getPublicationsSpecificValues(String componentId,
                                                 String xmlFormName,
                                                 String fieldName)

draftInPublication

void draftInPublication(String componentId,
                        String xmlFormName,
                        String fieldName,
                        String fieldValue)

updatePublicationEndDate

void updatePublicationEndDate(String componentId,
                              String spaceId,
                              String userId,
                              String xmlFormName,
                              String fieldName,
                              String fieldValue,
                              Date endDate)

findPublicationIdBySpecificValue

String findPublicationIdBySpecificValue(String componentId,
                                        String xmlFormName,
                                        String fieldName,
                                        String fieldValue,
                                        String topicId,
                                        String spaceId,
                                        String userId)

doAutomaticDraftOut

void doAutomaticDraftOut()

clonePublication

String clonePublication(com.stratelia.webactiv.util.publication.model.CompletePublication refPubComplete,
                        com.stratelia.webactiv.util.publication.model.PublicationDetail pubDetail,
                        String nextStatus)

Clone CompletePublication. Create new publication based on pubDetail object if not null or CompletePublication otherwise. Original publication will not be modified (except references to clone : cloneId and cloneStatus).

Parameters:

pubDetail - If not null, attribute values are set to the clone

nextStatus - Draft or Clone

Returns:

removeContentOfPublication

void removeContentOfPublication(com.stratelia.webactiv.util.publication.model.PublicationPK pubPK)

getRoot

com.stratelia.webactiv.util.node.model.NodeDetail getRoot(String componentId,
                                                          String userId)

getFolderChildren

Collection<com.stratelia.webactiv.util.node.model.NodeDetail> getFolderChildren(com.stratelia.webactiv.util.node.model.NodePK nodePK,
                                                                                String userId)

getExpandedPathToNode

com.stratelia.webactiv.util.node.model.NodeDetail getExpandedPathToNode(com.stratelia.webactiv.util.node.model.NodePK pk,
                                                                        String userId)

isUserCanWrite

boolean isUserCanWrite(String componentId,
                       String userId)

isUserCanValidate

boolean isUserCanValidate(String componentId,
                          String userId)

isUserCanPublish

boolean isUserCanPublish(String componentId,
                         String userId)

getUserTopicProfile

String getUserTopicProfile(com.stratelia.webactiv.util.node.model.NodePK pk,
                           String userId)

deletePublications

List<String> deletePublications(List<String> ids,
                                com.stratelia.webactiv.util.node.model.NodePK nodePK,
                                String userId)

getUserIdsOfFolder

List<String> getUserIdsOfFolder(com.stratelia.webactiv.util.node.model.NodePK pk)

getLastAccess

List<com.stratelia.webactiv.util.statistic.model.HistoryObjectDetail> getLastAccess(com.stratelia.webactiv.util.publication.model.PublicationPK pk,
                                                                                    com.stratelia.webactiv.util.node.model.NodePK nodePK,
                                                                                    String excludedUserId)

copyNode

com.stratelia.webactiv.util.node.model.NodeDetail copyNode(KmeliaCopyDetail copyDetail)

copyPublications

void copyPublications(KmeliaCopyDetail copyDetail)

copyPublication

com.stratelia.webactiv.util.publication.model.PublicationPK copyPublication(com.stratelia.webactiv.util.publication.model.PublicationDetail publi,
                                                                            KmeliaCopyDetail copyDetail)

moveNode

com.stratelia.webactiv.util.node.model.NodeDetail moveNode(com.stratelia.webactiv.util.node.model.NodePK nodePK,
                                                           com.stratelia.webactiv.util.node.model.NodePK to,
                                                           String userId)

filterPublications

List<KmeliaPublication> filterPublications(List<KmeliaPublication> publications,
                                           String instanceId,
                                           com.stratelia.webactiv.SilverpeasRole profile,
                                           String userId)

isPublicationVisible

boolean isPublicationVisible(com.stratelia.webactiv.util.publication.model.PublicationDetail detail,
                             com.stratelia.webactiv.SilverpeasRole profile,
                             String userId)