com.stratelia.webactiv.util.publication.control
Interface PublicationBm

All Known Implementing Classes:

PublicationBmEJB

public interface PublicationBm

Interface declaration

Author:

Method Summary

void	addAlias(PublicationPK pubPK, List<Alias> alias)
void	addFather(PublicationPK pubPK, NodePK fatherPK) add a new father (designed by "fatherPK") to a publication ("pubPK") The publication will be visible from its new father node.
void	addLinks(PublicationPK pubPK, List<ForeignPK> links) Updates the publication links
void	addValidationStep(ValidationStep step)
void	changePublicationOrder(PublicationPK pubPK, NodePK nodePK, int direction) Change order of the given publication identified by pubPK in the given nodePK. direction less than 0 means "up" else it means "down"
void	changePublicationsOrder(List<String> ids, NodePK nodePK)
void	createIndex(PublicationDetail pubDetail)
void	createIndex(PublicationPK pubPK) Method declaration
PublicationPK	createPublication(PublicationDetail detail) Create a new publication A new line will be added in publication table.
void	deleteIndex(PublicationPK pubPK) Method declaration
void	deleteInfoLinks(PublicationPK pubPK, List<ForeignPK> links)
void	deleteOrphanPublicationsByCreatorId(PublicationPK pubPK, String creatorId) Method declaration
Collection<Alias>	getAlias(PublicationPK pubPK) return the publication's collection of Alias
Collection<NodePK>	getAllFatherPK(PublicationPK pubPK) return a collection, containing all node primary key from where the publication is visible
Collection<PublicationDetail>	getAllPublications(PublicationPK pubPK) Method declaration
Collection<PublicationDetail>	getAllPublications(PublicationPK pubPK, String sorting)
List<SocialInformation>	getAllPublicationsWithStatusbyUserid(String userId, Date begin, Date end)
CompletePublication	getCompletePublication(PublicationPK pubPK)
Collection<Coordinate>	getCoordinates(String pubId, String componentId)
PublicationDetail	getDetail(PublicationPK pubPK) get details on the publication specified by the primary key given in pubPK parameter
Collection<PublicationDetail>	getDetailBetweenDate(String beginDate, String endDate, String instanceId)
PublicationDetail	getDetailByName(PublicationPK pubPK, String pubName) Looking for, in the instance identified by pubPK, a publication named pubName.
PublicationDetail	getDetailByNameAndNodeId(PublicationPK pubPK, String pubName, int nodeId)
Collection<PublicationDetail>	getDetailsByBeginDateDesc(PublicationPK pk, int nbPubs) return a PublicationDetail collection of x last publications
Collection<PublicationDetail>	getDetailsByBeginDateDescAndStatus(PublicationPK pk, String status, int nbPubs) return a PublicationDetail collection of x last publications
Collection<PublicationDetail>	getDetailsByBeginDateDescAndStatusAndNotLinkedToFatherId(PublicationPK pk, String status, int nbPubs, String fatherId) Method declaration
Collection<PublicationDetail>	getDetailsByFatherIds(List<String> fatherIds, PublicationPK pubPK) Method declaration
Collection<PublicationDetail>	getDetailsByFatherIds(List<String> fatherIds, PublicationPK pubPK, boolean filterOnVisibilityPeriod)
Collection<PublicationDetail>	getDetailsByFatherIds(List<String> fatherIds, PublicationPK pubPK, String sorting)
Collection<PublicationDetail>	getDetailsByFatherIdsAndStatus(List<String> fatherIds, PublicationPK pubPK, String sorting, String status)
Collection<PublicationDetail>	getDetailsByFatherIdsAndStatusList(List<String> fatherIds, PublicationPK pubPK, String sorting, List<String> status)
Collection<PublicationDetail>	getDetailsByFatherIdsAndStatusList(List<String> fatherIds, PublicationPK pubPK, String sorting, List<String> status, boolean filterOnVisibilityPeriod)
Collection<PublicationDetail>	getDetailsByFatherPK(NodePK fatherPK) return a PublicationDetail collection of all publication visible from the node identified by "fatherPK" parameter
Collection<PublicationDetail>	getDetailsByFatherPK(NodePK fatherPK, String sorting)
Collection<PublicationDetail>	getDetailsByFatherPK(NodePK fatherPK, String sorting, boolean filterOnVisibilityPeriod)
Collection<PublicationDetail>	getDetailsByFatherPK(NodePK fatherPK, String sorting, boolean filterOnVisibilityPeriod, String userId)
Collection<PublicationDetail>	getDetailsNotInFatherPK(NodePK fatherPK) return a PublicationDetail collection of all publications not in the node identified by "fatherPK" parameter
Collection<PublicationDetail>	getDetailsNotInFatherPK(NodePK fatherPK, String sorting)
Map<String,Integer>	getDistributionTree(String instanceId, String statusSubQuery, boolean checkVisibility) * Return the tree of nodes with the number of publication per node.
Collection<PublicationDetail>	getDraftsByUser(String userId) get all publications of given user in state 'Draft'.
int	getNbPubByFatherPath(NodePK fatherPK, String fatherPath) Method declaration
int	getNbPubInFatherPKs(Collection<NodePK> fatherPKs) Method declaration
Collection<PublicationDetail>	getNotOrphanPublications(PublicationPK pubPK) return the Detail of publication which are linked to at least one father
Collection<PublicationDetail>	getOrphanPublications(PublicationPK pubPK) return the Detail of publication which are not linked to a father
Collection<PublicationPK>	getPublicationPKsByStatus(String status, List<String> componentIds)
Collection<PublicationDetail>	getPublications(Collection<PublicationPK> publicationPKs)
Collection<PublicationDetail>	getPublicationsByStatus(String status, List<String> componentIds)
Collection<PublicationDetail>	getPublicationsByStatus(String status, PublicationPK pubPK) Method declaration
Collection<PublicationDetail>	getPublicationsToDraftOut(boolean useClone)
Collection<PublicationPK>	getPubPKsInFatherPK(NodePK fatherPK) Method declaration
Collection<PublicationPK>	getPubPKsInFatherPKs(Collection<WAPrimaryKey> fatherPKs) Method declaration
List<SocialInformationPublication>	getSocialInformationsListOfMyContacts(List<String> myContactsIds, List<String> options, Date begin, Date end) get list of socialInformation of my contacts according to options and number of Item and the first Index
Collection<PublicationDetail>	getUnavailablePublicationsByPublisherId(PublicationPK pubPK, String publisherId, String nodeId) return the publications : - which take place in the basket - which are out of the visibility period
Collection<PublicationPK>	getUpdatedPublicationPKsByStatus(String status, Date since, int maxSize, List<String> componentIds) Return the list of publications with a maxSize as specified, each publication has the specified status and has been updated since the specified date
ValidationStep	getValidationStepByUser(PublicationPK pubPK, String userId)
List<ValidationStep>	getValidationSteps(PublicationPK pubPK)
void	movePublication(PublicationPK pubPK, NodePK nodePK, boolean indexIt)
void	processWysiwyg(PublicationPK pubPK) A wysiwyg's content has been added or modified to a publication.
void	removeAlias(PublicationPK pubPK, List<Alias> alias)
void	removeAllFather(PublicationPK pubPK) remove all father from a publication ("pubPK") The publication won't be visible.
void	removeFather(NodePK fatherPK) remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.
void	removeFather(PublicationPK pubPK, NodePK fatherPK) remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.
void	removeFathers(PublicationPK pubPK, Collection<String> fatherIds) remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.
void	removePublication(PublicationPK pubPK) remove the publication designed by pubPK parameter.
void	removeValidationSteps(PublicationPK pubPK)
Collection<PublicationDetail>	searchByKeywords(String query, PublicationPK pubPK) Method declaration
List<Alias>	setAlias(PublicationPK pubPK, List<Alias> alias)
void	setDetail(PublicationDetail detaile) update the publication content.
void	setDetail(PublicationDetail detaile, boolean forceUpdateDate)

Method Detail

getDetail

PublicationDetail getDetail(PublicationPK pubPK)

get details on the publication specified by the primary key given in pubPK parameter

createPublication

PublicationPK createPublication(PublicationDetail detail)

Create a new publication A new line will be added in publication table. The "id" in "detail" is not used (a new one will be computed). The "ed" is used to know the table name.

movePublication

void movePublication(PublicationPK pubPK,
                     NodePK nodePK,
                     boolean indexIt)

changePublicationOrder

void changePublicationOrder(PublicationPK pubPK,
                            NodePK nodePK,
                            int direction)

Change order of the given publication identified by pubPK in the given nodePK. direction less than 0 means "up" else it means "down"

Parameters:

pubPK - the publication's id to move

nodePK - the publication's place

direction - must be different to 0

removePublication

void removePublication(PublicationPK pubPK)

remove the publication designed by pubPK parameter.

setDetail

void setDetail(PublicationDetail detaile)

update the publication content.

setDetail

void setDetail(PublicationDetail detaile,
               boolean forceUpdateDate)

addFather

void addFather(PublicationPK pubPK,
               NodePK fatherPK)

add a new father (designed by "fatherPK") to a publication ("pubPK") The publication will be visible from its new father node.

removeFather

void removeFather(PublicationPK pubPK,
                  NodePK fatherPK)

remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.

removeFather

void removeFather(NodePK fatherPK)

remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.

removeFathers

void removeFathers(PublicationPK pubPK,
                   Collection<String> fatherIds)

remove a father (designed by "fatherPK") from a publication ("pubPK") The publication won't be visible from its old father node.

removeAllFather

void removeAllFather(PublicationPK pubPK)

remove all father from a publication ("pubPK") The publication won't be visible.

getOrphanPublications

Collection<PublicationDetail> getOrphanPublications(PublicationPK pubPK)

return the Detail of publication which are not linked to a father

getNotOrphanPublications

Collection<PublicationDetail> getNotOrphanPublications(PublicationPK pubPK)

return the Detail of publication which are linked to at least one father

deleteOrphanPublicationsByCreatorId

void deleteOrphanPublicationsByCreatorId(PublicationPK pubPK,
                                         String creatorId)

Method declaration

Parameters:

pubPK -

creatorId -

See Also:

getUnavailablePublicationsByPublisherId

Collection<PublicationDetail> getUnavailablePublicationsByPublisherId(PublicationPK pubPK,
                                                                      String publisherId,
                                                                      String nodeId)

return the publications : - which take place in the basket - which are out of the visibility period

getAllFatherPK

Collection<NodePK> getAllFatherPK(PublicationPK pubPK)

return a collection, containing all node primary key from where the publication is visible

getAlias

Collection<Alias> getAlias(PublicationPK pubPK)

return the publication's collection of Alias

setAlias

List<Alias> setAlias(PublicationPK pubPK,
                     List<Alias> alias)

addAlias

void addAlias(PublicationPK pubPK,
              List<Alias> alias)

removeAlias

void removeAlias(PublicationPK pubPK,
                 List<Alias> alias)

getDetailsByFatherPK

Collection<PublicationDetail> getDetailsByFatherPK(NodePK fatherPK)

return a PublicationDetail collection of all publication visible from the node identified by "fatherPK" parameter

getDetailsByFatherPK

Collection<PublicationDetail> getDetailsByFatherPK(NodePK fatherPK,
                                                   String sorting)

getDetailsByFatherPK

Collection<PublicationDetail> getDetailsByFatherPK(NodePK fatherPK,
                                                   String sorting,
                                                   boolean filterOnVisibilityPeriod)

getDetailsByFatherPK

Collection<PublicationDetail> getDetailsByFatherPK(NodePK fatherPK,
                                                   String sorting,
                                                   boolean filterOnVisibilityPeriod,
                                                   String userId)

getDetailsNotInFatherPK

Collection<PublicationDetail> getDetailsNotInFatherPK(NodePK fatherPK)

return a PublicationDetail collection of all publications not in the node identified by "fatherPK" parameter

getDetailsNotInFatherPK

Collection<PublicationDetail> getDetailsNotInFatherPK(NodePK fatherPK,
                                                      String sorting)

getDetailsByBeginDateDescAndStatus

Collection<PublicationDetail> getDetailsByBeginDateDescAndStatus(PublicationPK pk,
                                                                 String status,
                                                                 int nbPubs)

return a PublicationDetail collection of x last publications

getDetailsByBeginDateDesc

Collection<PublicationDetail> getDetailsByBeginDateDesc(PublicationPK pk,
                                                        int nbPubs)

return a PublicationDetail collection of x last publications

getDetailsByBeginDateDescAndStatusAndNotLinkedToFatherId

Collection<PublicationDetail> getDetailsByBeginDateDescAndStatusAndNotLinkedToFatherId(PublicationPK pk,
                                                                                       String status,
                                                                                       int nbPubs,
                                                                                       String fatherId)

Method declaration

Parameters:

pk -

status -

nbPubs -

fatherId -

Returns:

See Also:

deleteInfoLinks

void deleteInfoLinks(PublicationPK pubPK,
                     List<ForeignPK> links)

getCompletePublication

CompletePublication getCompletePublication(PublicationPK pubPK)

Parameters:

pubPK -

Returns:

getPublications

Collection<PublicationDetail> getPublications(Collection<PublicationPK> publicationPKs)

Parameters:

publicationPKs -

Returns:

getPublicationsByStatus

Collection<PublicationDetail> getPublicationsByStatus(String status,
                                                      PublicationPK pubPK)

Method declaration

Parameters:

status -

pubPK -

Returns:

See Also:

getPublicationPKsByStatus

Collection<PublicationPK> getPublicationPKsByStatus(String status,
                                                    List<String> componentIds)

getUpdatedPublicationPKsByStatus

Collection<PublicationPK> getUpdatedPublicationPKsByStatus(String status,
                                                           Date since,
                                                           int maxSize,
                                                           List<String> componentIds)

Return the list of publications with a maxSize as specified, each publication has the specified status and has been updated since the specified date

Parameters:

status - : the publications status.

since - : the last update of the publication

maxSize - : the maximum size of the list. If 0 is specified, the limit is not used.

componentIds -

Returns:

a list of publications with the specified maxSize or none if 0 or less is specified.

getPublicationsByStatus

Collection<PublicationDetail> getPublicationsByStatus(String status,
                                                      List<String> componentIds)

searchByKeywords

Collection<PublicationDetail> searchByKeywords(String query,
                                               PublicationPK pubPK)

Method declaration

Parameters:

query -

pubPK -

Returns:

See Also:

getNbPubInFatherPKs

int getNbPubInFatherPKs(Collection<NodePK> fatherPKs)

Method declaration

Parameters:

fatherPKs -

Returns:

See Also:

getNbPubByFatherPath

int getNbPubByFatherPath(NodePK fatherPK,
                         String fatherPath)

Method declaration

Parameters:

fatherPK -

fatherPath -

Returns:

See Also:

getDistributionTree

Map<String,Integer> getDistributionTree(String instanceId,
                                        String statusSubQuery,
                                        boolean checkVisibility)

* Return the tree of nodes with the number of publication per node.

Parameters:

instanceId -

statusSubQuery -

checkVisibility -

Returns:

the tree of nodes with the number of publication per node

getDetailsByFatherIds

Collection<PublicationDetail> getDetailsByFatherIds(List<String> fatherIds,
                                                    PublicationPK pubPK)

Method declaration

Parameters:

fatherIds -

pubPK -

Returns:

See Also:

getDetailsByFatherIds

Collection<PublicationDetail> getDetailsByFatherIds(List<String> fatherIds,
                                                    PublicationPK pubPK,
                                                    boolean filterOnVisibilityPeriod)

getDetailsByFatherIds

Collection<PublicationDetail> getDetailsByFatherIds(List<String> fatherIds,
                                                    PublicationPK pubPK,
                                                    String sorting)

getDetailsByFatherIdsAndStatus

Collection<PublicationDetail> getDetailsByFatherIdsAndStatus(List<String> fatherIds,
                                                             PublicationPK pubPK,
                                                             String sorting,
                                                             String status)

getDetailsByFatherIdsAndStatusList

Collection<PublicationDetail> getDetailsByFatherIdsAndStatusList(List<String> fatherIds,
                                                                 PublicationPK pubPK,
                                                                 String sorting,
                                                                 List<String> status)

getDetailsByFatherIdsAndStatusList

Collection<PublicationDetail> getDetailsByFatherIdsAndStatusList(List<String> fatherIds,
                                                                 PublicationPK pubPK,
                                                                 String sorting,
                                                                 List<String> status,
                                                                 boolean filterOnVisibilityPeriod)

getPubPKsInFatherPKs

Collection<PublicationPK> getPubPKsInFatherPKs(Collection<WAPrimaryKey> fatherPKs)

Method declaration

Parameters:

fatherPKs -

Returns:

See Also:

getPubPKsInFatherPK

Collection<PublicationPK> getPubPKsInFatherPK(NodePK fatherPK)

Method declaration

Parameters:

fatherPK -

Returns:

See Also:

createIndex

void createIndex(PublicationPK pubPK)

Method declaration

Parameters:

pubPK -

See Also:

createIndex

void createIndex(PublicationDetail pubDetail)

deleteIndex

void deleteIndex(PublicationPK pubPK)

Method declaration

Parameters:

pubPK -

See Also:

getAllPublications

Collection<PublicationDetail> getAllPublications(PublicationPK pubPK)

Method declaration

Parameters:

pubPK -

Returns:

See Also:

getAllPublications

Collection<PublicationDetail> getAllPublications(PublicationPK pubPK,
                                                 String sorting)

getDetailByName

PublicationDetail getDetailByName(PublicationPK pubPK,
                                  String pubName)

Looking for, in the instance identified by pubPK, a publication named pubName.

Parameters:

pubPK - the identifier of the instance

pubName - the publication's name we are looking for

Returns:

the pubId if a publication already exists in this component's instance. null otherwise.

getDetailByNameAndNodeId

PublicationDetail getDetailByNameAndNodeId(PublicationPK pubPK,
                                           String pubName,
                                           int nodeId)

processWysiwyg

void processWysiwyg(PublicationPK pubPK)

A wysiwyg's content has been added or modified to a publication. Its content must be added to the indexed content of the publication

Parameters:

pubPK - the identifier of the publication associated to the wysiwyg

getDetailBetweenDate

Collection<PublicationDetail> getDetailBetweenDate(String beginDate,
                                                   String endDate,
                                                   String instanceId)

Parameters:

beginDate -

endDate -

instanceId -

Returns:

Collection of PublicationDetail.

getValidationSteps

List<ValidationStep> getValidationSteps(PublicationPK pubPK)

getValidationStepByUser

ValidationStep getValidationStepByUser(PublicationPK pubPK,
                                       String userId)

addValidationStep

void addValidationStep(ValidationStep step)

removeValidationSteps

void removeValidationSteps(PublicationPK pubPK)

changePublicationsOrder

void changePublicationsOrder(List<String> ids,
                             NodePK nodePK)

getCoordinates

Collection<Coordinate> getCoordinates(String pubId,
                                      String componentId)

addLinks

void addLinks(PublicationPK pubPK,
              List<ForeignPK> links)

Updates the publication links

Parameters:

pubPK - publication identifier which you want to update links

links - list of publication to link with current.

getAllPublicationsWithStatusbyUserid

List<SocialInformation> getAllPublicationsWithStatusbyUserid(String userId,
                                                             Date begin,
                                                             Date end)

getSocialInformationsListOfMyContacts

List<SocialInformationPublication> getSocialInformationsListOfMyContacts(List<String> myContactsIds,
                                                                         List<String> options,
                                                                         Date begin,
                                                                         Date end)

get list of socialInformation of my contacts according to options and number of Item and the first Index

Parameters:

myContactsIds -

options -

begin -

end -

Returns:

getPublicationsToDraftOut

Collection<PublicationDetail> getPublicationsToDraftOut(boolean useClone)

getDraftsByUser

Collection<PublicationDetail> getDraftsByUser(String userId)

get all publications of given user in state 'Draft'. It returns simple publications in state 'Draft' and cloned publications with a clone in state 'Draft'.

Parameters:

userId -

Returns:

all PublicationDetail in state 'Draft' according to given userId