Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.portal.cms.workflow
Interface ApprovePublish

All Known Implementing Classes:
  ApprovePublishImpl

    public interface ApprovePublish

Created on : Dec 19, 2006

Author:
  Sohil Shah - sohil.shah@jboss.com

Method Summary
`java.util.Collection` | `getAllPendingInQueue()` Retrieves a queue of unapproved content for everything in the CMS.
`java.util.Set` | `getManagers()` Returns role names of Roles that are designated to be Managers in this workflow.
`java.util.Collection` | `getPendingQueue(java.lang.String filePath)` Retrieves a queue of unapproved content associated with the specified file in the CMS
`void` | `processManagerResponse(long processId, java.lang.String manager, boolean approved)` Called when a manager either approves or rejects the publishing of a specific content to go live
`void` | `processManagerResponse(long processId, java.lang.String manager, java.lang.String modifiedContent)` Called when a manager either approves the publishing of a specific content to go live, but at the same time adds his/her own modifications to the original content
`long` | `requestApproval(Content content)` Called when content is added to the CMS, and needs to be approved by the managers before it can be published to go live

Method Detail

### requestApproval

    long requestApproval(Content content)
                         throws WorkflowException

  Called when content is added to the CMS, and needs to be approved by the managers before it can be published to go live

  Parameters:
    `content` -
  Returns:
    returns the process id of the workflow process set in motion
  Throws:
    `WorkflowException`

### processManagerResponse

    void processManagerResponse(long processId,
                                java.lang.String manager,
                                boolean approved)
                                throws WorkflowException

  Called when a manager either approves or rejects the publishing of a specific content to go live

  Parameters:
    `processId` -
    `manager` - userId of the manager
    `approved` - true if approved, false if rejected
  Throws:
    `WorkflowException`

### processManagerResponse

    void processManagerResponse(long processId,
                                java.lang.String manager,
                                java.lang.String modifiedContent)
                                throws WorkflowException

  Called when a manager either approves the publishing of a specific content to go live, but at the same time adds his/her own modifications to the original content

  Parameters:
    `processId` -
    `manager` - userId of the manager
    `approved` - true if approved, false if rejected
  Throws:
    `WorkflowException`

### getPendingQueue

    java.util.Collection getPendingQueue(java.lang.String filePath)
                                         throws WorkflowException

  Retrieves a queue of unapproved content associated with the specified file in the CMS

  Parameters:
    `filePath` -
  Returns:
  Throws:
    `WorkflowException`

### getAllPendingInQueue

    java.util.Collection getAllPendingInQueue()
                                              throws WorkflowException

  Retrieves a queue of unapproved content for everything in the CMS.

  Returns:
  Throws:
    `WorkflowException`

### getManagers

    java.util.Set getManagers()

  Returns role names of Roles that are designated to be Managers in this workflow. Managers approve/deny all content publish requests before the content goes live in the CMS

  Returns:
    a Set of role names

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD