public interface BusinessDeadlineService
BusinessDeadlineService
methods.
This service provides interfaces to allow a business deadline to be calculated based on pre-defined Calendar information.
The following functionality is provided:
Modifier and Type | Method and Description |
---|---|
java.util.Calendar |
calcBusinessDeadline(java.lang.String guid,
java.util.Calendar startDateTime,
org.apache.xmlbeans.GDuration duration)
Return a calculated Business Deadline based on working time.
|
java.util.Calendar |
calcDeadline(com.tibco.n2.dac.api.basic.XmlCalendarLookup[] aLookups,
java.util.Calendar aStartDateTime,
org.apache.xmlbeans.GDuration aDuration)
Calculates the earliest date and time a deadline can be completed, given
a start date/time and duration.
|
java.util.Calendar calcBusinessDeadline(java.lang.String guid, java.util.Calendar startDateTime, org.apache.xmlbeans.GDuration duration) throws com.tibco.n2.dac.services.DeadlineFault, com.tibco.n2.dac.services.SecurityFault
A corresponding calendar should have been created previously with entries for working time.
guid
- The GUID of the Calendar that contains the working time entries to be used when
calculating this deadline.startDateTime
- The starting point for the deadline calculation.duration
- The amount of time required to complete the task.Calendar
containing the calculated end time for the task based
on the start, duration and available working time as defined in the corresponding
calendar.com.tibco.n2.dac.services.DeadlineFault
- In the event that the deadline cannot be calculated.com.tibco.n2.dac.services.SecurityFault
- In the event that incorrect security information is presented.java.util.Calendar calcDeadline(com.tibco.n2.dac.api.basic.XmlCalendarLookup[] aLookups, java.util.Calendar aStartDateTime, org.apache.xmlbeans.GDuration aDuration) throws com.tibco.n2.dac.services.DeadlineFault, com.tibco.n2.dac.services.SecurityFault
The calculation request also includes an optional, ordered collection of identifiers from which a Calendar can be resolved. Those identifiers will consist of Calendar references and Organizational Entities, as set out in the following list, and will be applied in the given order until a Calendar can be resolved.
The Organizational Entity identifiers are used to determine what Base and Overlay Calendars are to be used for the calculation. If no Calendar can be resolved from the given identifiers, the Default Base Calendar will apply.
Having resolved the Calendar(s), the available working hours are determined. Based on those available hours, the calculation returns earliest date and time at which the given duration of work can be completed.
aLookups
- The identifiers for the Calendars to be used when
calculating the deadline.aStartDateTime
- The starting point for the deadline calculation.aDuration
- The amount of time required to complete the task.Calendar
containing the calculated end
time for the task based on the start, duration and available
working time as defined in the corresponding calendar.com.tibco.n2.dac.services.DeadlineFault
- In the event that the deadline cannot be
calculated.com.tibco.n2.dac.services.SecurityFault
- In the event that incorrect security information is
presented.Copyright © 2017 Cloud Software Group, Inc. All Rights Reserved.