Package org.craftercms.studio.api.v1.service.content

Interface DmPageNavigationOrderService

All Known Implementing Classes:

DmPageNavigationOrderServiceImpl

public interface DmPageNavigationOrderService

Order Service for Navigation Pages

Author:

shankark, Dejan Brkic

Method Summary

Modifier and Type	Method	Description
boolean	addNavOrder(String site, String path, org.dom4j.Document doc)	Always adds/overwrites the Document element with new unique nav order
void	deleteSequencesForSite(String site)
double	getNewNavOrder(String site, String path)	Return new navigation order
double	getNewNavOrder(String site, String path, double currentMaxNavOrder)
int	getPageNavigationOrderIncrement()
boolean	updateNavOrder(String site, String path, org.dom4j.Document document)	Updates the Document element with new unique nav order if one does not exist

Method Details

getNewNavOrder

double getNewNavOrder(String site,
 String path)

Return new navigation order

getNewNavOrder

double getNewNavOrder(String site,
 String path,
 double currentMaxNavOrder)

addNavOrder

boolean addNavOrder(String site,
 String path,
 org.dom4j.Document doc)

Always adds/overwrites the Document element with new unique nav order

Parameters:

doc -

Returns:

true if document was updated with new nav order

updateNavOrder

boolean updateNavOrder(String site,
 String path,
 org.dom4j.Document document)

Updates the Document element with new unique nav order if one does not exist

Parameters:

document -

Returns:

true if document was updated with new nav order

deleteSequencesForSite

void deleteSequencesForSite(String site)

getPageNavigationOrderIncrement

int getPageNavigationOrderIncrement()