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:

• SystemCalendar

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	createCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	deleteCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getCalendarsPaging$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	getDefaultCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updateCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.
static final boolean	updateDefaultCalendar$UPDATES	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
Long	createCalendar(WorkingCalendar calendar)	Creates a calendar.
void	deleteCalendar(Long id)	Deletes a calendar
WorkingCalendar	getCalendar(Long id)	Gets a calendar.
ResultPage	getCalendarsPaging(int startIndex, int batchSize, Integer sortProperty, Integer sortOrder)	Retrieves calendars in the system, paging the results.
SystemCalendar	getDefaultCalendar()	Deprecated. use getCalendar(java.lang.Long)
void	updateCalendar(WorkingCalendar calendar)	Updates a calendar.
void	updateDefaultCalendar(SystemCalendar defaultCalendar_)	Deprecated. use updateCalendar(com.appiancorp.suiteapi.process.calendar.WorkingCalendar)

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Details

getDefaultCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean getDefaultCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updateDefaultCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean updateDefaultCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean getCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

createCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean createCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

updateCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean updateCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

deleteCalendar$UPDATES

@Deprecated(forRemoval=true)
static final boolean deleteCalendar$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

getCalendarsPaging$UPDATES

@Deprecated(forRemoval=true)
static final boolean getCalendarsPaging$UPDATES

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Method Details

getDefaultCalendar

@Deprecated
@Read(K_PROCESS_DESIGN)
SystemCalendar getDefaultCalendar()

Deprecated.

use getCalendar(java.lang.Long)

Retrieves the default calendar for process. There is no security for retrieving the system calendar.

Returns:

The default calendar for process.

updateDefaultCalendar

@Deprecated
@Write(K_PROCESS_DESIGN)
void updateDefaultCalendar(SystemCalendar defaultCalendar_)
                    throws PrivilegeException

Deprecated.

use updateCalendar(com.appiancorp.suiteapi.process.calendar.WorkingCalendar)

Sets the default calendar for process.

Parameters:

defaultCalendar_ - new SystemCalendar 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

@Read(K_PROCESS_DESIGN)
WorkingCalendar getCalendar(Long id)
                     throws InvalidCalendarException

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

@Write(K_PROCESS_DESIGN)
Long createCalendar(WorkingCalendar calendar)
             throws PrivilegeException

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 set

IllegalArgumentException - if the calendar name is not unique

updateCalendar

@Write(K_PROCESS_DESIGN)
void updateCalendar(WorkingCalendar calendar)
             throws InvalidCalendarException,
PrivilegeException

Updates a calendar.

Parameters:

calendar - the calendar to update

Throws:

InvalidCalendarException - if no calendar exists with the given id

PrivilegeException - 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 set

IllegalArgumentException - if the calendar name is not unique

deleteCalendar

@Write(K_PROCESS_DESIGN)
void deleteCalendar(Long id)
             throws InvalidCalendarException,
PrivilegeException

Deletes a calendar

Parameters:

id - the id of the calendar to delete

Throws:

InvalidCalendarException - if no calendar exists with the given id

PrivilegeException - if the current user does not have permission to delete the calendar. Only System Administrators may delete calendars.

getCalendarsPaging

@Read(K_PROCESS_DESIGN)
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. Use Constants.COUNT_ALL to return the entire collection.

sortProperty - the property by which the results will be sorted. Should be one of the SORT_BY_XXX constants defined in TaskSummary.

sortOrder - The order in which to sort the results. This should be either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING.

Returns:

a ResultPage containing a list of WorkingCalendar objects