|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lombardisoftware.webapi.Document
public class Document
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.
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 |
---|
public 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 |
---|
public long getId()
public void setId(long id)
id
- * The environment specific identifier for the documentpublic java.lang.Long getProcessInstanceId()
public void setProcessInstanceId(java.lang.Long processInstanceId)
processInstanceId
- * The environment specific identifier for the associated process
instancepublic java.lang.Long getParentId()
public void setParentId(java.lang.Long parentId)
parentId
- * The environment specific identifier of the parent documentpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- * The name of the documentpublic DocumentType getType()
public void setType(DocumentType type)
type
- * The type of the document. Valid values include: FILE and URLpublic java.lang.String getUri()
public void setUri(java.lang.String uri)
uri
- * The uri of the document. For FILE documents, this is the file
name. For URL
documents, this is the URL.public java.lang.Integer getVersion()
public void setVersion(java.lang.Integer version)
version
- * The version of the documentpublic User getModifiedBy()
public void setModifiedBy(User modifiedBy)
modifiedBy
- * The user that modified this documentpublic java.util.Calendar getModificationDate()
public void setModificationDate(java.util.Calendar modificationDate)
modificationDate
- * The date/time this document was modifiedpublic java.lang.String getContentType()
public void setContentType(java.lang.String contentType)
contentType
- * The MIME content type of the document data (when type is FILE).public byte[] getData()
public void setData(byte[] data)
data
- * The document data (when type is FILE).public DocumentProperty[] getProperties()
public void setProperties(DocumentProperty[] properties)
properties
- * The property set for the document.public java.lang.String getHideInPortal()
public void setHideInPortal(java.lang.String hideInPortal)
hideInPortal
- * Indicates to hide or not this document in Portal.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |