org.osivia.portal.api.contribution

Interface IContributionService

public interface IContributionService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IContributionService.EditionState Window edition state types enumeration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MBEAN_NAME
static java.lang.String	PUBLISH
static java.lang.String	UNPUBLISH

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getChangeEditionStateUrl(PortalControllerContext portalControllerContext, IContributionService.EditionState state) Change current window state
IContributionService.EditionState	getEditionState(PortalControllerContext portalControllerContext) get current window state
java.lang.String	getPublishContributionURL(PortalControllerContext portalControllerContext, java.lang.String docPath) Return a publish contribution URL for current document.
java.lang.String	getUnpublishContributionURL(PortalControllerContext portalControllerContext, java.lang.String docPath) Get unpublish contribution URL for current document.
void	removeWindowEditionState(PortalControllerContext portalControllerContext) remove current window state

Field Detail

MBEAN_NAME

static final java.lang.String MBEAN_NAME

See Also:

Constant Field Values

PUBLISH

static final java.lang.String PUBLISH

See Also:

Constant Field Values

UNPUBLISH

static final java.lang.String UNPUBLISH

See Also:

Constant Field Values

Method Detail

getChangeEditionStateUrl

java.lang.String getChangeEditionStateUrl(PortalControllerContext portalControllerContext,
                                        IContributionService.EditionState state)

Change current window state

Parameters:

portalControllerContext -

state -

Returns:

getPublishContributionURL

java.lang.String getPublishContributionURL(PortalControllerContext portalControllerContext,
                                         java.lang.String docPath)

Return a publish contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish URL

getUnpublishContributionURL

java.lang.String getUnpublishContributionURL(PortalControllerContext portalControllerContext,
                                           java.lang.String docPath)

Get unpublish contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

unpublish URL

getEditionState

IContributionService.EditionState getEditionState(PortalControllerContext portalControllerContext)

get current window state

Parameters:

portalControllerContext -

Returns:

removeWindowEditionState

void removeWindowEditionState(PortalControllerContext portalControllerContext)

remove current window state

Parameters:

portalControllerContext -