WGWorkflow

All Known Subinterfaces:

WGAutoApprovalCapableWorkflow
```
public interface WGWorkflow
```
Interface for a workflow object. The workflow object is a single instance of a workflow. It is always created in context of a single content object.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ITEM_APPROVEDBY` Item to store past approvers
`static java.lang.String`	`ITEM_ARCHIVINGDATE` Item to store the archiving date
`static java.lang.String`	`ITEM_COMMENT` Item to store workflow comment.
`static java.lang.String`	`ITEM_CURRENTLEVEL` Item to store the current workflow level
`static java.lang.String`	`ITEM_INITIATOR` Item to store the workflow initiator.
`static java.lang.String`	`ITEM_LEVELNAME` Item to store the unique name of the current workflow level
`static java.lang.String`	`ITEM_PUBLISHINGDATE` Item to store the publishing date
`static java.lang.String`	`ITEM_RELEASEDATE` Item to store the release date
`static java.lang.String`	`ITEM_REPLACEMENT_REASON` Item to store replacement reason.
`static java.lang.String`	`ITEM_REVIEWERCOUNT` Item to store the number of reviewers.
`static java.lang.String`	`ITEM_REVIEWERS` Item to store reviewer names
`static java.lang.String`	`ITEM_WFNAME` Item to store workflow name
`static java.lang.String`	`ITEM_WRITEACCESS` Item to store people with write access to the document.
`static int`	`ROLE_ADMINISTRATOR` User is admin reviewer of the workflow
`static int`	`ROLE_APPROVER` User is approver on this workflow level
`static int`	`ROLE_NONE` User has no role on this workflow level

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`approve(java.lang.String comment)` Approves the content
`void`	`archive(java.lang.String comment)` Archives the content.
`int`	`getWorkflowRole()` Returns the workflow role of the currently logged in user for the current workflow level of the content.
`void`	`initialize()` Called when a content enters workflow and should be initialized for it.
`boolean`	`isApprovableByUser()` Checks all conditions that are necessary for the current user to approve this document.
`boolean`	`publish(java.lang.String comment)` Publishes a draft content so it can enter authorization workflow.
`void`	`reject(java.lang.String comment)` Rejects a content back to draft status.
`void`	`release(java.lang.String comment)` Called when a content is released (i.e. has completely passed the workflow)

- Field Detail
  - ROLE_NONE
```
static final int ROLE_NONE
```
    User has no role on this workflow level
    
    See Also:
    Constant Field Values
  - ROLE_APPROVER
```
static final int ROLE_APPROVER
```
    User is approver on this workflow level
    
    See Also:
    Constant Field Values
  - ROLE_ADMINISTRATOR
```
static final int ROLE_ADMINISTRATOR
```
    User is admin reviewer of the workflow
    
    See Also:
    Constant Field Values
  - ITEM_APPROVEDBY
```
static final java.lang.String ITEM_APPROVEDBY
```
    Item to store past approvers
    
    See Also:
    Constant Field Values
  - ITEM_ARCHIVINGDATE
```
static final java.lang.String ITEM_ARCHIVINGDATE
```
    Item to store the archiving date
    
    See Also:
    Constant Field Values
  - ITEM_COMMENT
```
static final java.lang.String ITEM_COMMENT
```
    Item to store workflow comment.
    
    See Also:
    Constant Field Values
  - ITEM_CURRENTLEVEL
```
static final java.lang.String ITEM_CURRENTLEVEL
```
    Item to store the current workflow level
    
    See Also:
    Constant Field Values
  - ITEM_INITIATOR
```
static final java.lang.String ITEM_INITIATOR
```
    Item to store the workflow initiator.
    
    See Also:
    Constant Field Values
  - ITEM_LEVELNAME
```
static final java.lang.String ITEM_LEVELNAME
```
    Item to store the unique name of the current workflow level
    
    See Also:
    Constant Field Values
  - ITEM_PUBLISHINGDATE
```
static final java.lang.String ITEM_PUBLISHINGDATE
```
    Item to store the publishing date
    
    See Also:
    Constant Field Values
  - ITEM_RELEASEDATE
```
static final java.lang.String ITEM_RELEASEDATE
```
    Item to store the release date
    
    See Also:
    Constant Field Values
  - ITEM_REPLACEMENT_REASON
```
static final java.lang.String ITEM_REPLACEMENT_REASON
```
    Item to store replacement reason.
    
    See Also:
    Constant Field Values
  - ITEM_REVIEWERCOUNT
```
static final java.lang.String ITEM_REVIEWERCOUNT
```
    Item to store the number of reviewers.
    
    See Also:
    Constant Field Values
  - ITEM_REVIEWERS
```
static final java.lang.String ITEM_REVIEWERS
```
    Item to store reviewer names
    
    See Also:
    Constant Field Values
  - ITEM_WFNAME
```
static final java.lang.String ITEM_WFNAME
```
    Item to store workflow name
    
    See Also:
    Constant Field Values
  - ITEM_WRITEACCESS
```
static final java.lang.String ITEM_WRITEACCESS
```
    Item to store people with write access to the document.
    
    See Also:
    Constant Field Values
- Method Detail
  - initialize
```
void initialize()
                throws WGAPIException
```
    Called when a content enters workflow and should be initialized for it.
    
    Throws:
    
    WGAPIException
  - publish
```
boolean publish(java.lang.String comment)
                throws WGAPIException
```
    Publishes a draft content so it can enter authorization workflow.
    
    Parameters:
    comment - Comment on publishing
    
    Returns:
    true, if the content can be immediately released, false if there is another workflow level yet to pass
    
    Throws:
    
    WGAPIException
  - reject
```
void reject(java.lang.String comment)
            throws WGAPIException
```
    Rejects a content back to draft status.
    
    Parameters:
    comment - Comment on rejection
    
    Throws:
    
    WGAPIException
  - approve
```
boolean approve(java.lang.String comment)
                throws WGAPIException
```
    Approves the content
    
    Parameters:
    comment - A comment on the approval operation
    
    Returns:
    true, if the content can be immediately published, false if there is another workflow level
    
    Throws:
    
    WGWorkflowException
    
    WGAPIException
  - release
```
void release(java.lang.String comment)
             throws WGAPIException
```
    Called when a content is released (i.e. has completely passed the workflow)
    
    Parameters:
    comment - Comment on releasing.
    
    Throws:
    
    WGAPIException
  - archive
```
void archive(java.lang.String comment)
             throws WGAPIException
```
    Archives the content.
    
    Parameters:
    comment - Comment on archiving the content
    
    Throws:
    
    WGAPIException
  - getWorkflowRole
```
int getWorkflowRole()
                    throws WGAPIException
```
    Returns the workflow role of the currently logged in user for the current workflow level of the content.
    
    Returns:
    Workflow role as constant ROLE_....
    
    Throws:
    
    WGAPIException
  - isApprovableByUser
```
boolean isApprovableByUser()
                           throws WGAPIException
```
    Checks all conditions that are necessary for the current user to approve this document.
    
    Throws:
    
    WGAPIException

Interface WGWorkflow

Field Summary

Method Summary

Field Detail

ROLE_NONE

ROLE_APPROVER

ROLE_ADMINISTRATOR

ITEM_APPROVEDBY

ITEM_ARCHIVINGDATE

ITEM_COMMENT

ITEM_CURRENTLEVEL

ITEM_INITIATOR

ITEM_LEVELNAME

ITEM_PUBLISHINGDATE

ITEM_RELEASEDATE

ITEM_REPLACEMENT_REASON

ITEM_REVIEWERCOUNT

ITEM_REVIEWERS

ITEM_WFNAME

ITEM_WRITEACCESS

Method Detail

initialize

publish

reject

approve

release

archive

getWorkflowRole

isApprovableByUser