|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 1 (11.1.1) E14128-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkItemAttachment
The WorkItemAttachment
interface is implemented by a work item connector
to support the management of the work item in the work item detail editor
window. It provides access to corresponding file system that stores the attachments.
If the call to isAttachmentSupported() by the connector framework returns true, the connector needs to implement this interface.
Each API needs to process the attachment requests based on the session context and the work item currently used.
Method Summary | |
---|---|
boolean |
deleteAttachment(java.util.Map session,
WorkItem wi,
DocumentItem di)
Deletes work item attachment |
void |
downloadAttachment(java.util.Map session,
WorkItem wi,
DocumentItem di,
java.lang.String localPath)
Downloads work item attachment to the specified location on the local file system |
java.util.List<DocumentItem> |
getAttachments(java.util.Map session,
WorkItem wi)
Retrieves a list of attachments for a specific work item. |
DocumentItem |
updateAttachmentAttrs(java.util.Map session,
WorkItem wi,
DocumentItem oldDI,
DocumentItem newDI)
Changes the attributes of a work item attachment |
DocumentItem |
uploadAttachment(java.util.Map session,
WorkItem wi,
DocumentItem di,
java.lang.String localPath)
Uploads a local file to the specified file store, and associates the file as an attachment to the specified work item |
Method Detail |
---|
java.util.List<DocumentItem> getAttachments(java.util.Map session, WorkItem wi) throws ALMException
session
- user session contextwi
- current work item
ALMException
- if failed to get the attachmentsDocumentItem uploadAttachment(java.util.Map session, WorkItem wi, DocumentItem di, java.lang.String localPath) throws ALMException
session
- user session contextwi
- current work itemdi
- attachment information used when storing the file to the serverlocalPath
- the full path of the local file to uplaod
ALMException
- if failed to upload attachment.void downloadAttachment(java.util.Map session, WorkItem wi, DocumentItem di, java.lang.String localPath) throws ALMException
session
- user session contextwi
- current work itemdi
- attachment information used when downloading the file from the serverlocalPath
- the full path of the local file that the attachment will be stored as
ALMException
- if failed to download the attachment.boolean deleteAttachment(java.util.Map session, WorkItem wi, DocumentItem di) throws ALMException
session
- user session contextwi
- current work itemdi
- the attachment to be deleted
ALMException
- if failed to delete attachment.DocumentItem updateAttachmentAttrs(java.util.Map session, WorkItem wi, DocumentItem oldDI, DocumentItem newDI) throws ALMException
session
- user session contextwi
- current work itemoldDI
- old attachment informationnewDI
- new attachment information to update the attributes to
ALMException
- if failed to update attachment.
|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 1 (11.1.1) E14128-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |