Package | Description |
---|---|
com.unica.publicapi.plan.api |
Modifier and Type | Method and Description |
---|---|
void |
IExecutionContext.acquireLock(Handle handle)
This method replaces acquireLock(Handle handle, String name) method
|
void |
IExecutionContext.acquireLock(Handle handle,
java.lang.String name)
Deprecated.
use acquireLock(Handle handle) instead.
|
Handle |
IPlanAPI.addInvoiceLineItem(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
API to add new line item in invoice
|
Handle |
IPlanAPI.addProjectBudgetLineItem(IExecutionContext context,
Handle hProject,
AttributeMap attributeMap)
Use this API to add new project budget line item
|
void |
IPlanAPI.addProjectRequestRecepients(IExecutionContext context,
Handle hProjectRequest,
AttributeMap[] attributeMap)
Add new project request recipient to project request
|
Handle |
IPlanAPI.appendAttachment(IExecutionContext context,
Handle hParent,
AttributeMap attachmentAttributes) |
Handle |
IPlanAPI.appendGridRow(IExecutionContext context,
Handle hGrid,
AttributeMap rowAttributeMap)
Append a new grid row to the specified object, applying the supplied grid row attributes.
|
Handle |
IPlanAPI.copyProject(IExecutionContext context,
Handle hProject,
ProjectCopyTypeEnum copyEnum,
boolean copyParentLink)
Use this API to copy existing project instance and to create new project.
|
void |
IPlanAPI.copyProjectResources(IExecutionContext context,
Handle hProjectSource,
Handle hProjectDestination)
API to copy resource (People tab of project) from source project to
destination project.
|
Handle |
IPlanAPI.createAsset(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes) |
Handle |
IPlanAPI.createAssetFolder(IExecutionContext context,
Handle parentHandle,
AttributeMap attributeMap) |
Handle |
IPlanAPI.createFinancialAccount(IExecutionContext context,
AttributeMap attributeMap)
API to create new financial account.
|
void |
IPlanAPI.dateRipplingForWorkflowTasks(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Do date rippling for the Project Workflow.
|
void |
IPlanAPI.deleteApprovalItemByName(IExecutionContext context,
Handle hApproval,
java.lang.String itemName)
Delete a single approval item within an Approval process.
|
void |
IPlanAPI.deleteAsset(IExecutionContext context,
Handle hAsset) |
void |
IPlanAPI.deleteGridRow(IExecutionContext context,
Handle hGridRow)
Delete an existing grid row.
|
void |
IPlanAPI.deleteInvoiceLineItem(IExecutionContext context,
Handle hInvoiceLineItem)
Use this API to delete a invoice line item
|
void |
IPlanAPI.deleteProjectLineItem(IExecutionContext context,
Handle hProjectLineItem)
Use this API to delete a project line item
|
void |
IPlanAPI.disableFinancialAccount(IExecutionContext context,
Handle handle)
API to disable financial account
|
void |
IPlanAPI.discardProjectBudgetChanges(IExecutionContext context,
Handle handle)
Use this API to discard changes done in project budget
|
void |
IPlanAPI.enableFinancialAccount(IExecutionContext context,
Handle handle)
API to enable financial account
|
void |
IPlanAPI.finalizeProjectBudgetChanges(IExecutionContext context,
Handle handle,
AttributeMap attrMap)
Use this API to finalize changes done in project budget
|
Handle |
IPlanAPI.findAssetByAttribute(IExecutionContext context,
Handle hAssetLibrary,
java.lang.String attributeName,
java.lang.Object attributeValue) |
Handle |
IPlanAPI.findSubProjectParent(IExecutionContext context,
Handle hProject)
Find the parent project of an existing project, if defined.
|
Handle |
IPlanAPI.findSubProjectRoot(IExecutionContext context,
Handle hProject)
Find the root project of an existing project, if defined.
|
Handle |
IPlanAPI.findWorkflowTaskByAttribute(IExecutionContext context,
Handle hProject,
java.lang.String taskAttributeName,
java.lang.Object[] taskAttributeValues)
Finds the workflow task that matches the supplied attribute.
|
java.lang.Object[] |
IPlanAPI.getApprovalItems(IExecutionContext context,
Handle hApproval)
Get all of the ordered approval items within an Approval object.
|
AttributeMap |
IPlanAPI.getAttributes(IExecutionContext context,
Handle handle)
Fetches the attribute map of the object instance given by the specified
handle.
|
AttributeMap |
IPlanAPI.getFinancialAccountBudget(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API to get financial account budget information
|
java.util.List |
IPlanAPI.getMemberRoles(IExecutionContext context,
Handle hProject)
Find the member roles for an existing project, if defined.
|
java.util.List |
IPlanAPI.getMembersByParticipationLevel(IExecutionContext context,
Handle hProject,
ProjectParticipantLevelEnum participantLevel)
Return members for a specific participation level for an existing project.
|
java.util.List |
IPlanAPI.getMembersByRole(IExecutionContext context,
Handle handle,
java.lang.String roleName)
Return a list of members for a specific member role for an existing object.
|
java.util.List |
IPlanAPI.getMembersByRoleType(IExecutionContext context,
Handle handle,
java.lang.String roleType) |
Handle |
IPlanAPI.getParentHandle(IExecutionContext context,
Handle childHandle)
Returns the parent handle for a particular child handle.
|
AttributeMap |
IPlanAPI.getProjectBudget(IExecutionContext context,
Handle handle,
AttributeMap attributeMap) |
AttributeMap |
IPlanAPI.getProjectBudgetLineItemAllocation(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of project line items is returned by the parameters passed in attributeMap Parameter
|
AttributeMap |
IPlanAPI.getProjectBudgetLineItemSummary(IExecutionContext context,
Handle hProject,
boolean getLastVersion)
Use this API to get project line item summary information i.e.
|
java.util.List |
IPlanAPI.getProjectLineItems(IExecutionContext context,
Handle hProject,
boolean getLastVersion)
Deprecated.
use IPlanAPI.listProjectLineItems() to get list of
ProjectLineItemHandle
and to get attributes of individual line item, use IPlanAPI.getAttributes() providing ProjectLineItemHandle |
AttributeMap[] |
IPlanAPI.getRequestRecipients(IExecutionContext context,
Handle hProjectRequest)
Get all request recipients of project request
|
java.util.List |
IPlanAPI.getReviewerRoles(IExecutionContext context,
Handle hProject)
Find the reviewer roles for an existing project, if defined.
|
java.util.List |
IPlanAPI.getReviewersByRole(IExecutionContext context,
Handle hProject,
java.lang.String roleName)
Return a list of reviewers for a specific reviewer role for an existing project.
|
AttributeMap |
IPlanAPI.getSubProjectAllocation(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of sub project is returned by the parameters passed in attributeMap Parameter
|
AttributeMap |
IPlanAPI.getSubProjectBudgetSummary(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API function to extract Sub Project Budget information.
|
Handle |
IPlanAPI.getWorkflowTaskParentProject(IExecutionContext context,
Handle hTask)
Returns the parent project for a particular task.
|
java.util.Map |
IPlanAPI.getXrefByMarketingObject(IExecutionContext context,
Handle hMarketingObject)
List all of the cross references regarding with this Marketing Object.
|
java.util.Map |
IPlanAPI.getXrefByProject(IExecutionContext context,
Handle hProject)
List all of the cross references regarding with this Project.
|
void |
IPlanAPI.linkProgramChildren(IExecutionContext context,
Handle hParent,
Handle[] hChildren)
Links (adds) one or more projects to a common parent program; all projects must already exist.
|
void |
IPlanAPI.linkProgramPlan(IExecutionContext context,
Handle pgmHandle,
int planID,
java.lang.String programArea)
Link existing Plan object with Program
|
void |
IPlanAPI.linkProjectChildren(IExecutionContext context,
Handle hParent,
Handle[] hChildren)
Links (adds) one or more projects to a common parent project; all projects must already exist.
|
java.util.List |
IPlanAPI.listAllProjectChildren(IExecutionContext context,
Handle hParent)
Lists the all child projects of an existing parent project, if defined.
|
java.util.List |
IPlanAPI.listAssetFolders(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List |
IPlanAPI.listAssets(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes) |
java.util.List |
IPlanAPI.listGridRows(IExecutionContext context,
Handle hGrid,
AttributeMap rowAttributeMap)
Lists all the grid rows whose attributes match those specified for the object;
only grids that the client has read permissions for are considered.
|
java.util.List |
IPlanAPI.listInvoiceLineItems(IExecutionContext context,
Handle handle)
API to list all line items of an Invoice
|
java.util.List |
IPlanAPI.listMarketingObjectGrids(IExecutionContext context,
Handle hMarketingObject)
Lists the grids bound to the specified marketing object, if defined.
|
java.util.List |
IPlanAPI.listMyWorkflowTasks(IExecutionContext context,
AttributeMap taskAttributeMap) |
java.util.List |
IPlanAPI.listPossibleMemberRolesForTask(IExecutionContext context,
Handle hTask) |
java.util.List |
IPlanAPI.listPossibleMembersForTask(IExecutionContext context,
Handle hTask) |
java.util.List |
IPlanAPI.listPossibleReviewerRolesForTask(IExecutionContext context,
Handle hTask) |
java.util.List |
IPlanAPI.listPossibleReviewersForTask(IExecutionContext context,
Handle hTask) |
java.util.List |
IPlanAPI.listProjectChildren(IExecutionContext context,
Handle hParent)
Lists the child projects of an existing parent project, if defined.
|
java.util.List |
IPlanAPI.listProjectGrids(IExecutionContext context,
Handle hProject)
Lists the grids bound to the supplied project, if defined.
|
java.util.List |
IPlanAPI.listProjectLineItems(IExecutionContext context,
Handle hProject,
boolean getLastVersion)
Use this API to get list of all project line item handles
|
java.util.List |
IPlanAPI.listRequestGrids(IExecutionContext context,
Handle hRequest)
Lists the grids bound to the supplied project request, if defined.
|
java.util.List |
IPlanAPI.listWorkflowTasks(IExecutionContext context,
Handle hProject,
AttributeMap taskAttributeMap)
Lists all the workflow tasks whose attributes match those specified; only tasks that
the client has read permissions for are considered.
|
java.util.List |
IPlanAPI.listWorkflowTasksForProject(IExecutionContext context,
Handle hProject) |
java.util.List |
IPlanAPI.listWorkflowTasksForUser(IExecutionContext context,
Handle hUser) |
void |
IPlanAPI.publishFolder(IExecutionContext context,
Handle handle)
Transition state of folder represented by supplied handle to PUBLISHED state
This API will publish given folder and all its parent folders if not published.
|
void |
IPlanAPI.publishOffer(IExecutionContext context,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to PUBLISHED state
|
void |
IPlanAPI.redraftOffer(IExecutionContext context,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to DRAFT state
|
void |
IExecutionContext.releaseLock(Handle handle)
This method replaces releaseLock(Handle handle, String name) method
|
void |
IExecutionContext.releaseLock(Handle handle,
java.lang.String name)
Deprecated.
use releaseLock(Handle handle) instead.
|
void |
IPlanAPI.retireOffer(IExecutionContext context,
Handle handle,
java.lang.String comments)
Transition state of offer represented by supplied handle to RETIRED state
|
void |
IPlanAPI.setMembersByParticipationLevel(IExecutionContext context,
Handle hProject,
Handle[] users,
ProjectParticipantLevelEnum participantLevel,
boolean appendOrReplace)
Update members for a specific participation level for an existing project.
|
void |
IPlanAPI.setMembersByRole(IExecutionContext context,
Handle hProject,
Handle[] users,
java.lang.String roleName,
boolean appendOrReplace)
Update members for a specific member role for an existing Plan objects.
|
void |
IPlanAPI.setReviewersByRole(IExecutionContext context,
Handle hProject,
Handle[] users,
java.lang.String roleName,
boolean appendOrReplace)
Update reviewers for a specific reviewer role for an existing project.
|
void |
IPlanAPI.transitionApprovalStateByHandle(IExecutionContext context,
Handle hApproval,
ApprovalStateEnum stateEnum,
java.lang.String comments)
Change the approval state of an existing approval to a new state.
|
void |
IPlanAPI.transitionInvoiceState(IExecutionContext context,
Handle handle,
InvoiceStateEnum stateEnum,
AttributeMap attributeMap)
API to update state of the Invoice
|
void |
IPlanAPI.transitionMarketingObjectStateByHandle(IExecutionContext context,
Handle hMarketingObject,
java.lang.String state,
java.lang.String comments)
Transition a supplied Marketing Object's state to the new state.
|
void |
IPlanAPI.transitionProgramState(IExecutionContext context,
Handle hProgram,
ProgramState stateEnum,
java.lang.String comments)
Finds the program assigned the supplied unique program handle and transition its state
to the new state.
|
void |
IPlanAPI.transitionProjectRequestStateByHandle(IExecutionContext context,
Handle hProjectRequest,
ProjectStateEnum stateEnum,
java.lang.String comments)
Finds the project request and transition its state to the new state.
On resubmitting returned request, request 'Re-approval Rule' would be: If project request returned and then resubmitted, request is processed by all recipients again To accept request by recipient, "onBehalfOfUserID" user id should be valid recipinet's id. |
void |
IPlanAPI.transitionProjectStateByHandle(IExecutionContext context,
Handle hProject,
ProjectStateEnum stateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
IPlanAPI.transitionWorkflowTaskStateByHandle(IExecutionContext context,
Handle hTask,
TaskStateEnum taskStateEnum,
java.lang.String comments)
Overloaded API with comments parameters.
|
void |
IPlanAPI.unlinkProgramChildren(IExecutionContext context,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent program; all projects
must already exist.
|
void |
IPlanAPI.unlinkProgramPlan(IExecutionContext context,
Handle handle)
UnLink existing Plan object from Program
|
void |
IPlanAPI.unlinkProjectChildren(IExecutionContext context,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent project; all projects
must already exist.
|
void |
IPlanAPI.updateApprovalItems(IExecutionContext context,
Handle hApproval,
java.lang.Object[] approvalItems,
java.lang.String[] instructions)
This method updates one or more approval item(s) within a single
Approval object.
|
void |
IPlanAPI.updateAttribute(IExecutionContext context,
Handle handle,
java.lang.String attributeName,
java.lang.Object[] attributeValues)
Update the attribute of the object instance given by the specified handle.
|
void |
IPlanAPI.updateAttributes(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Update one or more attributes of the object instance given by the specified handle.
|
void |
IPlanAPI.updateFinancialAccountBudget(IExecutionContext context,
Handle sourceAccount,
int fiscalYear,
AttributeMap attributeMap)
API to update account budget information in one call you can update
budget information for one financial year
|
void |
IPlanAPI.updateMembersByRoleType(IExecutionContext context,
Handle handle,
java.lang.String roleType,
Handle[] hUser) |
void |
IPlanAPI.updateProjectLineItemAllocation(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API function to update project line item allocation
|
void |
IPlanAPI.updateProjectRequestRecepient(IExecutionContext context,
Handle hProjectRequest,
Handle userHandle,
AttributeMap attributeMap)
Update project request recipients.
|
void |
IPlanAPI.updateSubProjectAllocation(IExecutionContext context,
Handle handle,
Handle hSubProject,
AttributeMap attributeMap)
Use this API function to update sub project allocation
|