org.apache.causeway.extensions.fullcalendar.applib.Calendarable Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
package org.apache.causeway.extensions.fullcalendar.applib;
import java.util.Map;
import java.util.Set;
import org.apache.causeway.applib.annotation.Programmatic;
/**
* @since 2.0 {@index}
*/
public interface Calendarable {
/**
* The names of unique 'calendar's provided by this object.
*
*
* The 'calendar' is a string identifier that indicates the nature of this event.
*
*
* For example, an event of a lease's FixedBreakOption has three dates: the break date,
* the exercise date and the reminder date. These therefore correspond to three different
* calendar names, respectively Fixed break, Fixed break exercise and
* Fixed break exercise reminder.
*/
@Programmatic
Set getCalendarNames();
/**
* The events associated with this object, keyed by their corresponding {@link #getCalendarNames() calendar name}.
*/
@Programmatic
Map getCalendarEvents();
}