|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPlanAPI
IPlanAPI defines the public Plan Application Programming Interface.
Field Summary | |
---|---|
static java.lang.String |
APPROVAL_ATTRIBUTE_APPROVER
An array of user handles providing the approver of the Approval object It is required when creating a new approval. |
static java.lang.String |
APPROVAL_ATTRIBUTE_DESCRIPTION
A String defining the approval description. |
static java.lang.String |
APPROVAL_ATTRIBUTE_METHOD
Deprecated. from plan7.5 approval does not contain approval methods, approval method is defined by the approver sequence |
static java.lang.String |
APPROVAL_ATTRIBUTE_OWNER
An array of user handles providing the owner of the Approval object. |
static java.lang.String |
APPROVAL_ATTRIBUTE_SECURITY_POLICY
An optional String object defining name of the approval security policy, if not specified while approval creation default security policy is applied to approval |
static java.lang.String |
APPROVAL_ATTRIBUTE_STATEENUM
A ApprovalStateEnum enumerated type represents the current state of the approval. |
static java.lang.String |
APPROVAL_ATTRIBUTE_SUBJECT
A String defining the approval subject. |
static java.lang.String |
APPROVAL_ATTRIBUTE_TARGETDUEDATE
The overall target due date of current approval process. |
static java.lang.String |
ASSET_ATTRIBUTE_ASSET_CODE
|
static java.lang.String |
ASSET_ATTRIBUTE_DESCRIPTION
|
static java.lang.String |
ASSET_ATTRIBUTE_EXPIRATION_DATE
|
static java.lang.String |
ASSET_ATTRIBUTE_FILE
|
static java.lang.String |
ASSET_ATTRIBUTE_KEYWORDS
|
static java.lang.String |
ASSET_ATTRIBUTE_NAME
|
static java.lang.String |
ASSET_ATTRIBUTE_OWNERS
|
static java.lang.String |
ASSET_ATTRIBUTE_PREVIEW_FILE
|
static java.lang.String |
ASSET_ATTRIBUTE_THUMBNAIL_FILE
|
static java.lang.String |
ASSET_ATTRIBUTE_USAGE_GUIDELINES
|
static java.lang.String |
ASSET_ATTRIBUTE_VERSION_NAME
|
static java.lang.String |
ASSET_FOLDER_ATTRIBUTE_DESCRIPTION
|
static java.lang.String |
ASSET_FOLDER_ATTRIBUTE_NAME
|
static java.lang.String |
ASSET_LIBRARY_ATTRIBUTE_DESCRIPTION
|
static java.lang.String |
ASSET_LIBRARY_ATTRIBUTE_NAME
|
static java.lang.String |
ASSET_LIBRARY_ATTRIBUTE_STATEENUM
|
static java.lang.String |
ASSET_OWNER_ROLE
This is not an Asset attribute. |
static java.lang.String |
ATTACHMENT_ATTRIBUTE_ATTACHMENT
|
static java.lang.String |
ATTACHMENT_ATTRIBUTE_COMMENTS
|
static java.lang.String |
ATTACHMENT_ATTRIBUTE_FOLDER_ID
|
static java.lang.String |
ATTACHMENT_ATTRIBUTE_TYPEENUM
|
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_ACTUAL
Double Represents Actual budget for Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_ALL
Double Represents all budget information i.e. |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_ALLOTTED
Double Represents Allotted Budget to Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_APR
Double Represents Financial Account Budget for month of Apr |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_AUG
Double Represents Financial Account Budget for month of Aug |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_AVAILABLE
Double Represents Available Budget for Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_COMMITTED
Double Represents Committed Budget for Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_DEC
Double Represents Financial Account Budget for month of Dec |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_FEB
Double Represents Financial Account Budget for month of Feb |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_FORECAST
Double Represents Forecast Budget for Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_JAN
Double Represents Financial Account Budget for month of Jan |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_JUL
Double Represents Financial Account Budget for month of Jul |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_JUN
Double Represents Financial Account Budget for month of Jun |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_MAR
Double Represents Financial Account Budget for month of Mar |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_MAY
Double Represents Financial Account Budget for month of May |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_NOV
Double Represents Financial Account Budget for month of Nov |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_OCT
Double Represents Financial Account Budget for month of Oct |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_Q1
Double Represents budget information of Financial Account for Q1 |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_Q2
Double Represents budget information of Financial Account for Q2 |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_Q3
Double Represents budget information of Financial Account for Q3 |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_Q4
Double Represents budget information of Financial Account for Q3 |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_REMAINING
Double Represents Remaining budget for Financial Account Budget |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_SEP
Double Represents Financial Account Budget for month of Sep |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_TOTAL
Double Represents total budget information of Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_TYPE
Double Represents Financial Account budget type |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_UNCOMMITTED
Double Represents Un-committed budget for Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_BUDGET_YEAR
Double Represents Financial Account budget fiscal year |
static java.lang.String |
FINANCIAL_ACCOUNT_DESCRIPTION
String Represents Financial Account description |
static java.lang.String |
FINANCIAL_ACCOUNT_NAME
String Represents Financial Account Name |
static java.lang.String |
FINANCIAL_ACCOUNT_NUMBER
String Represents Financial Account Number |
static java.lang.String |
FINANCIAL_ACCOUNT_SECURITY_POLICY
String Represents Financial Account Security Policy |
static java.lang.String |
FINANCIAL_ACCOUNT_SOURCE_ACCOUNT
Handle Represents Parent Financial Account |
static java.lang.String |
FINANCIAL_ACCOUNT_TEAM_MEMBERS
Handle Represents Financial Account Team Members |
static java.lang.String |
GRID_ATTRIBUTE_NAME
Read-only String defining the name of the grid. |
static java.lang.String |
INVOICE_DATE
Date Represents Invoice Date |
static java.lang.String |
INVOICE_DUE_DATE
Date Represents Invoice Due Date |
static java.lang.String |
INVOICE_LINE_ITEM_COST
Double Represents Invoice Line Item cost |
static java.lang.String |
INVOICE_LINE_ITEM_COST_CATEGORY
String Represents Invoice Line Item cost category |
static java.lang.String |
INVOICE_LINE_ITEM_COST_PER_UNIT
Double Represents Invoice Line Item cost per uniit |
static java.lang.String |
INVOICE_LINE_ITEM_DESCRIPTION
String Represents Invoice Line Item Description |
static java.lang.String |
INVOICE_LINE_ITEM_QUANTITY
Integer Represents Invoice Line Item quantity |
static java.lang.String |
INVOICE_LINE_ITEM_SOURCE_ACCOUNT
Handle Represents Invoice Line Item source account |
static java.lang.String |
INVOICE_LINE_ITEM_SOURCE_PLAN_OBJECT
Deprecated. since object code can be ambiguous, use IPlanAPI.INVOICE_LINE_ITEM_SOURCE_PLAN_OBJECT_ID String Represents Invoice Line Item plan object |
static java.lang.String |
INVOICE_LINE_ITEM_SOURCE_PLAN_OBJECT_ID
Integer Represents Invoice Line Item plan object id |
static java.lang.String |
INVOICE_NOTES
String Represents Invoice Notes |
static java.lang.String |
INVOICE_NUMBER
String Represents Invoice number |
static java.lang.String |
INVOICE_OWNER
User Represents Invoice owner |
static java.lang.String |
INVOICE_PAID_DATE
Calendar Represents Invoice Paid Date |
static java.lang.String |
INVOICE_PAYMENT_TERMS
String Represents Invoice Payment Terms |
static java.lang.String |
INVOICE_PURCHASE_ORDER_NUMBER
String Represents Invoice Purchase Order Number |
static java.lang.String |
INVOICE_SECURITY_POLICY
StringRepresents Invoice Security Policy Name |
static java.lang.String |
INVOICE_STATE_TRANSITION_COMMENT
String Represents Invoice State transition comment |
static java.lang.String |
INVOICE_STATUS
InvoiceStatusEnum Represents Invoice Payment Terms |
static java.lang.String |
INVOICE_VENDOR_CODE
String Represents Invoice Vender Code |
static java.lang.String |
LINE_ITEM_LINKED_APPROVAL
Handle Represents Approval linked to (Project/Invoice) Line Item, if line item has any budget linked approval to it. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_ATTACHMENTS
Handle defining attachments for the their parent object like a project or a marketing object. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_CODE
An optional String defining an alphanumeric code that uniquely identifies the marketing object. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_DESCRIPTION
|
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_NAME
Read-only String defining the name of the marketing object. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_OWNER
An array of PlanUserHandle providing the list of the Marketing Object owners. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_SECURITY_POLICY
An optional String object defining name of the marketing object security policy, if not specified while marketing object creation default security policy is applied to marketing object |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_STATE
A String object (note type) defining the current state of the marketing object. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_TEMPLATENAME
Read-only String defining the name of the template used to create the marketing object. |
static java.lang.String |
MARKETING_OBJECT_ATTRIBUTE_TEMPLATETYPE
Read-only String defining the unique template type used to create the marketing object. |
static java.lang.String |
PLAN_NAMESPACE_PREFIX
"uap" prefix is reserved for the Unica Plan attribute name space |
static java.lang.String |
PROJECT_ATTRIBUTE_ATTACHMENTS
Handle defining attachments for the their parent object like a project or a marketing object. |
static java.lang.String |
PROJECT_ATTRIBUTE_BUDGET_GRANULARITY
An optional String object defining budget granularity level for project. |
static java.lang.String |
PROJECT_ATTRIBUTE_CODE
An optional String defining an alphanumeric code that uniquely identifies the project. |
static java.lang.String |
PROJECT_ATTRIBUTE_DESCRIPTION
Optional String describing the project. |
static java.lang.String |
PROJECT_ATTRIBUTE_ENDDATE
As with start date, but defines the date the project will end. |
static java.lang.String |
PROJECT_ATTRIBUTE_ISREQUEST
Read-only Boolean indicating if this project is a project request true or a "real" project. |
static java.lang.String |
PROJECT_ATTRIBUTE_NAME
String defining the name of the project. |
static java.lang.String |
PROJECT_ATTRIBUTE_SECURITY_POLICY
An optional String object defining name of the project security policy, if not specified while project creation default security policy is applied to project |
static java.lang.String |
PROJECT_ATTRIBUTE_STARTDATE
An optional Date object defining the date the project started. |
static java.lang.String |
PROJECT_ATTRIBUTE_STATEENUM
A ProjectStateEnum enumerated type giving the current state of the project. |
static java.lang.String |
PROJECT_ATTRIBUTE_TEMPLATENAME
Read-only String defining the unique name of the template used to create the project. |
static java.lang.String |
PROJECT_BUDGET_ACTUAL_SPENT
Represents project budget line item account code |
static java.lang.String |
PROJECT_BUDGET_ALLOCATION_PERIOD
Represents project budget allocation period |
static java.lang.String |
PROJECT_BUDGET_ALLOCATION_YEAR
Represents key for project budget allocation period for yearly or quarterly |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_ALLOCATION
Represents key for line item sub project budget allocation |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_COMMITTED_AMOUNT
Represents project budget line item committed amount |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_COST_CATEGORY
Represents project budget line item cost category |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_COST_CATEGORY_ID
Represents project budget line item cost category id |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_DESCRIPTION
Represents project budget line item description |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_EXPENDITURE_DATE
Represents project budget line item expenditure date |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_FORECAST_AMOUNT
Represents project budget line item forecast amount |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_ID
Represents unique ID for project budget line item |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT
Represents project budget line item source account |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT_CODE
Represents project budget line item account code |
static java.lang.String |
PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT_ID
Represents project budget line item account id |
static java.lang.String |
PROJECT_BUDGET_MONTH
|
static java.lang.String |
PROJECT_BUDGET_PERIOD
|
static java.lang.String |
PROJECT_BUDGET_QUARTER
|
static java.lang.String |
PROJECT_BUDGET_TOTAL
|
static java.lang.String |
PROJECT_BUDGET_TOTAL_COMMITTED
Represents project budget line item account code |
static java.lang.String |
PROJECT_BUDGET_TOTAL_FORCAST
Represents project budget line item account code |
static java.lang.String |
PROJECT_BUDGET_TYPE
|
static java.lang.String |
PROJECT_BUDGET_WEEK
|
static java.lang.String |
PROJECT_BUDGET_YEAR
|
static java.lang.String |
PROJECT_LINKED_PROGRAM_ID
This is not a project base attribute, but it will be exposed in get and set project attributes. |
static java.lang.String |
PROJECT_MEMBER_ROLE_UNASSIGNED
This is not a Project attribute. |
static java.lang.String |
PROJECT_REQUEST_ATTRIBUTE_NAME
String defining the name of the project request. |
static java.lang.String |
PROJECT_REQUEST_ATTRIBUTE_RECIPIENTS
String defining the list of project request recipients. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_DURATION
String defining the user of project request recipient. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_INSTRUCTIONS
String defining the instructions of project request recipient. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_IS_PROJECT_OWNER
String defining the owner of project request recipient. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_IS_REQUIRED
String defining project request recipient is required or not. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_ROLE
String defining the role of project request recipient. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_SEQUENCE
String defining the sequence of project request recipient. |
static java.lang.String |
PROJECT_REQUEST_RECIPIENT_USER
String defining the user of project request recipient. |
static java.lang.String |
PROJECT_REVIEWER_ROLE_UNASSIGNED
This is not a Project attribute. |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALDURATION
Deprecated. Use TASK_ATTRIBUTE_ACTUALDURATION_DETAILED |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALDURATION_DETAILED
Optional String object, the actual duration for the task Format for duration is DD-HH-MM, e.g. |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALEFFORT
Deprecated. Use TASK_ATTRIBUTE_ACTUALEFFORT_DETAILED |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALEFFORT_DETAILED
Optional String object, the actual effort to complete the task. |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALENDDATE
Optional Date As with actual end date, but defines the date the task actually ended (or is forecast to end if in the future). |
static java.lang.String |
TASK_ATTRIBUTE_ACTUALSTARTDATE
Optional Date object defining the date the task actually started (or is forecast to start if in the future). |
static java.lang.String |
TASK_ATTRIBUTE_CODE
An optional String defining an alphanumeric code that uniquely identifies the task. |
static java.lang.String |
TASK_ATTRIBUTE_COMMENT
Optional String defining a comment for the task. |
static java.lang.String |
TASK_ATTRIBUTE_DEPENDENT_TASKS
Read Only WorkflowTasHandle defining dependent tasks for the task. |
static java.lang.String |
TASK_ATTRIBUTE_ISSTAGE
The Boolean indicating if this task is a stage. |
static java.lang.String |
TASK_ATTRIBUTE_MEMBER
PlanUserHandle or |
static java.lang.String |
TASK_ATTRIBUTE_MEMBER_ROLE
The Integer object defining the id of the member role on a workflow task |
static java.lang.String |
TASK_ATTRIBUTE_MILESTONE
Optional String describing the milestone associated with this task. |
static java.lang.String |
TASK_ATTRIBUTE_NAME
Read-only String defining the name of the task. |
static java.lang.String |
TASK_ATTRIBUTE_PARENT_TASKS
A array of WorkflowTaskHandle defining parent tasks this task is depending on. |
static java.lang.String |
TASK_ATTRIBUTE_REVIEWER
PlanUserHandle or |
static java.lang.String |
TASK_ATTRIBUTE_REVIEWER_ROLE
The Integer object defining the id of the reviewr role on a workflow task |
static java.lang.String |
TASK_ATTRIBUTE_STAGE_NUMBER
The Integer object defining the stage number on a workflow task |
static java.lang.String |
TASK_ATTRIBUTE_STATEENUM
A TaskStateEnum enumerated type defining the current state of the task. |
static java.lang.String |
TASK_ATTRIBUTE_TARGETDURATION
Deprecated. Use TASK_ATTRIBUTE_TARGETDURATION_DETAILED |
static java.lang.String |
TASK_ATTRIBUTE_TARGETDURATION_DETAILED
Optional String object, the target duration for the task, Format for effort is DD-HH-MM, e.g. |
static java.lang.String |
TASK_ATTRIBUTE_TARGETEFFORT
Deprecated. Use TASK_ATTRIBUTE_TARGETEFFORT_DETAILED |
static java.lang.String |
TASK_ATTRIBUTE_TARGETEFFORT_DETAILED
Optional String object, the target estimated effort to complete the task Format for effort is DD-HH-MM, e.g. |
static java.lang.String |
TASK_ATTRIBUTE_TARGETENDDATE
Optional Date As with scheduled end date, but defines the date the task is (was) scheduled to end. |
static java.lang.String |
TASK_ATTRIBUTE_TARGETSTARTDATE
Optional Date object defining the date the task is (was) scheduled to start. |
static java.lang.String |
TASK_DATE_RIPPLING_ATTRIBUTE_ACTUAL_OR_TARGET_FLAG
Boolean defining whether ripple forecast/actual dates or target dates. |
static java.lang.String |
TASK_DATE_RIPPLING_ATTRIBUTE_COMPRESS_SLACK
Boolean defining whether compressing slack time. |
static java.lang.String |
TEAM_ATTRIBUTE_APPROVAL_MANAGER_CAN_ROUTE_APPROVALS_TO_MEMBERS
|
static java.lang.String |
TEAM_ATTRIBUTE_APPROVAL_MEMBERS_CAN_RETURN_TEAM_ASSIGNED_APPROVALS
|
static java.lang.String |
TEAM_ATTRIBUTE_APPROVAL_MEMBERS_CAN_TAKE_OWNERSHIP_OF_TEAM_ASSIGNED_APPROVALS
|
static java.lang.String |
TEAM_ATTRIBUTE_DESCRIPTION
|
static java.lang.String |
TEAM_ATTRIBUTE_MANAGERS
|
static java.lang.String |
TEAM_ATTRIBUTE_MEMBERS
|
static java.lang.String |
TEAM_ATTRIBUTE_NAME
|
static java.lang.String |
TEAM_ATTRIBUTE_PROJ_REQ_MANAGER_CAN_ROUTE_PROJ_REQ_TO_MEMBERS
|
static java.lang.String |
TEAM_ATTRIBUTE_PROJ_REQ_MEMBERS_CAN_TAKE_OWNERSHIP_OF_TEAM_ASSIGNED_PROJ_REQ
|
static java.lang.String |
TEAM_ATTRIBUTE_SKILL_SETS
|
static java.lang.String |
TEAM_ATTRIBUTE_TASK_MANAGER_CAN_ROUTE_WORK_TO_MEMBERS
|
static java.lang.String |
TEAM_ATTRIBUTE_TASK_MEMBERS_CAN_ACCEPT_TEAM_ASSIGNED_TASKS
|
static java.lang.String |
TEAM_ATTRIBUTE_TASK_MEMBERS_CAN_RETURN_TEAM_ASSIGNED_TASKS
|
static java.lang.String |
USER_ATTRIBUTE_EMAIL
|
static java.lang.String |
USER_ATTRIBUTE_FIRST_NAME
|
static java.lang.String |
USER_ATTRIBUTE_LAST_NAME
|
static java.lang.String |
USER_ATTRIBUTE_LOCALE
|
static java.lang.String |
USER_ATTRIBUTE_LOGIN
|
static java.lang.String |
USER_ATTRIBUTE_ROLES
|
static java.lang.String |
XREF_APPROVALS_REF_TO_MO
|
static java.lang.String |
XREF_MO_MOD_BY_PROJECT
|
static java.lang.String |
XREF_MO_REF_BY_MO
|
static java.lang.String |
XREF_MO_REF_BY_PROJECT
|
static java.lang.String |
XREF_MO_REF_TO_MO
|
static java.lang.String |
XREF_PROJECTS_MODIFIY_MO
|
static java.lang.String |
XREF_PROJECTS_REF_TO_MO
|
Method Summary | |
---|---|
Handle |
addInvoiceLineItem(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
API to add new line item in invoice |
Handle |
addProjectBudgetLineItem(IExecutionContext context,
Handle hProject,
AttributeMap attributeMap)
Use this API to add new project budget line item |
void |
addProjectRequestRecepients(IExecutionContext context,
Handle hProjectRequest,
AttributeMap[] attributeMap)
Add new project request recipient to project request |
Handle |
appendAttachment(IExecutionContext context,
Handle hParent,
AttributeMap attachmentAttributes)
|
Handle |
appendGridRow(IExecutionContext context,
Handle hGrid,
AttributeMap rowAttributeMap)
Append a new grid row to the specified object, applying the supplied grid row attributes. |
Handle |
copyProject(IExecutionContext context,
Handle hProject,
ProjectCopyTypeEnum copyEnum,
boolean copyParentLink)
Use this API to copy existing project instance and to create new project. |
void |
copyProjectResources(IExecutionContext context,
Handle hProjectSource,
Handle hProjectDestination)
API to copy resource (People tab of project) from source project to destination project. |
Handle |
createApproval(IExecutionContext context,
AttributeMap attributeMap)
Create a new approval component with specified attributes and user information from the execution context. |
Handle |
createAsset(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes)
|
Handle |
createAssetFolder(IExecutionContext context,
Handle parentHandle,
AttributeMap attributeMap)
|
Handle |
createFinancialAccount(IExecutionContext context,
AttributeMap attributeMap)
API to create new financial account. |
Handle |
createInvoice(IExecutionContext context,
AttributeMap attributeMap)
API to create new Invoice in Plan |
Handle |
createMarketingObject(IExecutionContext context,
java.lang.String templateType,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new marketing object component from the named template, applying the specified attributes and user information from the execution context. |
Handle |
createProject(IExecutionContext context,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new project component from the named template, applying the specified attributes and user information from the execution context. |
Handle |
createProjectRequest(IExecutionContext context,
java.lang.String templateName,
AttributeMap attributeMap)
Create a new project request instance from the named template, applying the specified attributes and user information from the execution context. |
void |
dateRipplingForWorkflowTasks(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Do date rippling for the Project Workflow. |
void |
deleteApprovalItemByName(IExecutionContext context,
Handle hApproval,
java.lang.String itemName)
Delete a single approval item within an Approval process. |
void |
deleteAsset(IExecutionContext context,
Handle hAsset)
|
void |
deleteGridRow(IExecutionContext context,
Handle hGridRow)
Delete an existing grid row. |
void |
deleteInvoiceLineItem(IExecutionContext context,
Handle hInvoiceLineItem)
Use this API to delete a invoice line item |
void |
deleteProjectLineItem(IExecutionContext context,
Handle hProjectLineItem)
Use this API to delete a project line item |
void |
disableFinancialAccount(IExecutionContext context,
Handle handle)
API to disable financial account |
void |
discardProjectBudgetChanges(IExecutionContext context,
Handle handle)
Use this API to discard changes done in project budget |
void |
enableFinancialAccount(IExecutionContext context,
Handle handle)
API to enable financial account |
void |
finalizeProjectBudgetChanges(IExecutionContext context,
Handle handle,
AttributeMap attrMap)
Use this API to finalize changes done in project budget |
Handle |
findApprovalByAttribute(IExecutionContext context,
java.lang.String ApprovalAttributeName,
java.lang.Object[] ApprovalAttributeValues)
Find the Approval object that matches the supplied attributes. |
Handle |
findAssetByAttribute(IExecutionContext context,
Handle hAssetLibrary,
java.lang.String attributeName,
java.lang.Object attributeValue)
|
Handle |
findAssetLibraryByAttribute(IExecutionContext context,
java.lang.String attributeName,
java.lang.Object attributeValue)
Finds an asset library that matches the supplied attribute. |
Handle |
findFinancialAccountByNumber(IExecutionContext context,
java.lang.String accountNumber)
API to find financial account by account number |
Handle |
findInvoiceByNumberAndVendor(IExecutionContext context,
java.lang.String invoiceNumber,
java.lang.String vendorCode)
API to find invoice by number and vendor code |
Handle |
findMarketingObjectByAttribute(IExecutionContext context,
java.lang.String type,
java.lang.String moAttributeName,
java.lang.Object[] moAttributeValues)
Finds the marketing object that matches the supplied attribute. |
Handle |
findProjectByAttribute(IExecutionContext context,
java.lang.String name,
java.lang.Object[] values)
Finds the project that matches the supplied attribute. |
Handle |
findProjectRequestByAttribute(IExecutionContext context,
java.lang.String name,
java.lang.Object[] values)
Finds the project request that matches the supplied attribute. |
Handle |
findSubProjectParent(IExecutionContext context,
Handle hProject)
Find the parent project of an existing project, if defined. |
Handle |
findSubProjectRoot(IExecutionContext context,
Handle hProject)
Find the root project of an existing project, if defined. |
Handle |
findTeamByAttribute(IExecutionContext context,
java.lang.String attributeName,
java.lang.Object attributeValue)
|
Handle |
findUserByAttribute(IExecutionContext context,
java.lang.String attributeName,
java.lang.Object[] attributeValues)
|
Handle |
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[] |
getApprovalItems(IExecutionContext context,
Handle hApproval)
Get all of the ordered approval items within an Approval object. |
AttributeMap |
getAttributes(IExecutionContext context,
Handle handle)
Fetches the attribute map of the object instance given by the specified handle. |
AttributeMap |
getFinancialAccountBudget(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API to get financial account budget information |
java.util.List |
getMemberRoles(IExecutionContext context,
Handle hProject)
Find the member roles for an existing project, if defined. |
java.util.List |
getMembersByParticipationLevel(IExecutionContext context,
Handle hProject,
ProjectParticipantLevelEnum participantLevel)
Return members for a specific paricipation level for an existing project. |
java.util.List |
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 |
getMembersByRoleType(IExecutionContext context,
Handle handle,
java.lang.String roleType)
|
Handle |
getParentHandle(IExecutionContext context,
Handle childHandle)
Returns the parent handle for a particular child handle. |
AttributeMap |
getProjectBudget(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
|
AttributeMap |
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 |
getProjectBudgetLineItemSummary(IExecutionContext context,
Handle hProject,
boolean getLastVersion)
Use this API to get project line item summary information i.e. |
java.util.List |
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[] |
getRequestRecipients(IExecutionContext context,
Handle hProjectRequest)
Get all request recipients of project request |
java.util.List |
getReviewerRoles(IExecutionContext context,
Handle hProject)
Find the reviewer roles for an existing project, if defined. |
java.util.List |
getReviewersByRole(IExecutionContext context,
Handle hProject,
java.lang.String roleName)
Return a list of reviewers for a specific reviewer role for an existing project. |
AttributeMap |
getSubProjectAllocation(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Allocations (total, yearly, quarterly) of sub project is returned by the parameters passed in attributeMap Parameter |
AttributeMap |
getSubProjectBudgetSummary(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API function to extract Sub Project Budget information. |
Handle |
getWorkflowTaskParentProject(IExecutionContext context,
Handle hTask)
Returns the parent project for a particular task. |
java.util.Map |
getXrefByMarketingObject(IExecutionContext context,
Handle hMarketingObject)
List all of the cross references regarding with this Marketing Object. |
java.util.Map |
getXrefByProject(IExecutionContext context,
Handle hProject)
List all of the cross references regarding with this Project. |
void |
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 |
listAllProjectChildren(IExecutionContext context,
Handle hParent)
Lists the all child projects of an existing parent project, if defined. |
java.util.List |
listApprovals(IExecutionContext context,
AttributeMap attributeMap)
Lists all approvals whose attributes match those specified. |
java.util.List |
listAssetFolders(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes)
|
java.util.List |
listAssetLibraries(IExecutionContext context,
AttributeMap attributeMap)
Lists all asset libraries whose attributes match those specified; only asset libraries that the client has read permissions are considered. |
java.util.List |
listAssets(IExecutionContext context,
Handle hAssetLibrary,
AttributeMap attributes)
|
java.util.List |
listFinancialAccounts(IExecutionContext context,
boolean includeDisabled)
API to list financial Account |
java.util.List |
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 |
listInvoiceLineItems(IExecutionContext context,
Handle handle)
API to list all line items of an Invoice |
java.util.List |
listInvoices(IExecutionContext context)
API to list all available invoices |
java.util.List |
listMarketingObjectGrids(IExecutionContext context,
Handle hMarketingObject)
Lists the grids bound to the specified marketing object, if defined. |
java.util.List |
listMarketingObjects(IExecutionContext context,
AttributeMap attributeMap)
Lists all the marketing objects whose attributes match those specified; only marketing objects that the client has read permissions for are considered. |
java.util.List |
listPossibleMemberRolesForTask(IExecutionContext context,
Handle hTask)
|
java.util.List |
listPossibleMembersForTask(IExecutionContext context,
Handle hTask)
|
java.util.List |
listPossibleReviewerRolesForTask(IExecutionContext context,
Handle hTask)
|
java.util.List |
listPossibleReviewersForTask(IExecutionContext context,
Handle hTask)
|
java.util.List |
listProjectChildren(IExecutionContext context,
Handle hParent)
Lists the child projects of an existing parent project, if defined. |
java.util.List |
listProjectGrids(IExecutionContext context,
Handle hProject)
Lists the grids bound to the supplied project, if defined. |
java.util.List |
listProjectLineItems(IExecutionContext context,
Handle hProject,
boolean getLastVersion)
Use this API to get list of all project line item handles |
java.util.List |
listProjectRequests(IExecutionContext context,
AttributeMap attributeMap)
Lists all projects request whose attributes match those specified; only project requests that the client has read permissions for are considered. |
java.util.List |
listProjects(IExecutionContext context,
AttributeMap attributeMap)
Lists all projects whose attributes match those specified; only projects that the client has read permissions for are considered. |
java.util.List |
listTeams(IExecutionContext context,
AttributeMap attributes)
|
java.util.List |
listUsers(IExecutionContext context,
AttributeMap attributes)
|
java.util.List |
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 |
listWorkflowTasksForProject(IExecutionContext context,
Handle hProject)
|
java.util.List |
listWorkflowTasksForUser(IExecutionContext context,
Handle hUser)
|
void |
setMembersByParticipationLevel(IExecutionContext context,
Handle hProject,
Handle[] users,
ProjectParticipantLevelEnum participantLevel,
boolean appendOrReplace)
Update members for a specific paricipation level for an existing project. |
void |
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 |
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 |
transitionApprovalStateByHandle(IExecutionContext context,
Handle hApproval,
ApprovalStateEnum stateEnum,
java.lang.String comments)
Change the approval state of an existing approval to a new state. |
void |
transitionAssetStateByCode(IExecutionContext context,
java.lang.String code,
AssetStateEnum stateEnum,
java.lang.String comments)
|
void |
transitionInvoiceState(IExecutionContext context,
Handle handle,
InvoiceStateEnum stateEnum,
AttributeMap attributeMap)
API to update state of the Invoice |
void |
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 |
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 |
transitionProjectStateByCode(IExecutionContext context,
java.lang.String code,
ProjectStateEnum stateEnum)
Deprecated. |
void |
transitionProjectStateByHandle(IExecutionContext context,
Handle hProject,
ProjectStateEnum stateEnum,
java.lang.String comments)
Overloaded API with comments parameters. |
void |
transitionWorkflowTaskStateByHandle(IExecutionContext context,
Handle hTask,
TaskStateEnum taskStateEnum,
java.lang.String comments)
Overloaded API with comments parameters. |
void |
transitionWorkflowTaskStateByName(IExecutionContext context,
java.lang.String projectCode,
java.lang.String taskName,
TaskStateEnum taskStateEnum)
Deprecated. use @see Finds the workflow task that has the specified project code and task name and transitions its state to the new state. Convenience API; identical to making the following API calls:
|
void |
unlinkProjectChildren(IExecutionContext context,
Handle hParent,
Handle[] hChildren)
Unlinks one or more child projects from their common parent project; all projects must already exist. |
void |
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 |
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 |
updateAttributes(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Update one or more attributes of the object instance given by the specified handle. |
void |
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 |
updateMembersByRoleType(IExecutionContext context,
Handle handle,
java.lang.String roleType,
Handle[] hUser)
|
void |
updateProjectLineItemAllocation(IExecutionContext context,
Handle handle,
AttributeMap attributeMap)
Use this API function to update project line item allocation |
void |
updateProjectRequestRecepient(IExecutionContext context,
Handle hProjectRequest,
Handle userHandle,
AttributeMap attributeMap)
Update project request recipients. |
void |
updateSubProjectAllocation(IExecutionContext context,
Handle handle,
Handle hSubProject,
AttributeMap attributeMap)
Use this API function to update sub project allocation |
Field Detail |
---|
static final java.lang.String PLAN_NAMESPACE_PREFIX
static final java.lang.String PROJECT_ATTRIBUTE_NAME
static final java.lang.String PROJECT_ATTRIBUTE_DESCRIPTION
static final java.lang.String PROJECT_ATTRIBUTE_STATEENUM
static final java.lang.String PROJECT_ATTRIBUTE_CODE
static final java.lang.String PROJECT_ATTRIBUTE_TEMPLATENAME
static final java.lang.String PROJECT_ATTRIBUTE_STARTDATE
static final java.lang.String PROJECT_ATTRIBUTE_ENDDATE
static final java.lang.String PROJECT_ATTRIBUTE_ISREQUEST
static final java.lang.String PROJECT_ATTRIBUTE_ATTACHMENTS
static final java.lang.String PROJECT_MEMBER_ROLE_UNASSIGNED
static final java.lang.String PROJECT_REVIEWER_ROLE_UNASSIGNED
static final java.lang.String PROJECT_ATTRIBUTE_SECURITY_POLICY
static final java.lang.String PROJECT_LINKED_PROGRAM_ID
static final java.lang.String PROJECT_ATTRIBUTE_BUDGET_GRANULARITY
BudgetPeriodEnum
Only BudgetPeriodEnum.QUARTERLY, BudgetPeriodEnum.MONTHLY and BudgetPeriodEnum.WEEKLY are allowed as values for this attribute
If not specified default granularity of quarterly will be used.
static final java.lang.String PROJECT_REQUEST_ATTRIBUTE_NAME
static final java.lang.String PROJECT_REQUEST_ATTRIBUTE_RECIPIENTS
static final java.lang.String PROJECT_REQUEST_RECIPIENT_ROLE
static final java.lang.String PROJECT_REQUEST_RECIPIENT_USER
static final java.lang.String PROJECT_REQUEST_RECIPIENT_DURATION
static final java.lang.String PROJECT_REQUEST_RECIPIENT_SEQUENCE
static final java.lang.String PROJECT_REQUEST_RECIPIENT_IS_PROJECT_OWNER
static final java.lang.String PROJECT_REQUEST_RECIPIENT_IS_REQUIRED
static final java.lang.String PROJECT_REQUEST_RECIPIENT_INSTRUCTIONS
static final java.lang.String TASK_ATTRIBUTE_NAME
static final java.lang.String TASK_ATTRIBUTE_STATEENUM
static final java.lang.String TASK_ATTRIBUTE_TARGETSTARTDATE
static final java.lang.String TASK_ATTRIBUTE_TARGETENDDATE
static final java.lang.String TASK_ATTRIBUTE_TARGETDURATION
static final java.lang.String TASK_ATTRIBUTE_TARGETDURATION_DETAILED
static final java.lang.String TASK_ATTRIBUTE_TARGETEFFORT
static final java.lang.String TASK_ATTRIBUTE_TARGETEFFORT_DETAILED
static final java.lang.String TASK_ATTRIBUTE_ACTUALSTARTDATE
static final java.lang.String TASK_ATTRIBUTE_ACTUALENDDATE
static final java.lang.String TASK_ATTRIBUTE_ACTUALDURATION
static final java.lang.String TASK_ATTRIBUTE_ACTUALDURATION_DETAILED
static final java.lang.String TASK_ATTRIBUTE_ACTUALEFFORT
static final java.lang.String TASK_ATTRIBUTE_ACTUALEFFORT_DETAILED
static final java.lang.String TASK_ATTRIBUTE_MILESTONE
static final java.lang.String TASK_ATTRIBUTE_COMMENT
static final java.lang.String TASK_ATTRIBUTE_DEPENDENT_TASKS
static final java.lang.String TASK_ATTRIBUTE_PARENT_TASKS
static final java.lang.String TASK_ATTRIBUTE_CODE
static final java.lang.String TASK_ATTRIBUTE_MEMBER
static final java.lang.String TASK_ATTRIBUTE_MEMBER_ROLE
static final java.lang.String TASK_ATTRIBUTE_REVIEWER
static final java.lang.String TASK_ATTRIBUTE_REVIEWER_ROLE
static final java.lang.String TASK_ATTRIBUTE_STAGE_NUMBER
static final java.lang.String TASK_ATTRIBUTE_ISSTAGE
static final java.lang.String TASK_DATE_RIPPLING_ATTRIBUTE_COMPRESS_SLACK
static final java.lang.String TASK_DATE_RIPPLING_ATTRIBUTE_ACTUAL_OR_TARGET_FLAG
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_NAME
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_DESCRIPTION
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_STATE
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_TEMPLATETYPE
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_TEMPLATENAME
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_CODE
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_OWNER
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_ATTACHMENTS
static final java.lang.String MARKETING_OBJECT_ATTRIBUTE_SECURITY_POLICY
static final java.lang.String GRID_ATTRIBUTE_NAME
static final java.lang.String XREF_MO_REF_BY_MO
static final java.lang.String XREF_MO_REF_TO_MO
static final java.lang.String XREF_PROJECTS_MODIFIY_MO
static final java.lang.String XREF_PROJECTS_REF_TO_MO
static final java.lang.String XREF_APPROVALS_REF_TO_MO
static final java.lang.String XREF_MO_MOD_BY_PROJECT
static final java.lang.String XREF_MO_REF_BY_PROJECT
static final java.lang.String APPROVAL_ATTRIBUTE_OWNER
static final java.lang.String APPROVAL_ATTRIBUTE_APPROVER
static final java.lang.String APPROVAL_ATTRIBUTE_SUBJECT
static final java.lang.String APPROVAL_ATTRIBUTE_DESCRIPTION
static final java.lang.String APPROVAL_ATTRIBUTE_STATEENUM
static final java.lang.String APPROVAL_ATTRIBUTE_TARGETDUEDATE
static final java.lang.String APPROVAL_ATTRIBUTE_METHOD
The default is ApprovalMethodEnum.SIMULTANEOUS
ApprovalMethodEnum
,
Constant Field Valuesstatic final java.lang.String APPROVAL_ATTRIBUTE_SECURITY_POLICY
static final java.lang.String ATTACHMENT_ATTRIBUTE_TYPEENUM
static final java.lang.String ATTACHMENT_ATTRIBUTE_ATTACHMENT
static final java.lang.String ATTACHMENT_ATTRIBUTE_COMMENTS
static final java.lang.String ATTACHMENT_ATTRIBUTE_FOLDER_ID
static final java.lang.String USER_ATTRIBUTE_LAST_NAME
static final java.lang.String USER_ATTRIBUTE_FIRST_NAME
static final java.lang.String USER_ATTRIBUTE_ROLES
static final java.lang.String USER_ATTRIBUTE_LOGIN
static final java.lang.String USER_ATTRIBUTE_EMAIL
static final java.lang.String USER_ATTRIBUTE_LOCALE
static final java.lang.String TEAM_ATTRIBUTE_NAME
static final java.lang.String TEAM_ATTRIBUTE_DESCRIPTION
static final java.lang.String TEAM_ATTRIBUTE_SKILL_SETS
static final java.lang.String TEAM_ATTRIBUTE_TASK_MANAGER_CAN_ROUTE_WORK_TO_MEMBERS
static final java.lang.String TEAM_ATTRIBUTE_TASK_MEMBERS_CAN_ACCEPT_TEAM_ASSIGNED_TASKS
static final java.lang.String TEAM_ATTRIBUTE_TASK_MEMBERS_CAN_RETURN_TEAM_ASSIGNED_TASKS
static final java.lang.String TEAM_ATTRIBUTE_APPROVAL_MANAGER_CAN_ROUTE_APPROVALS_TO_MEMBERS
static final java.lang.String TEAM_ATTRIBUTE_APPROVAL_MEMBERS_CAN_TAKE_OWNERSHIP_OF_TEAM_ASSIGNED_APPROVALS
static final java.lang.String TEAM_ATTRIBUTE_APPROVAL_MEMBERS_CAN_RETURN_TEAM_ASSIGNED_APPROVALS
static final java.lang.String TEAM_ATTRIBUTE_PROJ_REQ_MANAGER_CAN_ROUTE_PROJ_REQ_TO_MEMBERS
static final java.lang.String TEAM_ATTRIBUTE_PROJ_REQ_MEMBERS_CAN_TAKE_OWNERSHIP_OF_TEAM_ASSIGNED_PROJ_REQ
static final java.lang.String TEAM_ATTRIBUTE_MANAGERS
static final java.lang.String TEAM_ATTRIBUTE_MEMBERS
static final java.lang.String ASSET_ATTRIBUTE_NAME
static final java.lang.String ASSET_ATTRIBUTE_DESCRIPTION
static final java.lang.String ASSET_ATTRIBUTE_OWNERS
static final java.lang.String ASSET_ATTRIBUTE_ASSET_CODE
static final java.lang.String ASSET_ATTRIBUTE_KEYWORDS
static final java.lang.String ASSET_ATTRIBUTE_EXPIRATION_DATE
IPlanAPI#findAssetByAttribute(IExecutionContext, Handle, String, Object),
all Asset objects those expiration dates earlier than the specified one will be returned.
,
Constant Field Valuesstatic final java.lang.String ASSET_ATTRIBUTE_VERSION_NAME
static final java.lang.String ASSET_ATTRIBUTE_USAGE_GUIDELINES
static final java.lang.String ASSET_ATTRIBUTE_FILE
static final java.lang.String ASSET_ATTRIBUTE_PREVIEW_FILE
static final java.lang.String ASSET_ATTRIBUTE_THUMBNAIL_FILE
static final java.lang.String ASSET_OWNER_ROLE
static final java.lang.String ASSET_LIBRARY_ATTRIBUTE_NAME
static final java.lang.String ASSET_LIBRARY_ATTRIBUTE_DESCRIPTION
static final java.lang.String ASSET_LIBRARY_ATTRIBUTE_STATEENUM
static final java.lang.String ASSET_FOLDER_ATTRIBUTE_NAME
static final java.lang.String ASSET_FOLDER_ATTRIBUTE_DESCRIPTION
static final java.lang.String PROJECT_BUDGET_TYPE
static final java.lang.String PROJECT_BUDGET_PERIOD
static final java.lang.String PROJECT_BUDGET_QUARTER
static final java.lang.String PROJECT_BUDGET_MONTH
static final java.lang.String PROJECT_BUDGET_WEEK
static final java.lang.String PROJECT_BUDGET_YEAR
static final java.lang.String PROJECT_BUDGET_TOTAL
static final java.lang.String INVOICE_NUMBER
static final java.lang.String INVOICE_VENDOR_CODE
static final java.lang.String INVOICE_OWNER
static final java.lang.String INVOICE_SECURITY_POLICY
static final java.lang.String INVOICE_PURCHASE_ORDER_NUMBER
static final java.lang.String INVOICE_DATE
static final java.lang.String INVOICE_DUE_DATE
static final java.lang.String INVOICE_NOTES
static final java.lang.String INVOICE_PAYMENT_TERMS
static final java.lang.String INVOICE_STATUS
static final java.lang.String INVOICE_LINE_ITEM_DESCRIPTION
static final java.lang.String INVOICE_LINE_ITEM_SOURCE_PLAN_OBJECT
static final java.lang.String INVOICE_LINE_ITEM_SOURCE_PLAN_OBJECT_ID
static final java.lang.String INVOICE_LINE_ITEM_SOURCE_ACCOUNT
static final java.lang.String INVOICE_LINE_ITEM_COST_CATEGORY
static final java.lang.String INVOICE_LINE_ITEM_COST_PER_UNIT
static final java.lang.String INVOICE_LINE_ITEM_QUANTITY
static final java.lang.String INVOICE_LINE_ITEM_COST
static final java.lang.String INVOICE_STATE_TRANSITION_COMMENT
static final java.lang.String INVOICE_PAID_DATE
static final java.lang.String LINE_ITEM_LINKED_APPROVAL
static final java.lang.String FINANCIAL_ACCOUNT_NAME
static final java.lang.String FINANCIAL_ACCOUNT_TEAM_MEMBERS
static final java.lang.String FINANCIAL_ACCOUNT_NUMBER
static final java.lang.String FINANCIAL_ACCOUNT_SECURITY_POLICY
static final java.lang.String FINANCIAL_ACCOUNT_DESCRIPTION
static final java.lang.String FINANCIAL_ACCOUNT_SOURCE_ACCOUNT
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_JAN
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_FEB
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_MAR
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_APR
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_MAY
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_JUN
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_JUL
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_AUG
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_SEP
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_OCT
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_NOV
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_DEC
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_ALLOTTED
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_FORECAST
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_AVAILABLE
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_COMMITTED
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_UNCOMMITTED
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_ACTUAL
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_REMAINING
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_ALL
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_Q1
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_Q2
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_Q3
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_Q4
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_TOTAL
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_YEAR
static final java.lang.String FINANCIAL_ACCOUNT_BUDGET_TYPE
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_ID
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_DESCRIPTION
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_EXPENDITURE_DATE
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_COST_CATEGORY
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_COST_CATEGORY_ID
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_COMMITTED_AMOUNT
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_FORECAST_AMOUNT
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT_ID
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_SOURCE_ACCOUNT_CODE
static final java.lang.String PROJECT_BUDGET_ACTUAL_SPENT
static final java.lang.String PROJECT_BUDGET_TOTAL_COMMITTED
static final java.lang.String PROJECT_BUDGET_TOTAL_FORCAST
static final java.lang.String PROJECT_BUDGET_ALLOCATION_PERIOD
static final java.lang.String PROJECT_BUDGET_ALLOCATION_YEAR
static final java.lang.String PROJECT_BUDGET_LINE_ITEM_ALLOCATION
Method Detail |
---|
AttributeMap getAttributes(IExecutionContext context, Handle handle) throws InvalidHandleException
context
- the client execution contexthandle
- handle of the object instance containing the desired attributes
InvalidHandleException
- the specified handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateAttribute(IExecutionContext context, Handle handle, java.lang.String attributeName, java.lang.Object[] attributeValues) throws InvalidHandleException, AttributeNotFoundException, InvalidAttributeException, NotLockedException
Convenience API--see updateAttributes() below.
context
- the client execution contexthandle
- handle of the object instance to be updatedattributeName
- the name of the attribute to updateattributeValues
- an array of zero or more attribute values;
this array will overwrite the matched attribute's existing values
InvalidHandleException
- the specified handle is invalid
AttributeNotFoundException
- one or more specified attributes do
no exist for the object instance
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)java.util.List getMembersByRoleType(IExecutionContext context, Handle handle, java.lang.String roleType) throws InvalidHandleException, InvalidAttributeException
context
- the client execution contexthandle
- handle of the object instanceroleType
- a role type for the given object instance.
InvalidHandleException
- the specified handle is invalid
InvalidAttributeException
- roleType is invalid, e.g., roleType doesn't exist, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateMembersByRoleType(IExecutionContext context, Handle handle, java.lang.String roleType, Handle[] hUser) throws InvalidHandleException, InvalidAttributeException
context
- the client execution contexthandle
- handle of the object instanceroleType
- a role type for the given object instance.hUser
- a list of PlanUser or PlanTeam handles to be updated.
InvalidHandleException
- the specified handle is invalid
InvalidAttributeException
- either roleType or hUser is invalid, e.g., roleType doesn't exist or
or hUser hanlde is not instance of PlanUser nor PlanTeam, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to read the object attributes (unchecked)void updateAttributes(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, AttributeNotFoundException, InvalidAttributeException, NotLockedException
The update logic is as follows; for each attribute contained in the supplied attributeMap:
Note, this API does not support adding new attributes.
In all cases, the attribute update is subject to the usual security constraints and validation. Its the clients responsibility to determine which standard and custom attributes are required by a particular object instance, the correct types, etc.
context
- the client execution contexthandle
- handle of the object instance to be updatedattributeMap
- map of attributes to be updated
InvalidHandleException
- the specified handle is invalid
AttributeNotFoundException
- one or more specified attributes do
no exist for the object instance
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)java.util.List getMembersByRole(IExecutionContext context, Handle handle, java.lang.String roleName) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthandle
- of an existing Plan object.
Throws InvalidHandleException if the Plan object does not exist.roleName
- a role name
Throws InvalidAttributeException if the role does not exist.
IllegalHandleException
- the specified handle does not refer to a Plan object
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
void setMembersByRole(IExecutionContext context, Handle hProject, Handle[] users, java.lang.String roleName, boolean appendOrReplace) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthandle
- of an existing Plan object.
Throws InvalidHandleException if the Plan object does not exist.users
- that will be appened to the member role or replace existing members
with the new members.
The data type is either @see PlanUserHandle or @see PlanTeamHandle.
To delete all members for a specific member role, pass in null.
Throws InvalidAttributeException if the role does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws InvalidAttributeException if the role does not exist.appendOrReplace
- true - append new members to existing members for the given role
false - replace existing members with new members.
IllegalHandleException
- the specified handle does not refer to a Plan object
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
Handle createProject(IExecutionContext context, java.lang.String templateName, AttributeMap attributeMap) throws TemplateNotFoundException, InvalidAttributeException
Child projects can be linked to the created parent project as needed; see linkProjectChildren().
context
- the clients execution context.templateName
- the name of the template to use to create this project.
The named template must exist on the Plan server and the client must have
read permissions for that instance. The template provides, among other
things, the definition of required and optional attributes, default values, etc.attributeMap
- optional map of attributes to update and/or add. Any
supplied attributes will overwrite the default values derived from the
projects template; others are left untouched. Its up to the client to
determine the attributes required by the project, their types, etc.
TemplateNotFoundException
- the specified template doesn't exist
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to create projects or read their templates (unchecked)
DataException
- problems encountered accessing data (unchecked)Handle createProjectRequest(IExecutionContext context, java.lang.String templateName, AttributeMap attributeMap) throws TemplateNotFoundException, InvalidAttributeException
context
- The clients execution context.templateName
- the name of the template to use to create this project request.attributeMap
- attribute map must contain following parameters:TemplateNotFoundException
- the specified template doesn't exist
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.java.util.List listProjects(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contextattributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current projects that the client has read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findProjectByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.Object[])
java.util.List listProjectRequests(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
context
- The clients execution contextattributeMap
- Optional map of attributes to match. This attribute map contains following parameters: InvalidAttributeException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-valued, etc.Handle findProjectByAttribute(IExecutionContext context, java.lang.String name, java.lang.Object[] values) throws InvalidAttributeException, MultipleItemsFoundException
Convenience API; similar to listProjects(), using a single attribute whose name and value are the same as the parameters above, except only one project is returned.
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one project matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)listProjects(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.AttributeMap)
Handle findProjectRequestByAttribute(IExecutionContext context, java.lang.String name, java.lang.Object[] values) throws InvalidAttributeException, MultipleItemsFoundException
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified values must match)
InvalidAttributeException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one project matched the attribute(s) specifiedAttributeMap[] getRequestRecipients(IExecutionContext context, Handle hProjectRequest) throws InvalidHandleException
context
- the clients execution contexthProjectRequest
- Must be a valid project request handle
InvalidHandleException
void addProjectRequestRecepients(IExecutionContext context, Handle hProjectRequest, AttributeMap[] attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProjectRequest
- Must be a valid project request handleattributeMap
- Attribute map must contain attributes of recipients. This must contain following parameters:InvalidHandleException
- the specified project request handle is invalid
InvalidAttributeException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-values, etc.void updateProjectRequestRecepient(IExecutionContext context, Handle hProjectRequest, Handle userHandle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProjectRequest
- Must be a valid project request handleuserHandle
- user handle (recipient) to update recipientattributeMap
- Attribute map must contain attributes of recipients to update.
This attribute must contain following parameters: InvalidHandleException
- the specified project request and/or user handle is invalid
InvalidAttributeException
- one or more specified attributes is invalid, e.g., incorrect type, not multi-values, etc.void transitionProjectStateByCode(IExecutionContext context, java.lang.String code, ProjectStateEnum stateEnum) throws ProjectNotFoundException, MultipleItemsFoundException, InvalidStateTransitionException
Convenience API; identical to making the following API calls:
context
- the clients execution contextcode
- unique project code to match against (equivalent to value
of code project attribute). A ProjectNotFoundException is thrown
if no project exists with that code. If more than one project matches, i.e.,
the attribute is not unique, a MultipleItemsFoundException is thrown.stateEnum
- a ProjectStateEnum enumerated type of the new project
state to transition to (see uapStateEnum attribute definition). An
InvalidStateTransitionException is thrown if the state transition
is not allowed.
ProjectNotFoundException
- no project was found for the specified code
MultipleItemsFoundException
- more than one project matched the code
specified
InvalidStateTransitionException
- the specified state transition is
invalid given the current project state
AttributeNotFoundException
- one or more specified attributes do
no exist for the object instance
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)findProjectByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, java.lang.String, java.lang.Object[])
void transitionProjectStateByHandle(IExecutionContext context, Handle hProject, ProjectStateEnum stateEnum, java.lang.String comments) throws InvalidAttributeException, InvalidHandleException, InvalidStateTransitionException
Finds the project assigned the supplied unique project code and transition its state to the new state.
Convenience API; identical to making the following API calls:
context
- the clients execution contextcode
- unique project code to match against (equivalent to value
of code project attribute). A ProjectNotFoundException is thrown
if no project exists with that code. If more than one project matches, i.e.,
the attribute is not unique, a MultipleItemsFoundException is thrown.stateEnum
- a ProjectStateEnum enumerated type of the new project
state to transition to (see uapStateEnum attribute definition). An
InvalidStateTransitionException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification Service
ProjectNotFoundException
- no project was found for the specified code
MultipleItemsFoundException
- more than one project matched the code
specified
InvalidStateTransitionException
- the specified state transition is
invalid given the current project state
AttributeNotFoundException
- one or more specified attributes do
no exist for the object instance
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)
InvalidHandleException
findProjectByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, java.lang.String, java.lang.Object[])
void transitionProjectRequestStateByHandle(IExecutionContext context, Handle hProjectRequest, ProjectStateEnum stateEnum, java.lang.String comments) throws InvalidAttributeException, InvalidHandleException, InvalidStateTransitionException
context
- the clients execution contexthProjectRequest
- code unique project request code to match against (equivalent to value
of code project request attribute). A ProjectNotFoundException is thrown
if no project request exists with that code. If more than one project request matches, i.e.,
the attribute is not unique, a MultipleItemsFoundException is thrown.stateEnum
- a ProjectStateEnum enumerated type of the new project request
state to transition to (see uapStateEnum attribute definition). An
InvalidStateTransitionException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification Service
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidHandleException
- no project request was found for the specified code
InvalidStateTransitionException
- the specified state transition is
invalid given the current project statevoid linkProjectChildren(IExecutionContext context, Handle hParent, Handle[] hChildren) throws InvalidHandleException, CircularityException, ListTooLargeException
Child projects may in turn have their own children--or have this done by later use of this API. The API will detect circular references, i.e., A => B => C => A, and return a CircularityException.
context
- the clients execution contexthParent
- handle of an existing parent project to link children to. Throws
InvalidHandleException if the parent project does not exist; throws
NotLockedException if the client does not hold an edit lock for the
referenced project.hChildren
- array of one or more handles of existing projects to link as
children. Throws InvalidHandleException if one or more of the child
projects does not exist; ; throws a ListTooLargeException if the server
cannot process the number of children specified in one request (because of circularity
detection). In this case, the client should break up the request into multiple calls,
e.g., less than 500.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
CircularityException
- linking one or more of the specified children
would cause a circular reference
ListTooLargeException
- the server cannot process the number of children
specified in one request
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the parent project (unchecked)
InvalidHandleException
unlinkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
void unlinkProjectChildren(IExecutionContext context, Handle hParent, Handle[] hChildren) throws InvalidHandleException
All children must in fact be linked to the specified parent, otherwise InvalidHandleException is thrown. Note that this API does not affect nested children, i.e., if A => B => C, then unlinking B from A will not affect the B => C link.
context
- the clients execution contexthParent
- handle of an existing parent project. Throws InvalidHandleException
if the parent project does not exist; throws NotLockedException if the client
does not hold an edit lock for the referenced project.hChildren
- array of handles of existing child projects to unlink from the parent.
Throws InvalidHandleException if one or more of the child projects is not
currently linked to the specified parent.
IllegalHandleException
- the specified handle(s) does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a project's list of children (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the parent project (unchecked)
InvalidHandleException
linkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
java.util.List listProjectChildren(IExecutionContext context, Handle hParent) throws InvalidHandleException
context
- the clients execution contexthParent
- handle of an existing parent project containing desired children.
Throws InvalidHandleException if the parent project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
linkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
,
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
java.util.List listAllProjectChildren(IExecutionContext context, Handle hParent) throws InvalidHandleException
context
- the clients execution contexthParent
- handle of an existing parent project containing desired children.
Throws InvalidHandleException if the parent project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
listProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
linkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
,
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
java.util.List listProjectGrids(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of an existing project containing desired grid(s).
Throws InvalidHandleException if the project does not exist or
the handle is invalid.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project grids (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
listGridRows(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
Handle findSubProjectParent(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
linkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
,
findSubProjectRoot(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
Handle findSubProjectRoot(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
linkProjectChildren(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.Handle[])
,
findSubProjectParent(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
java.util.List getMemberRoles(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of an existing project.
Return an empty list if the project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
java.util.List getReviewerRoles(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of an existing project.
Return an empty list if the project does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
java.util.List getReviewersByRole(IExecutionContext context, Handle hProject, java.lang.String roleName) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws InvalidAttributeException if the role does not exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
void setReviewersByRole(IExecutionContext context, Handle hProject, Handle[] users, java.lang.String roleName, boolean appendOrReplace) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.users
- that will be appened to the reviewer role or replace existing reviewers
with the new reviewers.
The data type is either @see PlanUserHandle or @see PlanTeamHandle.
To delete all reviewers for a specific reviewer role, pass in null.
Throws InvalidAttributeException if the role does not exist.roleName
- a role name from @see #getReviewersByRole(IExecutionContext, Handle, String);
Throws InvalidAttributeException if the role does not exist.appendOrReplace
- true - append new reviewers to existing reviewers for the given role
false - replace existing reviewers with new reviewers.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
java.util.List getMembersByParticipationLevel(IExecutionContext context, Handle hProject, ProjectParticipantLevelEnum participantLevel) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.participantLevel
- an enum indicates different participation levels.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
void setMembersByParticipationLevel(IExecutionContext context, Handle hProject, Handle[] users, ProjectParticipantLevelEnum participantLevel, boolean appendOrReplace) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthProject
- handle of an existing project.
Throws InvalidHandleException if the project does not exist.users
- that will be appened to the member role or replace existing members
with the new members.
The data type is either @see PlanUserHandle or @see PlanTeamHandle.
To delete all reviewers for a specific reviewer role, pass in null.
Throws InvalidAttributeException if the role does not exist.participantLevel
- an enum indicates different participation levels.appendOrReplace
- true - append new members to existing members for the given participation level
false - replace existing members with new members.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list project children (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
InvalidAttributeException
java.util.List listWorkflowTasks(IExecutionContext context, Handle hProject, AttributeMap taskAttributeMap) throws InvalidHandleException, InvalidAttributeException
Note, this API is intended as a simple way for a client to use server-side discovery to identify projects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contexthProject
- handle of the parent project. Throws InvalidHandleException if
the handle doesnt refer to a project or the project does not exist.taskAttributeMap
- optional map of task attributes to match. Match logic is similar to the
ListProjects() API, above. If the attributeMap parameter is not specified,
all current workflow tasks associated with the parent project are returned. Throws
InvalidAttributeException if one or more of the specified attributes is invalid.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
Handle findWorkflowTaskByAttribute(IExecutionContext context, Handle hProject, java.lang.String taskAttributeName, java.lang.Object[] taskAttributeValues) throws InvalidHandleException, InvalidAttributeException, MultipleItemsFoundException
Convenience API; similar to listWorkflowTasks() using a single attribute whose name and value are the same as the parameters above, except only one task is returned.
context
- the clients execution contexthProject
- handle of the parent project. Throws InvalidHandleException if
the handle doesnt refer to a project or the project does not exist.taskAttributeName
- name of task attribute to match against.taskAttributeValues
- array of task attribute values to match against (all must match)
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one task matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
listWorkflowTasks(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
void transitionWorkflowTaskStateByName(IExecutionContext context, java.lang.String projectCode, java.lang.String taskName, TaskStateEnum taskStateEnum) throws ProjectNotFoundException, TaskNotFoundException, MultipleItemsFoundException, InvalidStateTransitionException
Convenience API; identical to making the following API calls:
context
- the clients execution contextprojectCode
- unique project code to match against (equivalent to
value of the code project attribute). Throws MultipleItemsFoundException
if more than one project matched specified code.taskName
- the task name to match against. Throws MultipleItemsFoundException
if more than one task matched specified name.taskStateEnum
- a TaskStateEnum enumerated type defining the new
task state to transition to. Throws IllegalStateTransitionException if
the state transition is not allowed by the task.
ProjectNotFoundException
- a project was not found for the specified
project code
TaskNotFoundException
- a workflow task was not found for the specified
task name
MultipleItemsFoundException
- more than one project or task matched
InvalidStateTransitionException
- the specified state transition is
invalid given the current task state
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the workflow task (unchecked)void transitionWorkflowTaskStateByHandle(IExecutionContext context, Handle hTask, TaskStateEnum taskStateEnum, java.lang.String comments) throws InvalidAttributeException, InvalidHandleException, InvalidStateTransitionException
Finds the workflow task that has the specified project code and task name and transitions its state to the new state.
Convenience API; identical to making the following API calls:
context
- the clients execution contextprojectCode
- unique project code to match against (equivalent to
value of the code project attribute). Throw MultipleItemsFoundException
if more than one project matched specified code.taskName
- the task name to match against. Throw MultipleItemsFoundException
if more than one task matched specified name.taskStateEnum
- a TaskStateEnum enumerated type defining the new
task state to transition to. Throw IllegalStateTransitionException if
the state transition is not allowed by the task.comments
- the comments for the state transition which are sent
by Notification Service
ProjectNotFoundException
- a project was not found for the specified
project code
TaskNotFoundException
- a workflow task was not found for the specified
task name
MultipleItemsFoundException
- more than one project or task matched
InvalidStateTransitionException
- the specified state transition is
invalid given the current task state
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the workflow task (unchecked)
InvalidAttributeException
InvalidHandleException
Handle getWorkflowTaskParentProject(IExecutionContext context, Handle hTask) throws InvalidHandleException
context
- the client's execution contexthTask
- handle of the task
InvalidHandleException
- the specified task handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the workflow task (unchecked)java.util.List listPossibleMemberRolesForTask(IExecutionContext context, Handle hTask) throws InvalidHandleException
context
- the clients execution contexthTask
- handle of the task. Throws InvalidHandleException if
the handle doesnt refer to a task or the task does not exist.
InvalidHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listPossibleMembersForTask(IExecutionContext context, Handle hTask) throws InvalidHandleException
context
- the clients execution contexthTask
- handle of the task. Throws InvalidHandleException if
the handle doesnt refer to a task or the task does not exist.
InvalidHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listPossibleReviewerRolesForTask(IExecutionContext context, Handle hTask) throws InvalidHandleException
context
- the clients execution contexthTask
- handle of the task. Throws InvalidHandleException if
the handle doesnt refer to a task or the task does not exist.
InvalidHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listPossibleReviewersForTask(IExecutionContext context, Handle hTask) throws InvalidHandleException
context
- the clients execution contexthTask
- handle of the task. Throws InvalidHandleException if
the handle doesnt refer to a task or the task does not exist.
InvalidHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listWorkflowTasksForUser(IExecutionContext context, Handle hUser) throws InvalidHandleException
context
- the clients execution contexthUser
- handle of the user. Throws InvalidHandleException if
the handle doesnt refer to a user or a team.
IllegalHandleException
- the specified handle does not refer to a user or team
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
java.util.List listWorkflowTasksForProject(IExecutionContext context, Handle hProject) throws InvalidHandleException
context
- the clients execution contexthProject
- handle of the project. Throws InvalidHandleException if
the handle doesnt refer to a project or the project doesn't exist.
IllegalHandleException
- the specified handle does not refer to a project
or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list workflow tasks (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
void dateRipplingForWorkflowTasks(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, AttributeNotFoundException, InvalidAttributeException, NotLockedException
In all cases, the attribute update is subject to the usual security constraints and validation. Its the clients responsibility to determine which standard and custom attributes are required by a particular object instance, the correct types, etc.
context
- the client execution contexthandle
- handle of a Workflow TaskattributeMap
- map of attributes to be updated. Either @see IPlanAPI.DATE_RIPPLING_ATTRIBUTE_ACTUAL_DATES
InvalidHandleException
- the specified handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)
AttributeNotFoundException
InvalidAttributeException
Handle createMarketingObject(IExecutionContext context, java.lang.String templateType, java.lang.String templateName, AttributeMap attributeMap) throws TemplateTypeNotFoundException, TemplateNotFoundException, InvalidAttributeException
context
- the clients execution contexttemplateType
- the name of the template type to use to create this marketing
object.templateName
- the name of the template to use to create this marketing object.
The named template must exist on the server and the client must have read permissions
for that instance. The template provides, among other things, the definition of
required and optional attributes. Throws TemplateNotFoundException if the
named template could not be found.attributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values derived from the marketing objects template;
others are left untouched. Its up to the client to determine the attributes
required by the template, their types, etc.
TemplateTypeNotFoundException
- the specified template type doesn't exist
TemplateNotFoundException
- the specified template doesn't exist
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listMarketingObjects(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
Once retrieved, each handle can be used to interrogate the marketing object further, e.g., read or update its attributes via the attribute APIs, link to a project or other marketing object, etc.
Note, this API is intended as a simple way for a client to use server-side discovery to identify marketing objects of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contextattributeMap
- optional map of attributes to match. Match logic is similar to
the ListProjects() API, above. If the attributeMap parameter is not specified,
all current marketing objects are returned. WARNING: this list could be very large.
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list marketing objects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findMarketingObjectByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.String, java.lang.Object[])
Handle findMarketingObjectByAttribute(IExecutionContext context, java.lang.String type, java.lang.String moAttributeName, java.lang.Object[] moAttributeValues) throws InvalidAttributeException, MultipleItemsFoundException
Convenience API; similar to listMarketingObjects() using a single attribute whose name and value are the same as the parameters above, except only one marketing object is returned.
context
- the clients execution contexttype
- a string defining the type of marketing object, e.g., "creatives"moAttributeName
- name of marketing object attribute to match againstmoAttributeValues
- array of marketing object attribute values to match
against (all must match).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one marketing object
matched the attribute(s) specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list marketing object (unchecked)
DataException
- problems encountered accessing data (unchecked)listMarketingObjects(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.AttributeMap)
java.util.List listMarketingObjectGrids(IExecutionContext context, Handle hMarketingObject) throws InvalidHandleException
context
- the clients execution contexthMarketingObject
- handle of an existing marketing object containing desired grid(s).
Throws InvalidHandleException if the marketing object does not exist or
the handle is invalid.
IllegalHandleException
- the specified handle does not refer to a
marketing object or is corrupt
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list marketing object grids (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
listGridRows(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
void transitionMarketingObjectStateByHandle(IExecutionContext context, Handle hMarketingObject, java.lang.String state, java.lang.String comments) throws InvalidStateTransitionException, InvalidAttributeException, InvalidHandleException
context
- the clients execution contexthMarketingObject
- a valid Marketing Object handlestate
- the new marketing object state to transition to. An
InvalidStateTransitionException is thrown if the state transition
is not allowed or the state is not a valid statecomments
- the comments for the state transition which are sent
by Notification Service
InvalidStateTransitionException
- the specified state transition is
invalid given the current marketing object state
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidHandleException
- the specified handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)Handle appendGridRow(IExecutionContext context, Handle hGrid, AttributeMap rowAttributeMap) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthGrid
- handle to an existing grid object to be updatedrowAttributeMap
- map of attributes (columns) to update and/or add to the new
grid row. These attributes will overwrite any default values derived from the
grid's template. Note, there are no standard grid row attributes--it's the
clients responsibility to determine which attributes are required, proper
date types, etc.
InvalidHandleException
- the specified grid handle is invalid
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the parent grid object (unchecked)void deleteGridRow(IExecutionContext context, Handle hGridRow) throws InvalidHandleException
context
- the clients execution contexthGridRow
- handle to an existing grid row to be updated
InvalidHandleException
- the specified grid row handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the parent grid object (unchecked)java.util.List listGridRows(IExecutionContext context, Handle hGrid, AttributeMap rowAttributeMap) throws InvalidHandleException, InvalidAttributeException
Note, this API is intended as a simple way for a client to use server-side discovery to identify grid data of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contexthGrid
- handle of the parent grid object. Throws InvalidHandleException
if the handle doesnt refer to a grid object or the grid doesnt exist.rowAttributeMap
- optional map of grid row attributes to match. If this parameter
is not specified, all rows currently bound to the parent grid object are returned.
IllegalHandleException
- the specified handle does not refer to a
grid, the grid does not exist, or the handle is corrupt
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list grid rows (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
java.util.Map getXrefByMarketingObject(IExecutionContext context, Handle hMarketingObject) throws InvalidHandleException
The available cross reference types are returned as a map object. Each
cross reference type maps to a list of object handles. The list can be
null if there are no corresponding objects.
In order to retrieve the object handles, this is an example code,
Map map = getXrefByMarketingObject(context, hMarketingObject); List moList = map.get(IPlanAPI.XREF_MO_REF_BY_MO); if (moList != null) // the list can be null { Iterator iterator = moList.iterator(); while (iterator.hasNext()) { Handle moHandle = (Handle) iterator.next(); ... } }
context
- the clients execution contexthMarketingObject
- handle of an existing marketing object containing desired
cross references. Throws InvalidHandleException if the marketing object does not exist or
the handle is invalid.
InvalidHandleException
- the specified Marketing Object handle is invalidjava.util.Map getXrefByProject(IExecutionContext context, Handle hProject) throws InvalidHandleException
The available cross reference types are returned as a map object. Each
cross reference type maps to a list of object handles. The list can be
null if there are no corresponding objects.
In order to retrieve the object handles, this is an example code,
Map map = getXrefByProject(context, hProject); List moList = map.get(IPlanAPI.XREF_MO_MOD_BY_PROJECT); if (moList != null) // the list can be null { Iterator iterator = moList.iterator(); while (iterator.hasNext()) { Handle moHandle = (Handle) iterator.next(); ... } }
context
- the clients execution contexthProject
- handle of an existing project containing desired cross references.
Throws InvalidHandleException if the project does not exist or
the handle is invalid.
InvalidHandleException
- the specified Project handle is invalidjava.util.List listApprovals(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
Note, this API is intended as a simple way for a client to use server-side discovery to identify approvals of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contextattributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current approvals that the client has read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list approvals (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findApprovalByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.Object[])
Handle findApprovalByAttribute(IExecutionContext context, java.lang.String ApprovalAttributeName, java.lang.Object[] ApprovalAttributeValues) throws InvalidAttributeException, MultipleItemsFoundException
Convenience API; similar to listApprovals() using a single attribute whose name and value are the same as the parameters above, except only one marketing object is returned.
context
- the clients execution contextApprovalAttributeName
- name of approval attribute to match againstApprovalAttributeValues
- array of approval attribute values to match
against (all must match).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one approvals
matched the attribute(s) specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked exception)
AuthorizationException
- the user bound to the client execution
context is not authorized to list approvals (unchecked exception)
DataException
- problems encountered accessing data (unchecked exception)listApprovals(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.AttributeMap)
Handle createApproval(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
This method does not add the approval items. To add approval items,
please use updateApprovalItems(IExecutionContext, Handle, Object[], String[])
context
- the clients execution context.attributeMap
- optional map of attributes to update and/or add. Any
supplied attributes will overwrite the default values derived from the
approvals template; others are left untouched. Its up to the client to
determine the attributes required by the approval, their types, etc.
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to create approvals or read their templates (unchecked)
DataException
- problems encountered accessing data (unchecked)updateApprovalItems(IExecutionContext, Handle, Object[], String[])
void transitionApprovalStateByHandle(IExecutionContext context, Handle hApproval, ApprovalStateEnum stateEnum, java.lang.String comments) throws InvalidHandleException, InvalidAttributeException, InvalidStateTransitionException
context
- the clients execution contexthandle
- the handle of existing approval that is desired to change statestateEnum
- a ApprovalStateEnum enumerated type of the new approval
state to transition to (see uapStateEnum attribute definition). An
InvalidStateTransitionException is thrown if the state transition
is not allowed.comments
- the comments for the state transition which are sent
by Notification Service
InvalidHandleException
- the specified handle does not refer to a approval
or is corrupt
InvalidStateTransitionException
- the specified state transition is
invalid given the current approval state
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)findApprovalByAttribute(com.unica.publicapi.plan.api.IExecutionContext, java.lang.String, java.lang.Object[])
,
updateAttribute(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, java.lang.String, java.lang.Object[])
void updateApprovalItems(IExecutionContext context, Handle hApproval, java.lang.Object[] approvalItems, java.lang.String[] instructions) throws ApprovalNotFoundException, InvalidHandleException, InvalidItemException, java.io.IOException
The item instructions are passed as instructions parameter. The order of the instructions String array is consisting with the order of approvalItems Object array.
Update the exiting items
Since each approval item within an Approval object has item sequence, if one want to update particular approval items, one need to put the right item in the right place of the item array. For example, there is an Approval containing 3 items and the items are order as "MO1", "MO2", "File1". If one only wants to update item "File1", one needs to constructed an array as
The same manner applies when updating item instructions. if one want to update particular item instructions, one need to put right instructions in the right place of the instruction array. If there is no need to update items, one needs to provide an empty Object array with number of the items in size. For example, there is an Approval containing 3 items, one want to update the comments of the last 2 items, on needs to constructed the array asObject [] items = Object [] {null, null, new File("myFile.txt")}; String [] instructions = new String [3]; try { IPlanAPI.updateApprovalItems(context, hApproval, approvalItems, instructions); }catch(Exception e) { ... }
Object [] approvalItems = new Object [3]; String [] instructions = new String [] {null, "comment2", "comment3"}; ...
Append additional items
If one want to append new items in addition to the existing approval items, one need to provide the padding object in the item array. For example,
By doing that, moHandle1 and file1 items are appended to the end of the exiting items.File file1 = new File(myFile.txt); Object [] approvalItems = new Object [] {null, null, null, moHandle1, file1}; ...
Update existing and append additional items
If one want to update the exiting as well as append new items, one need to put updating items in the right order and put the new items at the end. Padding object is used if necessary. For example, there is 3 items Approval object. One want to update the first items and append two new items, one need to construct the array as
File file1 = new File(myFile.txt); File newFile = new File("newFile.txt"); Object [] approvalItems = new Object [] {newFile, null, null, moHandle, file1}; String [] instructions = new String [] {"updated file", null, null, "new MO", "new file"};
context
- context the clients execution contexthApproval
- handle the handle of existing approval that is desired to
update its approval itemsapprovalItems
- any combination of Marketing Object handle, java.io.File object.instructions
- the items instructions that corresponding to approval items.
ApprovalNotFoundException
- the desired approval object is not found
InvalidItemException
- - invalid item or invalid item type
InvalidHandleException
- the specified Approval handle is invalid
java.io.IOException
- - Approval items have file I/O execptions
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)getApprovalItems(IExecutionContext, Handle)
,
#deleteApprovalItem(IExecutionContext, Handle, Object)
void deleteApprovalItemByName(IExecutionContext context, Handle hApproval, java.lang.String itemName) throws ApprovalNotFoundException, InvalidHandleException, ItemNotFoundException
context
- context the clients execution contexthApproval
- the handle of existing approval that is desired to
delete its approval itemsitemName
- - that name of an approval item that is desired to be deleted.
If the item is Marketing object, it is the name of the Marketing Object.
If the item is a file, it is the name of the file include the file extension name.
ApprovalNotFoundException
- - the desired approval object is not found
ItemNotFoundException
- - the desired item is not found
InvalidHandleException
- the specified Approval handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)getApprovalItems(IExecutionContext, Handle)
,
updateApprovalItems(IExecutionContext, Handle, Object[], String[])
java.lang.Object[] getApprovalItems(IExecutionContext context, Handle hApproval) throws ApprovalNotFoundException, InvalidHandleException
If the return is null, it means the Approval object doesn't have any items.Object [] items = getApprovalItems(context, approval); for(int i = 0; i < items; i ++) { if(items[i] instanceof MarketingObjectHandle) { //do something... }else if(items[i] instanceof java.io.File) { //do something... } }
context
- context the clients execution contexthApproval
- handle the handle of existing approval that is desired to
delete its approval items
ApprovalNotFoundException
- the desired approval object is not found
InvalidHandleException
- the specified Approval handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
DataException
- problems encountered accessing data (unchecked)updateApprovalItems(IExecutionContext, Handle, Object[], String[])
,
#deleteApprovalItem(IExecutionContext, Handle, Object)
Handle appendAttachment(IExecutionContext context, Handle hParent, AttributeMap attachmentAttributes) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthParent
- handle to an existing project or marketing object to be updatedattachmentAttributes
- map of attributes to update and/or add to the new
attachment.
InvalidHandleException
- the specified handle is invalid
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the parent object (unchecked)java.util.List listUsers(IExecutionContext context, AttributeMap attributes) throws InvalidAttributeException
context
- the clients execution contextattributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current users that have read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
#findUserByAttribute(IExecutionContext, String, Object)
Handle findUserByAttribute(IExecutionContext context, java.lang.String attributeName, java.lang.Object[] attributeValues) throws InvalidAttributeException, MultipleItemsFoundException
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one user matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list users (unchecked)
DataException
- problems encountered accessing data (unchecked)listUsers(IExecutionContext, AttributeMap)
java.util.List listTeams(IExecutionContext context, AttributeMap attributes) throws InvalidAttributeException
context
- the clients execution contextattributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current teams that have read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the team bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findTeamByAttribute(IExecutionContext, String, Object)
Handle findTeamByAttribute(IExecutionContext context, java.lang.String attributeName, java.lang.Object attributeValue) throws InvalidAttributeException, MultipleItemsFoundException
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
MultipleItemsFoundException
- more than one team matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the team bound to the client execution
context is not authorized to list teams (unchecked)
DataException
- problems encountered accessing data (unchecked)listTeams(IExecutionContext, AttributeMap)
Handle getParentHandle(IExecutionContext context, Handle childHandle) throws InvalidHandleException
context
- the client's execution contextchildHandle
- handle of the child
InvalidHandleException
- the specified child handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update a workflow task (unchecked)
DataException
- problems encountered accessing data (unchecked)Handle createAsset(IExecutionContext context, Handle hAssetLibrary, AttributeMap attributes) throws InvalidAttributeException, InvalidHandleException
context
- the clients execution contexthAssetLibrary
- a handle of an asset library or an asset folder. A new Asset will be created within the asset libraryattributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values;
others are left untouched. Its up to the client to determine the attributes
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidHandleException
- the specified asset library handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)
DataException
- problems encountered accessing data (unchecked)java.util.List listAssets(IExecutionContext context, Handle hAssetLibrary, AttributeMap attributes) throws InvalidHandleException, InvalidAttributeException
context
- the clients execution contexthAssetLibrary
- a handle of an asset library or an asset folder. All returning assets will be within the asset library.attributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current assets that are in the given asset library and the client has read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidHandleException
- the specified asset library handle is invalid
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findAssetByAttribute(IExecutionContext, Handle, String, Object)
java.util.List listAssetFolders(IExecutionContext context, Handle hAssetLibrary, AttributeMap attributes) throws InvalidHandleException, InvalidAttributeException
InvalidHandleException
InvalidAttributeException
Handle findAssetByAttribute(IExecutionContext context, Handle hAssetLibrary, java.lang.String attributeName, java.lang.Object attributeValue) throws InvalidHandleException, InvalidAttributeException, MultipleItemsFoundException
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)
InvalidHandleException
- the specified asset library handle is invalid
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one asset matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list assets (unchecked)
DataException
- problems encountered accessing data (unchecked)listAssets(IExecutionContext, Handle, AttributeMap)
void deleteAsset(IExecutionContext context, Handle hAsset) throws InvalidHandleException
context
- the clients execution contexthAsset
- handle to an existing asset to be updated
InvalidHandleException
- the specified asset handle is invalid
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update one or more object attributes (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
the asset object (unchecked)void transitionAssetStateByCode(IExecutionContext context, java.lang.String code, AssetStateEnum stateEnum, java.lang.String comments) throws AssetNotFoundException, MultipleItemsFoundException, InvalidStateTransitionException
context
- the clients execution contextcode
- unique asset code to match against (equivalent to value
of code asset attribute). A AssetNotFoundException is thrown
if no asset exists with that code. If more than one asset matches, i.e.,
the attribute is not unique, a MultipleItemsFoundException is thrown.stateEnum
- a AssetStateEnum enumerated type of the new asset
state to transition to (see uapStateEnum attribute definition). An
InvalidStateTransitionException is thrown if the state transition
is not allowed.comments
- comments for this transition
AssetNotFoundException
- no asset was found for the specified code
MultipleItemsFoundException
- more than one asset matched the code
specified
InvalidStateTransitionException
- the specified state transition is
invalid given the current asset state
AttributeNotFoundException
- one or more specified attributes do
no exist for the object instance
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-values, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to update the object attribute (unchecked)
DataException
- problems encountered accessing data (unchecked)
NotLockedException
- client did not acquire proper write locks for
object (unchecked)findAssetByAttribute(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, java.lang.String, java.lang.Object)
,
updateAttribute(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, java.lang.String, java.lang.Object[])
java.util.List listAssetLibraries(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException
Note, this API is intended as a simple way for a client to use server-side discovery to identify asset library of interest; more complicated discovery can be done by combining this API with client-side attribute processing.
context
- the clients execution contextattributeMap
- optional map of attributes to match. The implied boolean
operator is AND. The match algorithm works as follows:
If the attributeMap parameter is not specified, all current asset libraries that have read security permissions for are returned. Throws InvalidAttributeException if one or more of the query attributes is invalid (e.g., empty map, an attribute has the wrong type, etc.).
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list projects (unchecked)
DataException
- problems encountered accessing data (unchecked)getAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle)
,
updateAttributes(com.unica.publicapi.plan.api.IExecutionContext, com.unica.publicapi.plan.api.Handle, com.unica.publicapi.plan.api.AttributeMap)
,
findAssetLibraryByAttribute(IExecutionContext, String, Object)
Handle findAssetLibraryByAttribute(IExecutionContext context, java.lang.String attributeName, java.lang.Object attributeValue) throws InvalidAttributeException, MultipleItemsFoundException
Convenience API; similar to listAssetLibraries(), using a single attribute whose name and value are the same as the parameters above, except only one asset is returned.
context
- the clients execution contextname
- name of attribute to match againstvalues
- array of attribute values to match against (all specified
values must match)
InvalidAttributeException
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
MultipleItemsFoundException
- more than one asset libraries matched the attribute(s)
specified
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to list asset libraries (unchecked)
DataException
- problems encountered accessing data (unchecked)listAssetLibraries(IExecutionContext, AttributeMap)
Handle createAssetFolder(IExecutionContext context, Handle parentHandle, AttributeMap attributeMap) throws InvalidAttributeException, InvalidHandleException
context
- the clients execution contextparentHandle
- the folder's parent handle. It could be an @link AssetLibraryHandle or @link AssetFolderHandleattributeMap
- map of attributes to update and/or add. Any supplied attributes
will overwrite the default values; others are left untouched.
Its up to the client to determine the attributes.
InvalidAttributeException
- one or more specified attributes
is invalid, e.g., incorrect type, not multi-valued, etc.
InvalidExecutionContextException
- the specified execution context
is invalid (unchecked)
AuthorizationException
- the user bound to the client execution
context is not authorized to create marketing objects or read their
templates (unchecked)
DataException
- problems encountered accessing data (unchecked)
InvalidHandleException
AttributeMap getProjectBudget(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid project handleattributeMap:
- Parameter to determine type of budget
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_TYPE. Value for this key should be one of the following:
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_PERIOD Parameter to determine period of budget total. Value for this key should be one of the following:
For budget period BudgetPeriodEnum.QUARTERLY, user may provide optional quarter value with IPlanAPI.PROJECT_BUDGET_QUARTER key in attributeMap and QuarterEnum instance for required quarter as the value. e.g. QuarterEnum.Q1, QuarterEnum.Q2, etc. If IPlanAPI.PROJECT_BUDGET_QUARTER is not specified then returned attribute map will contain all four quarter's information as specified in Returns section.
For budget period BudgetPeriodEnum.MONTHLY, user may provide optional month value with IPlanAPI.PROJECT_BUDGET_MONTH key in attributeMap and MonthEnum instance for required month as the value. e.g. MonthEnum.JANUARY, MonthEnum.FEBRUARY, etc. If IPlanAPI.PROJECT_BUDGET_MONTH is not specified then returned attribute map will contain all twelve month's information as specified in Returns section.
For budget period BudgetPeriodEnum.WEEKLY, user may provide optional week value with IPlanAPI.PROJECT_BUDGET_WEEK key in attributeMap and WeekEnum instance for required week as the value. e.g. WeekEnum.WEEK_1, WeekEnum.WEEK_2, etc. If IPlanAPI.PROJECT_BUDGET_WEEK is not specified then returned attribute map will contain all 53 week's information as specified in Returns section.
For budget period BudgetPeriodEnum.QUARTERLY, BudgetPeriodEnum.MONTHLY or BudgetPeriodEnum.WEEKLY, if no appropriate period value is specified then returned attribute map will contain all entries as applicable for specified budget period with key as follows
InvalidHandleException:
- if handle provided is not a valid project handle
InvalidAttributeException:
- If parameters in attributeMap are invalid or budget period specified do not matches project budget granularity
InvalidHandleException
InvalidAttributeException
Handle createInvoice(IExecutionContext context, AttributeMap attributeMap) throws InvalidAttributeException, AuthorizationException
context
- API execution contextattributeMap
- attribute map must contain following parameters
attributeMap can contain following optional parameters
InvalidAttributeException
- If parameters specified in attributeMap are not valid
AuthorizationException
- the user bound to the client execution context is not authorized to create invoiceHandle findInvoiceByNumberAndVendor(IExecutionContext context, java.lang.String invoiceNumber, java.lang.String vendorCode) throws InvalidAttributeException
context
- API execution contextinvoiceNumber
- Invoice number to findvendorCode
- vendor Code to find
InvalidAttributeException
- if invalid invoice number or vendor code is specifiedjava.util.List listInvoices(IExecutionContext context)
context
- API execution context
Handle addInvoiceLineItem(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid invoice handleAttributeMap,
- attribute map must contain following parameters
Integer
array formatInvalidHandleException:
- if handle provided is not a valid invoice handle
InvalidAttributeException:
- If parameters specified are not valid
InvalidHandleException
InvalidAttributeException
void deleteInvoiceLineItem(IExecutionContext context, Handle hInvoiceLineItem) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthInvoiceLineItem
- Must be a valid invoice line item handle
InvalidHandleException
- If handle provided is not a valid invoice line item handle or parent invoice is not in draft state
InvalidAttributeException
- If line item is linked to any rule driven approval in In Progress statejava.util.List listInvoiceLineItems(IExecutionContext context, Handle handle) throws InvalidHandleException
context:
- API execution contexthandle:
- Must be a valid invoice handle
InvalidHandleException,
- if handle is invalid
InvalidHandleException
void transitionInvoiceState(IExecutionContext context, Handle handle, InvoiceStateEnum stateEnum, AttributeMap attributeMap) throws InvalidHandleException, InvalidStateTransitionException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid invoice handlestateEnum:
- InvoiceStateEnum enumerated type of the new invoice state to
transition to. An InvalidStateTransitionException is thrown if
the state transition is not allowed.attributeMap:
- must contain following key with string array as value
IPlanAPI.INVOICE_STATE_TRANSITION_COMMENT
If state is changed to PAID then attributeMap must contain following key with Calendar array
IPLANAPI.INVOICE_PAID_DATE
InvalidHandleException
- if handle is not a valid invoice handle
InvalidStateTransitionException
- the specified state transition is invalid given the
current project state
InvalidAttributeException
Handle createFinancialAccount(IExecutionContext context, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contextattributeMap
- attributeMap must contain following key value pair
InvalidHandleException,
- if sourceAccount handle is specified and not a valid
financial account
InvalidAttributeException
- if attributes specified in attributeMap is/are invalid
InvalidHandleException
void enableFinancialAccount(IExecutionContext context, Handle handle) throws InvalidHandleException, InvalidStateTransitionException
context
- API execution contexthandle
- Must be a valid account handle.
InvalidHandleException
- if handle is not a valid account handle
InvalidStateTransitionException
- the enabling account is not validvoid disableFinancialAccount(IExecutionContext context, Handle handle) throws InvalidHandleException, InvalidStateTransitionException
context
- API execution contexthandle
- Must be a valid account handle.
InvalidHandleException
- if handle is not a valid account handle
InvalidStateTransitionException
- the disabling account is not validjava.util.List listFinancialAccounts(IExecutionContext context, boolean includeDisabled)
context
- API execution contextincludeDisabled
- set this flag to get disabled accounts in list
Handle findFinancialAccountByNumber(IExecutionContext context, java.lang.String accountNumber) throws InvalidAttributeException
context
- API execution contextaccountNumber
- account number
InvalidAttributeException
- if invalid account number is specifiedvoid updateFinancialAccountBudget(IExecutionContext context, Handle sourceAccount, int fiscalYear, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contextsourceAccount:
- Must be a valid account handle.fiscalYear:
- Financial year (in yyyy format) for which budget needs to be
updatedattributeMap:
- AttributeMap must contain at least one key from the following
list and value must be valid double value
InvalidHandleException
- if handle is not a valid account handle
InvalidAttributeException
- the specified attributes are not validAttributeMap getFinancialAccountBudget(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- handle of financial accountattributeMap:
- attribute Map must contain following key values
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALLOTTED was selected while calling this API then returned attributeMap will contain IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALLOTTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ FORECAST was selected while calling this API then returned attributeMap will contain IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ FORECAST as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ AVAILABLE was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ AVAILABLE as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_COMMITTED was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_COMMITTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ UNCOMMITTED was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ UNCOMMITTED as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ACTUAL was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ACTUAL as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ REMAINING was selected while calling this API then returned attributeMap will contain IPLANAPI.FINANCIAL_ACCOUNT_BUDGET_ REMAINING as key and attributemap as value. AttributeMap returned in value will have following keys with values in double format representing allotted budget
If IPLANAPI. FINANCIAL_ACCOUNT_BUDGET_ALL was selected while calling this API then returned attributeMap will contain all the keys defined above with attributemap as value.
InvalidHandleException
- if handle is not a valid account handle
InvalidAttributeException
- the specified attributes are not validHandle copyProject(IExecutionContext context, Handle hProject, ProjectCopyTypeEnum copyEnum, boolean copyParentLink) throws InvalidHandleException, TemplateNotFoundException
context
- API execution contexthProject
- Must be a valid project handlecopyEnum
- Type of metrics to copy project
copyParentLink
- if true and if source project has parent then link to parent will be copied
Handle
of the copied new project object
InvalidHandleException
- if handle provided is not a valid project handle
TemplateNotFoundException
- if template of source project not foundvoid copyProjectResources(IExecutionContext context, Handle hProjectSource, Handle hProjectDestination) throws InvalidHandleException, InvalidAttributeException
InvalidAttributeException
and no resources will be copied to the destination project.
context
- API execution contexthProjectSource
- Must be a valid project handle and source projecthProjectDestination
- Must be a valid project handle and destination project
InvalidHandleException
- if handle provided is not a valid project handle OR template
of source and destination project are different OR source and
destination project handle points to same project
InvalidAttributeException
- If source project contains disabled teamHandle addProjectBudgetLineItem(IExecutionContext context, Handle hProject, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid project handleattributeMap
- Attribute map must contain following parameters:InvalidHandleException
- if handle provided is not a valid project handle
InvalidAttributeException
- If parameters specified in attributeMap are not validvoid deleteProjectLineItem(IExecutionContext context, Handle hProjectLineItem) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthProjectLineItem
- Must be a valid project line item handle
InvalidHandleException
- If handle provided is not a valid project line item handle or project is not in active state
InvalidAttributeException
java.util.List listProjectLineItems(IExecutionContext context, Handle hProject, boolean getLastVersion) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid project handlegetLastVersion
- if specified as true then return values will be last version otherwise values
returned will be current values. If specified as true and last version is not available
then API will return current values.
InvalidHandleException
- If handle provided is not a valid project handle
InvalidAttributeException
- If parameters getLastVersion is specified as true and last version is not availablejava.util.List getProjectLineItems(IExecutionContext context, Handle hProject, boolean getLastVersion) throws InvalidHandleException, InvalidAttributeException
ProjectLineItemHandle
and to get attributes of individual line item, use IPlanAPI.getAttributes() providing ProjectLineItemHandle
context
- API execution contexthandle
- Must be a valid project handlegetLastVersion
- if specified as true then return values will be last version otherwise values
returned will be current values. If specified as true and last version is not available
then API will return current values.
InvalidHandleException
- If handle provided is not a valid project handle
InvalidAttributeException
- If parameters getLastVersion is specified as true and last version is not availableAttributeMap getProjectBudgetLineItemSummary(IExecutionContext context, Handle hProject, boolean getLastVersion) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid project handlegetLastVersion
- if specified as true then return values will be last version otherwise
values returned will be current values. If specified as true and last version is
not available then API will return current values.
InvalidHandleException
- if handle provided is not a valid project handle
InvalidAttributeException
- If parameters getLastVersion is specified as true and last version is not availableAttributeMap getSubProjectBudgetSummary(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid parent project handleattributeMap:
- Parameter to determine type of budget
attributeMap must contain key IPlanAPI.PROJECT_BUDGET_TYPE.
Value for this key should be one of the following:InvalidHandleException:
- if handle provided is not a valid project handle
InvalidAttributeException:
- If parameters in attributeMap are invalid
InvalidHandleException
InvalidAttributeException
void finalizeProjectBudgetChanges(IExecutionContext context, Handle handle, AttributeMap attrMap) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid project handleattrMap:
- Should have target due date (IPLANAPI.APPROVAL_ATTRIBUTE_TARGETDUEDATE)
and optional description (IPLANAPI.APPROVAL_ATTRIBUTE_DESCRIPTION) attributes if approval is required for finalization
InvalidHandleException
- if handle provided is not a valid project handle or project is not in active state
InvalidAttributeException
- If no changes available in project budget to finalizevoid discardProjectBudgetChanges(IExecutionContext context, Handle handle) throws InvalidHandleException, InvalidAttributeException
context:
- API execution contexthandle:
- Must be a valid project handle
InvalidHandleException
- if handle provided is not a valid project handle or project is not in active state
InvalidAttributeException
- If no changes available in project budget to discardAttributeMap getProjectBudgetLineItemAllocation(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid project handleattributeMap
- Parameters to determine period of allocation attributeMap must contain key IPlanAPI.PROJECT_BUDGET_ALLOCATION_PERIOD. InvalidHandleException
- If handle provided is not a valid project handle
InvalidAttributeException
- If parameters in attributeMap are invalid or budget period does not matches budget granularity of projectAttributeMap getSubProjectAllocation(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid parent project handleattributeMap
- Parameters to determine period of allocation attributeMap must contain key IPlanAPI.PROJECT_BUDGET_ALLOCATION_PERIOD. InvalidHandleException
- If handle provided is not a valid project handle
InvalidAttributeException
- If parameters in attributeMap are invalid or budget period does not matches budget granularity of projectvoid updateProjectLineItemAllocation(IExecutionContext context, Handle handle, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid project handle for which allocation needs to updateattributeMap
- To update project total allocation provide following keys with allocation as value in double format:InvalidHandleException
- if handle provided is not a valid project handle
InvalidAttributeException
- If parameters in attributeMap are invalidvoid updateSubProjectAllocation(IExecutionContext context, Handle handle, Handle hSubProject, AttributeMap attributeMap) throws InvalidHandleException, InvalidAttributeException
context
- API execution contexthandle
- Must be a valid parent project handle for which allocation needs to updatehSubProject
- Must be a valid sub project handle for which allocation needs to updateattributeMap
- To update project total allocation provide following keys with allocation as value in double format:InvalidHandleException
- if handle provided is not a valid project handle
InvalidAttributeException
- If parameters in attributeMap are invalid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |