org.bimserver.models.ifc4.IfcRecurrencePattern Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pluginbase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
The newest version!
/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.ifc4;

import org.bimserver.emf.IdEObject;
import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc Recurrence Pattern'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getRecurrenceType Recurrence Type}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getDayComponent Day Component}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getWeekdayComponent Weekday Component}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getMonthComponent Month Component}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getPosition Position}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getInterval Interval}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getOccurrences Occurrences}
 *   {@link org.bimserver.models.ifc4.IfcRecurrencePattern#getTimePeriods Time Periods}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface IfcRecurrencePattern extends IdEObject {
	/**
	 * Returns the value of the 'Recurrence Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcRecurrenceTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Recurrence Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Recurrence Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcRecurrenceTypeEnum
	 * @see #setRecurrenceType(IfcRecurrenceTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_RecurrenceType()
	 * @model
	 * @generated
	 */
	IfcRecurrenceTypeEnum getRecurrenceType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getRecurrenceType Recurrence Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Recurrence Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcRecurrenceTypeEnum
	 * @see #getRecurrenceType()
	 * @generated
	 */
	void setRecurrenceType(IfcRecurrenceTypeEnum value);

	/**
	 * Returns the value of the 'Day Component' attribute list.
	 * The list contents are of type {@link java.lang.Integer}.
	 * 
	 * 
	 * If the meaning of the 'Day Component' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Day Component' attribute list.
	 * @see #isSetDayComponent()
	 * @see #unsetDayComponent()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_DayComponent()
	 * @model unique="false" unsettable="true"
	 * @generated
	 */
	EList getDayComponent();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getDayComponent Day Component}' attribute list.
	 * 
	 * 
	 * @see #isSetDayComponent()
	 * @see #getDayComponent()
	 * @generated
	 */
	void unsetDayComponent();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getDayComponent Day Component}' attribute list is set.
	 * 
	 * 
	 * @return whether the value of the 'Day Component' attribute list is set.
	 * @see #unsetDayComponent()
	 * @see #getDayComponent()
	 * @generated
	 */
	boolean isSetDayComponent();

	/**
	 * Returns the value of the 'Weekday Component' attribute list.
	 * The list contents are of type {@link java.lang.Integer}.
	 * 
	 * 
	 * If the meaning of the 'Weekday Component' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Weekday Component' attribute list.
	 * @see #isSetWeekdayComponent()
	 * @see #unsetWeekdayComponent()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_WeekdayComponent()
	 * @model unique="false" unsettable="true"
	 * @generated
	 */
	EList getWeekdayComponent();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getWeekdayComponent Weekday Component}' attribute list.
	 * 
	 * 
	 * @see #isSetWeekdayComponent()
	 * @see #getWeekdayComponent()
	 * @generated
	 */
	void unsetWeekdayComponent();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getWeekdayComponent Weekday Component}' attribute list is set.
	 * 
	 * 
	 * @return whether the value of the 'Weekday Component' attribute list is set.
	 * @see #unsetWeekdayComponent()
	 * @see #getWeekdayComponent()
	 * @generated
	 */
	boolean isSetWeekdayComponent();

	/**
	 * Returns the value of the 'Month Component' attribute list.
	 * The list contents are of type {@link java.lang.Integer}.
	 * 
	 * 
	 * If the meaning of the 'Month Component' attribute list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Month Component' attribute list.
	 * @see #isSetMonthComponent()
	 * @see #unsetMonthComponent()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_MonthComponent()
	 * @model unique="false" unsettable="true"
	 * @generated
	 */
	EList getMonthComponent();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getMonthComponent Month Component}' attribute list.
	 * 
	 * 
	 * @see #isSetMonthComponent()
	 * @see #getMonthComponent()
	 * @generated
	 */
	void unsetMonthComponent();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getMonthComponent Month Component}' attribute list is set.
	 * 
	 * 
	 * @return whether the value of the 'Month Component' attribute list is set.
	 * @see #unsetMonthComponent()
	 * @see #getMonthComponent()
	 * @generated
	 */
	boolean isSetMonthComponent();

	/**
	 * Returns the value of the 'Position' attribute.
	 * 
	 * 
	 * If the meaning of the 'Position' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Position' attribute.
	 * @see #isSetPosition()
	 * @see #unsetPosition()
	 * @see #setPosition(int)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_Position()
	 * @model unsettable="true"
	 * @generated
	 */
	int getPosition();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getPosition Position}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Position' attribute.
	 * @see #isSetPosition()
	 * @see #unsetPosition()
	 * @see #getPosition()
	 * @generated
	 */
	void setPosition(int value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getPosition Position}' attribute.
	 * 
	 * 
	 * @see #isSetPosition()
	 * @see #getPosition()
	 * @see #setPosition(int)
	 * @generated
	 */
	void unsetPosition();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getPosition Position}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Position' attribute is set.
	 * @see #unsetPosition()
	 * @see #getPosition()
	 * @see #setPosition(int)
	 * @generated
	 */
	boolean isSetPosition();

	/**
	 * Returns the value of the 'Interval' attribute.
	 * 
	 * 
	 * If the meaning of the 'Interval' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Interval' attribute.
	 * @see #isSetInterval()
	 * @see #unsetInterval()
	 * @see #setInterval(int)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_Interval()
	 * @model unsettable="true"
	 * @generated
	 */
	int getInterval();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getInterval Interval}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Interval' attribute.
	 * @see #isSetInterval()
	 * @see #unsetInterval()
	 * @see #getInterval()
	 * @generated
	 */
	void setInterval(int value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getInterval Interval}' attribute.
	 * 
	 * 
	 * @see #isSetInterval()
	 * @see #getInterval()
	 * @see #setInterval(int)
	 * @generated
	 */
	void unsetInterval();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getInterval Interval}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Interval' attribute is set.
	 * @see #unsetInterval()
	 * @see #getInterval()
	 * @see #setInterval(int)
	 * @generated
	 */
	boolean isSetInterval();

	/**
	 * Returns the value of the 'Occurrences' attribute.
	 * 
	 * 
	 * If the meaning of the 'Occurrences' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Occurrences' attribute.
	 * @see #isSetOccurrences()
	 * @see #unsetOccurrences()
	 * @see #setOccurrences(int)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_Occurrences()
	 * @model unsettable="true"
	 * @generated
	 */
	int getOccurrences();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getOccurrences Occurrences}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Occurrences' attribute.
	 * @see #isSetOccurrences()
	 * @see #unsetOccurrences()
	 * @see #getOccurrences()
	 * @generated
	 */
	void setOccurrences(int value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getOccurrences Occurrences}' attribute.
	 * 
	 * 
	 * @see #isSetOccurrences()
	 * @see #getOccurrences()
	 * @see #setOccurrences(int)
	 * @generated
	 */
	void unsetOccurrences();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getOccurrences Occurrences}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Occurrences' attribute is set.
	 * @see #unsetOccurrences()
	 * @see #getOccurrences()
	 * @see #setOccurrences(int)
	 * @generated
	 */
	boolean isSetOccurrences();

	/**
	 * Returns the value of the 'Time Periods' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcTimePeriod}.
	 * 
	 * 
	 * If the meaning of the 'Time Periods' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Time Periods' reference list.
	 * @see #isSetTimePeriods()
	 * @see #unsetTimePeriods()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcRecurrencePattern_TimePeriods()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getTimePeriods();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getTimePeriods Time Periods}' reference list.
	 * 
	 * 
	 * @see #isSetTimePeriods()
	 * @see #getTimePeriods()
	 * @generated
	 */
	void unsetTimePeriods();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcRecurrencePattern#getTimePeriods Time Periods}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Time Periods' reference list is set.
	 * @see #unsetTimePeriods()
	 * @see #getTimePeriods()
	 * @generated
	 */
	boolean isSetTimePeriods();

} // IfcRecurrencePattern