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 String	ASK_PUBLISH
static String	CANCEL_PUBLISH
static String	MBEAN_NAME
static String	PUBLISH
static String	REJECT_PUBLISHING
static String	UNPUBLISH
static String	VALIDATE_PUBLISHING

Method Summary

Methods

Modifier and Type	Method and Description
String	getAskPublishContributionURL(PortalControllerContext portalControllerContext, String docPath) Return a "ask to publish" contribution URL for current document.
String	getCancelPublishingAskContributionURL(PortalControllerContext portalControllerContext, String docPath) Return a "cancel publising workflow" contribution URL for current document.
String	getChangeEditionStateUrl(PortalControllerContext portalControllerContext, IContributionService.EditionState state) Change current window state
IContributionService.EditionState	getEditionState(PortalControllerContext portalControllerContext) get current window state
String	getPublishContributionURL(PortalControllerContext portalControllerContext, String docPath) Return a publish contribution URL for current document.
String	getRejectPublishContributionURL(PortalControllerContext portalControllerContext, String docPath) Return a "reject publishing" contribution URL for current document.
String	getUnpublishContributionURL(PortalControllerContext portalControllerContext, String docPath) Get unpublish contribution URL for current document.
String	getValidatePublishContributionURL(PortalControllerContext portalControllerContext, String docPath) Return a "validate publishing" contribution URL for current document.
void	removeWindowEditionState(PortalControllerContext portalControllerContext) remove current window state

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

See Also:

Constant Field Values

PUBLISH

static final String PUBLISH

See Also:

Constant Field Values

UNPUBLISH

static final String UNPUBLISH

See Also:

Constant Field Values

ASK_PUBLISH

static final String ASK_PUBLISH

See Also:

Constant Field Values

VALIDATE_PUBLISHING

static final String VALIDATE_PUBLISHING

See Also:

Constant Field Values

REJECT_PUBLISHING

static final String REJECT_PUBLISHING

See Also:

Constant Field Values

CANCEL_PUBLISH

static final String CANCEL_PUBLISH

See Also:

Constant Field Values

Method Detail

getChangeEditionStateUrl

String getChangeEditionStateUrl(PortalControllerContext portalControllerContext,
                              IContributionService.EditionState state)

Change current window state

Parameters:

portalControllerContext -

state -

Returns:

getPublishContributionURL

String getPublishContributionURL(PortalControllerContext portalControllerContext,
                               String docPath)

Return a publish contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish URL

getUnpublishContributionURL

String getUnpublishContributionURL(PortalControllerContext portalControllerContext,
                                 String docPath)

Get unpublish contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

unpublish URL

getAskPublishContributionURL

String getAskPublishContributionURL(PortalControllerContext portalControllerContext,
                                  String docPath)

Return a "ask to publish" contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish URL

getCancelPublishingAskContributionURL

String getCancelPublishingAskContributionURL(PortalControllerContext portalControllerContext,
                                           String docPath)

Return a "cancel publising workflow" contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish URL

getValidatePublishContributionURL

String getValidatePublishContributionURL(PortalControllerContext portalControllerContext,
                                       String docPath)

Return a "validate publishing" contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish URL

getRejectPublishContributionURL

String getRejectPublishContributionURL(PortalControllerContext portalControllerContext,
                                     String docPath)

Return a "reject publishing" contribution URL for current document.

Parameters:

portalControllerContext - portal controller context

docPath - current document path

Returns:

publish 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 -