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
static final boolean	deleteCalendar$UPDATES
static final boolean	getCalendar$UPDATES
static final boolean	getCalendarsPaging$UPDATES
static final boolean	getDefaultCalendar$UPDATES
static final boolean	updateCalendar$UPDATES
static final boolean	updateDefaultCalendar$UPDATES

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

static final boolean getDefaultCalendar$UPDATES

See Also:

• Constant Field Values

updateDefaultCalendar$UPDATES

static final boolean updateDefaultCalendar$UPDATES

See Also:

• Constant Field Values

getCalendar$UPDATES

static final boolean getCalendar$UPDATES

See Also:

• Constant Field Values

createCalendar$UPDATES

static final boolean createCalendar$UPDATES

See Also:

• Constant Field Values

updateCalendar$UPDATES

static final boolean updateCalendar$UPDATES

See Also:

• Constant Field Values

deleteCalendar$UPDATES

static final boolean deleteCalendar$UPDATES

See Also:

• Constant Field Values

getCalendarsPaging$UPDATES

static final boolean getCalendarsPaging$UPDATES

See Also:

• Constant Field Values

Method Details

getDefaultCalendar

@Deprecated
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
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

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

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

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

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

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