se.mithlond.services.organisation.api.EventCalendarService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mithlond-services-organisation-api Show documentation
Mithlond Service: Organisation (API, version ${project.version})
There is a newer version: 1.1.0
Show newest version
/*
 * #%L
 * Nazgul Project: mithlond-services-organisation-api
 * %%
 * Copyright (C) 2010 - 2013 jGuru Europe AB
 * %%
 * Licensed under the jGuru Europe AB license (the "License"), based
 * on Apache License, Version 2.0; you may not use this file except
 * in compliance with the License.
 * 
 * You may obtain a copy of the License at
 * 
 *       http://www.jguru.se/licenses/jguruCorporateSourceLicense-2.0.txt
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

package se.mithlond.services.organisation.api;

import se.mithlond.services.organisation.model.activity.EventCalendar;
import se.mithlond.services.organisation.model.membership.Membership;
import se.mithlond.services.shared.spi.jpa.JpaCudService;

import javax.ejb.Asynchronous;
import javax.ejb.Local;
import javax.validation.constraints.NotNull;
import java.time.LocalDate;
import java.util.List;

/**
 * Specification for how to integrate an organisation with a Calendar service provider.
 * The EventCalendar metadata structure represent a Calendar within a [remote] calendar service provider.
 *
 * @author Lennart Jörelid, jGuru Europe AB
 */
@Local
public interface EventCalendarService extends JpaCudService {

    /**
     * The JNDI name of the EventCalendar request Destination, to which push commands are sent for further processing
     * within another thread/transaction.
     */
    String CALENDAR_REQUEST = "java:global/jms/nazgul/services/eventcalendar/request";

    /**
     * The JNDI name of the EventCalendar error Destination, to which error JMS Messages are sent for
     * further processing within another thread/transaction.
     */
    String CALENDAR_ERROR = "java:global/jms/nazgul/services/eventcalendar/error";

    /**
     * Retrieves all EventCalendars owned by the supplied Organisation. Typically, EventCalendars are matched
     * with remove services such as cloud services from Google, Microsoft, Yahoo or the like.
     *
     * @param organisationName The name of the Organisation for which all remote EventCalendars should be retrieved.
     * @return all Calendars owned by the supplied Organisation and having the supplied runtime environment type.
     */
    List getCalendars(String organisationName, Membership activeMembership);

    /**
     * Pushes all [locally known] Activities to a [remote] EventCalendar, as follows:
     * 
     * Events only present within the database will be created in the remote EventCalendar.
     * Events present in both local database and remote EventCalendar will be updated with the
     * data in the local database (local master), to cope with Admission changes.
     * Events present only in the remote EventCalendar will be removed from it. Such Events/Activities are
     * assumed to be locally removed, and pushing the activities to the remote EventCalendar will remove the
     * corresponding events from it.
     * Only Activities defined within the Organisation owning the provided EventCalendar will be managed.
     * 
     *
     * @param calendarIdentifier     The ID of the EventCalendar to push activity data to. Cannot be {@code null} or empty.
     * @param owningOrganisationName The name of the Organisation owning the EventCalendar to which activity
     *                               information should be pushed. Cannot be {@code null} or empty.
     * @param startTime              Only events that starts after this startTime will be pushed. Cannot be {@code null}.
     * @param endTime                Only events that ends before this endTime will be pushed. Cannot be {@code null}.
     */
    @Asynchronous
    void pushActivities(@NotNull String calendarIdentifier,
                        @NotNull String owningOrganisationName,
                        @NotNull LocalDate startTime,
                        @NotNull LocalDate endTime,
                        @NotNull Membership activeMembership);
}