Package com.carfey.ops.api.embedded

Class CustomCalendarManager

java.lang.Object

com.carfey.ops.api.embedded.AbstractAPIManager

com.carfey.ops.api.embedded.CustomCalendarManager

public class CustomCalendarManager
extends AbstractAPIManager

Class to manage custom calendars using the Obsidian public embedded API. See AbstractAPIManager for details on how transactions are managed within all requests.

Example:

    CustomCalendarListing calendars = new CustomCalendarManager().listCalendars();
    System.out.println("Existing calendars: " + calendars);
 

Since:

2.3

See Also:

Embedded API Wiki, REST API Wiki, Carfey Date

Nested Class Summary

Nested classes/interfaces inherited from class com.carfey.ops.api.embedded.AbstractAPIManager

AbstractAPIManager.ActionCallable

Constructor Summary

Constructors

Constructor	Description
CustomCalendarManager()

Method Summary

Modifier and Type	Method	Description
CustomCalendar	addCalendar(CustomCalendarUpdateRequest request, java.lang.String auditUser)	Creates a new CustomCalendar based on the supplied request.
CustomCalendar	deleteCalendar(long customCalendarId, java.lang.String auditUser)	Deletes the requested CustomCalendar.
CustomCalendar	getCalendar(long customCalendarId)	Loads an existing CustomCalendar.
CustomCalendarListing	listCalendars()	Loads all existing CustomCalendars.
CustomCalendar	updateCalendar(long customCalendarId, CustomCalendarUpdateRequest request, java.lang.String auditUser)	Updates an existing CustomCalendar based on the supplied request.

Methods inherited from class com.carfey.ops.api.embedded.AbstractAPIManager

addParameter, runApiTarget, validateRequired, withTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomCalendarManager

public CustomCalendarManager()

Method Detail

listCalendars

public CustomCalendarListing listCalendars()
                                    throws java.lang.Exception

Loads all existing CustomCalendars.

Returns:

CustomCalendarListing containing all configured CustomCalendars (never null)

Throws:

java.lang.Exception - Any type of unexpected exception.

getCalendar

public CustomCalendar getCalendar(long customCalendarId)
                           throws MissingEntityException,
                                  java.lang.Exception

Loads an existing CustomCalendar.

Parameters:

customCalendarId - The id of the CustomCalendar to fetch.

Returns:

the CustomCalendar (never null)

Throws:

MissingEntityException - If the CustomCalendar with the requested id does not exist.

java.lang.Exception - Any other type of unexpected exception.

addCalendar

public CustomCalendar addCalendar(CustomCalendarUpdateRequest request,
                                  java.lang.String auditUser)
                           throws ValidationException,
                                  java.lang.Exception

Creates a new CustomCalendar based on the supplied request.

Parameters:

request - Details of the creation request (not null)

auditUser - Optional user that is marked in audit columns. Defaults to "embeddedAPI".

Returns:

the created CustomCalendar (never null)

Throws:

ValidationException - A validation error which prevents the action from succeeding.

java.lang.Exception - Any other type of unexpected exception.

updateCalendar

public CustomCalendar updateCalendar(long customCalendarId,
                                     CustomCalendarUpdateRequest request,
                                     java.lang.String auditUser)
                              throws MissingEntityException,
                                     ValidationException,
                                     java.lang.Exception

Updates an existing CustomCalendar based on the supplied request.

Parameters:

customCalendarId - The id of the custom calendar to update.

request - Details of the creation request (not null)

auditUser - Optional user that is marked in audit columns. Defaults to "embeddedAPI".

Returns:

the CustomCalendar (never null)

Throws:

MissingEntityException - If the custom calendar with the requested id does not exist.

ValidationException - A validation error which prevents the action from succeeding.

java.lang.Exception - Any other type of unexpected exception.

deleteCalendar

public CustomCalendar deleteCalendar(long customCalendarId,
                                     java.lang.String auditUser)
                              throws ValidationException,
                                     MissingEntityException,
                                     java.lang.Exception

Deletes the requested CustomCalendar.

Parameters:

customCalendarId - ID of the custom calendar to delete

auditUser - Optional user that is marked in audit columns. Defaults to "embeddedAPI".

Returns:

the deleted CustomCalendar

Throws:

ValidationException - A validation error which prevents the action from succeeding.

MissingEntityException - If the custom calendar with the requested ID does not exist.

java.lang.Exception - Any other type of unexpected exception.

Since:

3.0