Package com.appiancorp.suiteapi.process
Interface CalendarService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
public interface CalendarService
extends com.appiancorp.services.ContextSensitiveService
This service provides methods which retrieve and update calendars in the system.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptioncreateCalendar
(WorkingCalendar calendar) Creates a calendar.void
deleteCalendar
(Long id) Deletes a calendargetCalendar
(Long id) Gets a calendar.getCalendarsPaging
(int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) Retrieves calendars in the system, paging the results.Deprecated.void
updateCalendar
(WorkingCalendar calendar) Updates a calendar.void
updateDefaultCalendar
(SystemCalendar defaultCalendar_) Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
getDefaultCalendar$UPDATES
static final boolean getDefaultCalendar$UPDATES- See Also:
-
updateDefaultCalendar$UPDATES
static final boolean updateDefaultCalendar$UPDATES- See Also:
-
getCalendar$UPDATES
static final boolean getCalendar$UPDATES- See Also:
-
createCalendar$UPDATES
static final boolean createCalendar$UPDATES- See Also:
-
updateCalendar$UPDATES
static final boolean updateCalendar$UPDATES- See Also:
-
deleteCalendar$UPDATES
static final boolean deleteCalendar$UPDATES- See Also:
-
getCalendarsPaging$UPDATES
static final boolean getCalendarsPaging$UPDATES- See Also:
-
-
Method Details
-
getDefaultCalendar
SystemCalendar getDefaultCalendar()Deprecated.Retrieves the default calendar for process. There is no security for retrieving the system calendar.- Returns:
- The default calendar for process.
-
updateDefaultCalendar
Sets the default calendar for process.- Parameters:
defaultCalendar_
- newSystemCalendar
to set.- Throws:
PrivilegeException
- if the current user does not have permission to update the system calendar. Only System Administrators may update the system calendar.
-
getCalendar
Gets a calendar.- Parameters:
id
- the id of the calendar to retrieve- Returns:
- the calendar
- Throws:
InvalidCalendarException
- if no calendar exists with the given id
-
createCalendar
Creates a calendar.- Parameters:
calendar
- the calendar to create- Returns:
- the id of the newly created calendar
- Throws:
PrivilegeException
- if the current user does not have permission to create a calendar. Only System Administrators may create calendars.NullPointerException
- if the calendar name is not setIllegalArgumentException
- if the calendar name is not unique
-
updateCalendar
Updates a calendar.- Parameters:
calendar
- the calendar to update- Throws:
InvalidCalendarException
- if no calendar exists with the given idPrivilegeException
- if the current user does not have permission to update the calendar. Only System Administrators may create calendars.NullPointerException
- if the calendar name is not setIllegalArgumentException
- if the calendar name is not unique
-
deleteCalendar
Deletes a calendar- Parameters:
id
- the id of the calendar to delete- Throws:
InvalidCalendarException
- if no calendar exists with the given idPrivilegeException
- if the current user does not have permission to delete the calendar. Only System Administrators may delete calendars.
-
getCalendarsPaging
ResultPage getCalendarsPaging(int startIndex, int batchSize, Integer sortProperty, Integer sortOrder) Retrieves calendars in the system, paging the results.- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection.sortProperty_
- the property by which the results will be sorted. Should be one of theSORT_BY_XXX
constants defined inTaskSummary
.sortOrder_
- The order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- a
ResultPage
containing a list ofWorkingCalendar
objects
-
getCalendar(java.lang.Long)