IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class Document

java.lang.Object
  extended by com.lombardisoftware.webapi.Document
All Implemented Interfaces:
java.io.Serializable

public class Document
extends java.lang.Object
implements java.io.Serializable

A Document can be attached to a process instance to store information related to the business process along with the process instance itself. Documents can either refer to external resources via URL or directly contain the document data.

See Also:
Serialized Form

Constructor Summary
Document()
           
Document(long id, java.lang.Long processInstanceId, java.lang.Long parentId, java.lang.String name, DocumentType type, java.lang.String uri, java.lang.Integer version, User modifiedBy, java.util.Calendar modificationDate, java.lang.String contentType, byte[] data, DocumentProperty[] properties, java.lang.String hideInPortal)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getContentType()
          Gets the contentType value for this Document.
 byte[] getData()
          Gets the data value for this Document.
static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Deserializer
 java.lang.String getHideInPortal()
          Gets the hideInPortal value for this Document.
 long getId()
          Gets the id value for this Document.
 java.util.Calendar getModificationDate()
          Gets the modificationDate value for this Document.
 User getModifiedBy()
          Gets the modifiedBy value for this Document.
 java.lang.String getName()
          Gets the name value for this Document.
 java.lang.Long getParentId()
          Gets the parentId value for this Document.
 java.lang.Long getProcessInstanceId()
          Gets the processInstanceId value for this Document.
 DocumentProperty[] getProperties()
          Gets the properties value for this Document.
static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
          Get Custom Serializer
 DocumentType getType()
          Gets the type value for this Document.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 java.lang.String getUri()
          Gets the uri value for this Document.
 java.lang.Integer getVersion()
          Gets the version value for this Document.
 int hashCode()
           
 void setContentType(java.lang.String contentType)
          Sets the contentType value for this Document.
 void setData(byte[] data)
          Sets the data value for this Document.
 void setHideInPortal(java.lang.String hideInPortal)
          Sets the hideInPortal value for this Document.
 void setId(long id)
          Sets the id value for this Document.
 void setModificationDate(java.util.Calendar modificationDate)
          Sets the modificationDate value for this Document.
 void setModifiedBy(User modifiedBy)
          Sets the modifiedBy value for this Document.
 void setName(java.lang.String name)
          Sets the name value for this Document.
 void setParentId(java.lang.Long parentId)
          Sets the parentId value for this Document.
 void setProcessInstanceId(java.lang.Long processInstanceId)
          Sets the processInstanceId value for this Document.
 void setProperties(DocumentProperty[] properties)
          Sets the properties value for this Document.
 void setType(DocumentType type)
          Sets the type value for this Document.
 void setUri(java.lang.String uri)
          Sets the uri value for this Document.
 void setVersion(java.lang.Integer version)
          Sets the version value for this Document.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Document

public Document()

Document

public Document(long id,
                java.lang.Long processInstanceId,
                java.lang.Long parentId,
                java.lang.String name,
                DocumentType type,
                java.lang.String uri,
                java.lang.Integer version,
                User modifiedBy,
                java.util.Calendar modificationDate,
                java.lang.String contentType,
                byte[] data,
                DocumentProperty[] properties,
                java.lang.String hideInPortal)
Method Detail

getId

public long getId()
Gets the id value for this Document.

Returns:
id * The environment specific identifier for the document

setId

public void setId(long id)
Sets the id value for this Document.

Parameters:
id - * The environment specific identifier for the document

getProcessInstanceId

public java.lang.Long getProcessInstanceId()
Gets the processInstanceId value for this Document.

Returns:
processInstanceId * The environment specific identifier for the associated process instance

setProcessInstanceId

public void setProcessInstanceId(java.lang.Long processInstanceId)
Sets the processInstanceId value for this Document.

Parameters:
processInstanceId - * The environment specific identifier for the associated process instance

getParentId

public java.lang.Long getParentId()
Gets the parentId value for this Document.

Returns:
parentId * The environment specific identifier of the parent document

setParentId

public void setParentId(java.lang.Long parentId)
Sets the parentId value for this Document.

Parameters:
parentId - * The environment specific identifier of the parent document

getName

public java.lang.String getName()
Gets the name value for this Document.

Returns:
name * The name of the document

setName

public void setName(java.lang.String name)
Sets the name value for this Document.

Parameters:
name - * The name of the document

getType

public DocumentType getType()
Gets the type value for this Document.

Returns:
type * The type of the document. Valid values include: FILE and URL

setType

public void setType(DocumentType type)
Sets the type value for this Document.

Parameters:
type - * The type of the document. Valid values include: FILE and URL

getUri

public java.lang.String getUri()
Gets the uri value for this Document.

Returns:
uri * The uri of the document. For FILE documents, this is the file name. For URL documents, this is the URL.

setUri

public void setUri(java.lang.String uri)
Sets the uri value for this Document.

Parameters:
uri - * The uri of the document. For FILE documents, this is the file name. For URL documents, this is the URL.

getVersion

public java.lang.Integer getVersion()
Gets the version value for this Document.

Returns:
version * The version of the document

setVersion

public void setVersion(java.lang.Integer version)
Sets the version value for this Document.

Parameters:
version - * The version of the document

getModifiedBy

public User getModifiedBy()
Gets the modifiedBy value for this Document.

Returns:
modifiedBy * The user that modified this document

setModifiedBy

public void setModifiedBy(User modifiedBy)
Sets the modifiedBy value for this Document.

Parameters:
modifiedBy - * The user that modified this document

getModificationDate

public java.util.Calendar getModificationDate()
Gets the modificationDate value for this Document.

Returns:
modificationDate * The date/time this document was modified

setModificationDate

public void setModificationDate(java.util.Calendar modificationDate)
Sets the modificationDate value for this Document.

Parameters:
modificationDate - * The date/time this document was modified

getContentType

public java.lang.String getContentType()
Gets the contentType value for this Document.

Returns:
contentType * The MIME content type of the document data (when type is FILE).

setContentType

public void setContentType(java.lang.String contentType)
Sets the contentType value for this Document.

Parameters:
contentType - * The MIME content type of the document data (when type is FILE).

getData

public byte[] getData()
Gets the data value for this Document.

Returns:
data * The document data (when type is FILE).

setData

public void setData(byte[] data)
Sets the data value for this Document.

Parameters:
data - * The document data (when type is FILE).

getProperties

public DocumentProperty[] getProperties()
Gets the properties value for this Document.

Returns:
properties * The property set for the document.

setProperties

public void setProperties(DocumentProperty[] properties)
Sets the properties value for this Document.

Parameters:
properties - * The property set for the document.

getHideInPortal

public java.lang.String getHideInPortal()
Gets the hideInPortal value for this Document.

Returns:
hideInPortal * Indicates to hide or not this document in Portal.

setHideInPortal

public void setHideInPortal(java.lang.String hideInPortal)
Sets the hideInPortal value for this Document.

Parameters:
hideInPortal - * Indicates to hide or not this document in Portal.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer


IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.