org.kuali.rice.kew.api
Class WorkflowDocumentFactory

java.lang.Object
  org.kuali.rice.kew.api.WorkflowDocumentFactory

public final class WorkflowDocumentFactory
extends Object

TODO ..

Constructor Summary

WorkflowDocumentFactory()

Method Summary

static WorkflowDocument	createDocument(String principalId, String documentTypeName) TODO
static WorkflowDocument	createDocument(String principalId, String documentTypeName, DocumentUpdate documentUpdate, DocumentContentUpdate documentContentUpdate) TODO
static WorkflowDocument	createDocument(String principalId, String documentTypeName, String title) TODO
static WorkflowDocument	loadDocument(String principalId, String documentId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowDocumentFactory

public WorkflowDocumentFactory()

Method Detail

createDocument

public static WorkflowDocument createDocument(String principalId,
                                              String documentTypeName)

TODO

Parameters:

principalId - TODO

documentTypeName - TODO

Returns:

TODO

Throws:

IllegalArgumentException - if principalId is null or blank

IllegalArgumentException - if documentTypeName is null or blank

IllegalDocumentTypeException - if the document type does not allow for creation of a document, this can occur when the given document type is used only as a parent and has no route path configured

InvalidActionTakenException - if the caller is not allowed to execute this action

createDocument

public static WorkflowDocument createDocument(String principalId,
                                              String documentTypeName,
                                              String title)

TODO

Parameters:

principalId - TODO

documentTypeName - TODO

title - TODO

Returns:

TODO

Throws:

IllegalArgumentException - if principalId is null or blank

IllegalArgumentException - if documentTypeName is null or blank

IllegalDocumentTypeException - if documentTypeName does not represent a valid document type

createDocument

public static WorkflowDocument createDocument(String principalId,
                                              String documentTypeName,
                                              DocumentUpdate documentUpdate,
                                              DocumentContentUpdate documentContentUpdate)

TODO

Parameters:

principalId - TODO

documentTypeName - TODO

documentUpdate - TODO

documentContentUpdate - TODO

Returns:

TODO

Throws:

IllegalArgumentException - if principalId is null or blank

IllegalArgumentException - if documentTypeName is null or blank

IllegalDocumentTypeException - if documentTypeName does not represent a valid document type

loadDocument

public static WorkflowDocument loadDocument(String principalId,
                                            String documentId)