|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.content.virtual.workflow.Workflow
public class Workflow
Represents the Workflow document.
Methods which return an ISortableFilterablePagedList
from
IWorkflowManager
can sort and filter the responses. For a discussion on paging,
sorting and filtering, see com.bea.content.paging
and ContentListKeys
.
Native sortable properties for the WLP Repository are found via the
ISortablePagedList.getNativeSortableProperties()
method on a paged list of
Node objects.
For Workflows in the WLP Repository, the current list of native sortable and filterable properties is:
Field Summary | |
---|---|
static int |
DRAFT
Predefined Workflow status |
static int |
PUBLISHED
|
static int |
READY
|
static int |
REJECTED
|
static int |
RETIRED
|
static int |
UNDEFINED
Status which determines if the workflow set a object is not defined in it's corresponding workflow document |
static String |
WORKFLOW_STATUS_FIELD
|
Constructor Summary | |
---|---|
Workflow(ID id,
String name,
String comment,
Date createdDate,
Date modifiedDate)
Construct a workflow without setting the workflowOps or the workflow document. |
|
Workflow(ID id,
String name,
String comment,
com.bea.content.virtual.workflow.schema.WorkflowDocument document,
Date createdDate,
Date modifiedDate)
Construct a Workflow without setting the workflowOps. |
|
Workflow(ID id,
String name,
String comment,
com.bea.content.virtual.workflow.schema.WorkflowDocument document,
WorkflowOps spiWorkflowOps,
boolean isInheritedOnTarget,
Date createdDate,
Date modifiedDate)
Construct a Workflow -- for internal usage by VCR |
Method Summary | |
---|---|
int |
getBeginStatus()
Return the status that marks the begin point of the workflow |
String |
getComment()
Return the comment associated with the workflow |
Date |
getCreatedDate()
Return the date workflow was created |
ID |
getId()
|
Date |
getModifiedDate()
Return the last modification date of the workflow |
String |
getName()
|
Set<String> |
getRolesForCapability(ContentContext context,
Node node,
String capability)
Return all the published roles for the node represented by the node id. |
Map<Integer,String> |
getStatusText()
Returns a map of status representation of the text. |
List<Integer> |
getStatusTransitions(ContentContext context,
Node node,
int originStatus)
Returns a list of valid status transitions for the user from the given status. |
List<WorkflowAction> |
getTransitionActions(ContentContext context,
Node node,
int fromState,
int toState)
Return a list of WorkflowAction objects which represent the actions to be executed when making a transition from one state to another. |
boolean |
hasCheckinAccess(ContentContext context,
Node node,
int fromStatus,
int toStatus)
Helper method to indicate whether or not a user has access to a to-status element to perform operations on the object. |
boolean |
hasTransitionAccess(ContentContext context,
Node node,
int status)
Helper method to indicate whether or not a user has access to a from-status element to perform operations on the object. |
boolean |
isInheritedOnTarget()
Indicates whether or not the given workflow is inherited on the object of the workflow. |
boolean |
isWorkflowDocumentLoaded()
Indicates whether the workflow document has been loaded for this object. |
void |
setComment(String comment)
|
void |
setInheritedOnTarget(boolean isInheritedOnTarget)
Sets the isInheritedOnTarget value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DRAFT
public static final int READY
public static final int REJECTED
public static final int PUBLISHED
public static final int RETIRED
public static final int UNDEFINED
public static final String WORKFLOW_STATUS_FIELD
Constructor Detail |
---|
public Workflow(ID id, String name, String comment, com.bea.content.virtual.workflow.schema.WorkflowDocument document, WorkflowOps spiWorkflowOps, boolean isInheritedOnTarget, Date createdDate, Date modifiedDate)
id
- The ID of the workflowname
- The name of the workflow - workflow names are unique within a repositorycomment
- An optional comment associated with a workflowdocument
- The actual workflow documentspiWorkflowOps
- The SPI interface for the workflow.isInheritedOnTarget
- Indicates whether the workflow is inherited on target or not.createdDate
- The date the workflow was created.modifiedDate
- The date the workflow was modified.public Workflow(ID id, String name, String comment, com.bea.content.virtual.workflow.schema.WorkflowDocument document, Date createdDate, Date modifiedDate)
id
- The ID of the workflowname
- The name of the workflow - workflow names are unique within a repositorycomment
- An optional comment associated with a workflowdocument
- The actual workflow documentcreatedDate
- The date the workflow was created.modifiedDate
- The date the workflow was modified.public Workflow(ID id, String name, String comment, Date createdDate, Date modifiedDate)
id
- The ID of the workflowname
- The name of the workflow - workflow names are unique within a repositorycomment
- An optional comment associated with a workflowcreatedDate
- The date the workflow was created.modifiedDate
- The date the workflow was modified.Method Detail |
---|
public boolean isWorkflowDocumentLoaded()
public ID getId()
public String getName()
public String getComment()
public void setComment(String comment)
public Date getCreatedDate()
public Date getModifiedDate()
public int getBeginStatus() throws RepositoryException
RepositoryException
- if the retrieval of the workflow document fails.public List<Integer> getStatusTransitions(ContentContext context, Node node, int originStatus)
context
- The ContentContext objectnode
- The node being operated on.originStatus
- The origin status for the user.
public List<WorkflowAction> getTransitionActions(ContentContext context, Node node, int fromState, int toState) throws IOException, com.bea.xml.XmlException, ClassNotFoundException, InstantiationException, IllegalAccessException, com.bea.p13n.entitlements.common.EntitlementsException, RepositoryException
context
- The ContentContext objectnode
- The node on which actions are executed.fromState
- The start point of the transition.toState
- The end point of the transition.
IOException
- If an error occurs while reading the workflow document.
com.bea.xml.XmlException
- If an error occurs parsing the workflow document.
ClassNotFoundException
- If the workflow points to an action class which isn't found.
InstantiationException
- If the workflow points to an action class which can't be instantiated.
IllegalAccessException
- If the class or its nullary constructor is not accessible.
com.bea.p13n.entitlements.common.EntitlementsException
- If a security exception occurs.
RepositoryException
- If this operation fails.public boolean hasTransitionAccess(ContentContext context, Node node, int status) throws IOException, com.bea.xml.XmlException, AuthenticationException, AuthorizationException, TransitionNotFoundException, NoSuchNodeException, RepositoryException
context
- The contentContext objectnode
- The node objectstatus
- The status to check.
IOException
- If an error occurs while reading the workflow document.
com.bea.xml.XmlException
- If an error occurs parsing the workflow document.
AuthenticationException
- If an authentication failure occurs.
AuthorizationException
- If an authorization failure occurs.
TransitionNotFoundException
- If the transition is not found
NoSuchNodeException
- If the given node does not exist.
RepositoryException
- If this operation fails for any other reason.public boolean hasCheckinAccess(ContentContext context, Node node, int fromStatus, int toStatus) throws IOException, com.bea.xml.XmlException, AuthenticationException, AuthorizationException, TransitionNotFoundException, NoSuchNodeException, com.bea.p13n.entitlements.common.EntitlementsException, RepositoryException
context
- The contentContext objectnode
- The node objectfromStatus
- The status which the object has prior to checkin.toStatus
- The status to check (the status the caller has changed the node to.)
IOException
- If an error occurs while reading the workflow document.
com.bea.xml.XmlException
- If an error occurs parsing the workflow document.
AuthenticationException
- If an authentication failure occurs.
AuthorizationException
- If an authorization failure occurs.
TransitionNotFoundException
- If the transition is not found
NoSuchNodeException
- If the given node does not exist.
com.bea.p13n.entitlements.common.EntitlementsException
- If a security exception occurs.
RepositoryException
- If this operation fails for any other reason.public Set<String> getRolesForCapability(ContentContext context, Node node, String capability) throws AuthenticationException, AuthorizationException, NoSuchNodeException, RepositoryException
context
- The content context objectnode
- The node objectcapability
- The capability to retrieve
AuthenticationException
- If an authentication error occurs.
AuthorizationException
- If an authorizaton error occurs.
NoSuchNodeException
- If the given node does not exist.
RepositoryException
public Map<Integer,String> getStatusText() throws RepositoryException
RepositoryException
- If this operation fails to retrieve the underlying workflow document.public boolean isInheritedOnTarget()
public void setInheritedOnTarget(boolean isInheritedOnTarget)
isInheritedOnTarget
- True if inherited
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |