|
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 WorkItemConnector
The WorkItemConnector
interface defines the common operations that are used to integrate
any backend repository with Oracle Team Productivity Center (OTPC) inside JDeveloper. It contains the APIs
to fetch query result sets, create a new work item, or update an existing work item, etc.
Method Summary | |
---|---|
void |
createWorkItem(java.util.Map session,
java.lang.String wiType,
WorkItem workItem)
Creates a new work item of a specified type on its backend repository. |
void |
deleteWorkItem(java.util.Map session,
java.lang.String wiType,
WorkItem workItem)
Deletes a work item from its backend repository. |
java.lang.String |
getDynamicModel(java.util.Map session,
java.lang.String currentModel)
Retrieves the latest dynamic model from connector. |
java.lang.String |
getDynamicUI(java.util.Map session,
java.lang.String currentUI)
Retrieves the latest UI layout from connector. |
java.util.List<Row> |
getLOVQueryResult(java.util.Map session,
java.lang.String wiType,
QueryInfo query)
Retrieves the result set in responding to the search action in the LOV (List of Values) dialog. |
java.util.List<WorkItem> |
getQueryResult(java.util.Map session,
java.lang.String wiType,
QueryInfo query)
Retrieves a set of records for the specified work item type that satisfy the query criteria. |
java.lang.String |
getUIRegionName(java.util.Map session,
java.lang.String wiType,
WorkItem workItem)
Gets the name for the UI block represented as region in the UI metadata or the UI XML file for a given work item type. |
WorkItem |
getWorkItem(java.util.Map session,
java.lang.String wiType,
java.lang.String wiId)
Retrieves a specific work item by its type and unique identifier. |
boolean |
hasDynamicModel(java.util.Map session)
Determines if dynamic model or definition is supported by the connector, scoped by session context. |
boolean |
hasDynamicUI(java.util.Map session)
Determines if dynamic UI support is provided by the connector, scoped by session context. |
void |
init(java.util.Map session)
Initializes the connector instance on the client side in a state specified by the connector parameters. |
boolean |
isAttachmentSupported(java.util.Map session,
WorkItem workItem)
Determines if attachment is supported for the specified work item. |
void |
login(java.util.Map session,
java.lang.String userName,
java.lang.String password)
Establishes a user connection between the connector instance on the client side and the backend repository. |
void |
logout(java.util.Map session)
Disconnects the user session from the backend repository. |
void |
setWorkItemDefs(java.util.Map session,
java.util.Map<java.lang.String,WorkItemDef> wiDefs)
During connector instance creation time, OTPC framework reads the connector model definition XML file and constructs the runtime map. |
void |
updateWorkItem(java.util.Map session,
java.lang.String wiType,
WorkItem workItem)
Updates an existing work item by its type and unique identifier. |
Method Detail |
---|
void init(java.util.Map session) throws ALMException
session
- initial connector parameters as specified by its corresponding repository
ALMException
- if required repository information is missingvoid login(java.util.Map session, java.lang.String userName, java.lang.String password) throws ALMException
session
- user session contextuserName
- the Id used to access the backend repository. It will never be nullpassword
- the password used to access the backend repository. It may be null
ALMException
- if failed to log in.void logout(java.util.Map session) throws ALMException
session
- user session context
ALMException
- if failed to log offvoid setWorkItemDefs(java.util.Map session, java.util.Map<java.lang.String,WorkItemDef> wiDefs) throws ALMException
session
- user session contextwiDefs
- the map contains work item definitions by types
ALMException
java.util.List<WorkItem> getQueryResult(java.util.Map session, java.lang.String wiType, QueryInfo query) throws ALMException
session
- user session contextwiType
- the work item typequery
- the query criteria
ALMException
java.util.List<Row> getLOVQueryResult(java.util.Map session, java.lang.String wiType, QueryInfo query) throws ALMException
session
- user session contextwiType
- the work item typequery
- the query criteria
ALMException
WorkItem getWorkItem(java.util.Map session, java.lang.String wiType, java.lang.String wiId) throws ALMException
session
- user session contextwiType
- the work item typewiId
- Id of the work item to retrieve
ALMException
void updateWorkItem(java.util.Map session, java.lang.String wiType, WorkItem workItem) throws ALMException
workItem
contains updated information
for the work item from the backend repository.
session
- user session contextwiType
- the work item typeworkItem
- the work item to update
ALMException
void createWorkItem(java.util.Map session, java.lang.String wiType, WorkItem workItem) throws ALMException
workItem
contains work item
as it is created on the backend repository
session
- user session contextwiType
- the work item typeworkItem
- contains new field values to be saved
ALMException
void deleteWorkItem(java.util.Map session, java.lang.String wiType, WorkItem workItem) throws ALMException
session
- user session contextwiType
- the work item typeworkItem
- the work item to be deleted
ALMException
boolean isAttachmentSupported(java.util.Map session, WorkItem workItem) throws ALMException
session
- user session contextworkItem
- current work item
ALMException
java.lang.String getUIRegionName(java.util.Map session, java.lang.String wiType, WorkItem workItem) throws ALMException
session
- user session contextwiType
- the work item typeworkItem
- current work item
ALMException
boolean hasDynamicUI(java.util.Map session) throws ALMException
session
- user session context
ALMException
java.lang.String getDynamicUI(java.util.Map session, java.lang.String currentUI) throws ALMException
session
- user session contextcurrentUI
- the current UI xml stream presented in a string
ALMException
boolean hasDynamicModel(java.util.Map session) throws ALMException
session
- user session context
ALMException
java.lang.String getDynamicModel(java.util.Map session, java.lang.String currentModel) throws ALMException
session
- user session contextcurrentModel
- the current model xml stream presented in a string
ALMException
|
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 |