com.tibco.n2.service.adapter.binding

Interface CalendarService

All Known Implementing Classes:

CalendarService

Deprecated.

since AMX-BPM 2.0.0 use WorkCalService.

public interface CalendarService

Interface to provide the CalendarService methods.

This service provides interfaces to allow a calendar to be configured with respect to working time.

A normal sequence of events would be:

• Call getCalendarEntries to get the working time for a given entity.
• Call updateWorkingDays to modify the working days and times for a given entity.
• Call addWorkingDayExceptions to add working day exceptions for a given entity.
• Call updateWorkingDayExceptions to modify working day exceptions for a given entity.
• Call deleteWorkingDayExceptions to delete working day exceptions for a given entity.

The following functionality is provided:

• Obtain the working time.
• Modify working days.
• Add working day exceptions.
• Modify working day exceptions.
• Delete working day exceptions.

COPYRIGHT: (C) 2007-2012 Cloud Software Group, Inc. All Rights Reserved.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	addWorkingDayExceptions(java.lang.String guid, com.tibco.n2.dac.api.XmlNewWorkingDayExceptionType[] addExceptions) Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendar(com.tibco.n2.dac.api.basic.XmlBaseCalendar).
java.lang.String	deleteWorkingDayExceptions(java.lang.String guid, java.lang.String[] deleteExceptions) Deprecated. since AMX-BPM 2.0.0 use WorkCalService.deleteCalendarEntries(int, String, String, String[]).
com.tibco.n2.dac.api.XmlCalendarEntriesType	getCalendarEntries(java.lang.String guid, java.util.Calendar startDateTime, java.util.Calendar endDateTime, com.tibco.n2.dac.api.XmlRequiredDetailType.Enum[] requiredDetail) Deprecated. since AMX-BPM 2.0.0 use WorkCalService.getCalEntries(String, String, Calendar, Calendar).
java.lang.String	updateWorkingDayExceptions(java.lang.String guid, com.tibco.n2.dac.api.XmlExistingWorkingDayExceptionType[] updateExceptions) Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendarEntry(int, String, String, Calendar, Calendar, com.tibco.n2.dac.api.basic.XmlNewWorkingDayExclusion[], com.tibco.n2.dac.api.basic.XmlExistingWorkingDayExclusion[], com.tibco.n2.dac.api.basic.XmlNewRecurringExclusion[], com.tibco.n2.dac.api.basic.XmlExistingRecurringExclusion[]).
java.lang.String	updateWorkingDays(java.lang.String guid, com.tibco.n2.dac.api.XmlDayType[] workingDay) Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendar(com.tibco.n2.dac.api.basic.XmlBaseCalendar).

Method Detail

getCalendarEntries

com.tibco.n2.dac.api.XmlCalendarEntriesType getCalendarEntries(java.lang.String guid,
                                                             java.util.Calendar startDateTime,
                                                             java.util.Calendar endDateTime,
                                                             com.tibco.n2.dac.api.XmlRequiredDetailType.Enum[] requiredDetail)
                                                               throws com.tibco.n2.dac.services.CalendarFault,
                                                                      com.tibco.n2.dac.services.SecurityFault

Deprecated. since AMX-BPM 2.0.0 use WorkCalService.getCalEntries(String, String, Calendar, Calendar).

Return the working time for a given entity.

This method should be called before calling updateWorkingDayExceptions(java.lang.String, com.tibco.n2.dac.api.XmlExistingWorkingDayExceptionType[]) or deleteWorkingDayExceptions(java.lang.String, java.lang.String[]) in order to obtain the GUID of working day exception that is to be modified.

Parameters:

guid - The GUID of the Calendar that contains the working time entries to be returned.

startDateTime - (Optional) Constraint for filtering the working day exceptions to be returned based on their date.

endDateTime - (Optional) Constraint for filtering the working day exceptions to be returned based on their date.

requiredDetail - (Optional) Specifies the level of detail required in the response.

Returns:

Returns a XmlCalendarEntriesType.

This contains the time zone information for the calendar if defined and the working week and working day exceptions as defined in the calendar.

Throws:

com.tibco.n2.dac.services.CalendarFault - In the event that the calendar can not be queried.

com.tibco.n2.dac.services.SecurityFault - In the event that incorrect security information is presented.

updateWorkingDays

java.lang.String updateWorkingDays(java.lang.String guid,
                                 com.tibco.n2.dac.api.XmlDayType[] workingDay)
                                   throws com.tibco.n2.dac.services.CalendarFault,
                                          com.tibco.n2.dac.services.SecurityFault

Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendar(com.tibco.n2.dac.api.basic.XmlBaseCalendar).

Modifies the working days for a given entity.

To modify or remove working days the previous entries should be overwritten.

Parameters:

guid - The GUID of the Calendar that contains the working days entries to be modified.

workingDay - An array of working day information containing the working day and associated working hours for each working day.

Returns:

Returns a String confirmation code with respect to the update.

Throws:

com.tibco.n2.dac.services.CalendarFault - In the event that the calendar can not be queried.

com.tibco.n2.dac.services.SecurityFault - In the event that incorrect security information is presented.

addWorkingDayExceptions

java.lang.String[] addWorkingDayExceptions(java.lang.String guid,
                                         com.tibco.n2.dac.api.XmlNewWorkingDayExceptionType[] addExceptions)
                                           throws com.tibco.n2.dac.services.CalendarFault,
                                                  com.tibco.n2.dac.services.SecurityFault

Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendar(com.tibco.n2.dac.api.basic.XmlBaseCalendar).

Adds new working day exceptions for a given entity.

Parameters:

guid - The GUID of the Calendar that will contain the working day exceptions to be added.

addExceptions - An array of working day exception information containing dates and times of working day exceptions and whether they are to be marked as free or busy time.

Returns:

Returns an array of String. Each one will contain the GUID of the working day exception that has been added.

Throws:

com.tibco.n2.dac.services.CalendarFault - In the event that the calendar can not be queried.

com.tibco.n2.dac.services.SecurityFault - In the event that incorrect security information is presented.

updateWorkingDayExceptions

java.lang.String updateWorkingDayExceptions(java.lang.String guid,
                                          com.tibco.n2.dac.api.XmlExistingWorkingDayExceptionType[] updateExceptions)
                                            throws com.tibco.n2.dac.services.CalendarFault,
                                                   com.tibco.n2.dac.services.SecurityFault

Deprecated. since AMX-BPM 2.0.0 use WorkCalService.saveCalendarEntry(int, String, String, Calendar, Calendar, com.tibco.n2.dac.api.basic.XmlNewWorkingDayExclusion[], com.tibco.n2.dac.api.basic.XmlExistingWorkingDayExclusion[], com.tibco.n2.dac.api.basic.XmlNewRecurringExclusion[], com.tibco.n2.dac.api.basic.XmlExistingRecurringExclusion[]).

Updates existing working day exceptions for a given entity.

Parameters:

guid - The GUID of the Calendar that will contain the working day exceptions to be modified.

updateExceptions - An array of working day exception information containing updated dates and times of working day exceptions and whether they are to be marked as free or busy time. Each modification is based on the working day exception's GUID.

Returns:

Returns a String confirmation code with respect to the update.

Throws:

com.tibco.n2.dac.services.CalendarFault - In the event that the calendar can not be queried.

com.tibco.n2.dac.services.SecurityFault - In the event that incorrect security information is presented.

deleteWorkingDayExceptions

java.lang.String deleteWorkingDayExceptions(java.lang.String guid,
                                          java.lang.String[] deleteExceptions)
                                            throws com.tibco.n2.dac.services.CalendarFault,
                                                   com.tibco.n2.dac.services.SecurityFault

Deprecated. since AMX-BPM 2.0.0 use WorkCalService.deleteCalendarEntries(int, String, String, String[]).

Removes existing working day exceptions for a given entity.

Parameters:

guid - The GUID of the Calendar that will contain the working day exceptions to be deleted.

deleteExceptions - An array of String containing the GUIDs of the working day exceptions to be removed.

Returns:

Returns a String confirmation code with respect to the update.

Throws:

com.tibco.n2.dac.services.CalendarFault - In the event that the calendar can not be queried.

com.tibco.n2.dac.services.SecurityFault - In the event that incorrect security information is presented.