Package com.luciad.format.aixm51.model.features.shared.schedules

Class TLcdAIXM51Timesheet

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.gml32.model.TLcdGML32AbstractGML
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMObject
com.luciad.format.aixm51.model.features.shared.schedules.TLcdAIXM51Timesheet
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdAIXM51Timesheet extends TLcdAIXM51AbstractAIXMObject
The definition of a single time interval, that occurs repeatedly as part of a schedule.
Since:
10.0

  • Field Details

  • Constructor Details

    • TLcdAIXM51Timesheet

      public TLcdAIXM51Timesheet()

    • TLcdAIXM51Timesheet

      public TLcdAIXM51Timesheet(TLcdDataType aType)

  • Method Details

    • getTimeReference

      public TLcdAIXM51CodeTimeReference getTimeReference()
      Returns the role value contained in the value of the TIME_REFERENCE_PROPERTY property. Returns null if the value of the TIME_REFERENCE_PROPERTY property is null.

      A code indicating the time reference system (for example, 'UTC').

      Returns:
      the role value of the TIME_REFERENCE_PROPERTY property.
      See Also:

    • setTimeReference

      public void setTimeReference(TLcdAIXM51CodeTimeReference aValue)
      Sets the value of the property that maps to the timeReference element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the TIME_REFERENCE_PROPERTY property is set to null.

      A code indicating the time reference system (for example, 'UTC').

      Parameters:
      aValue - the role value to set for the TIME_REFERENCE_PROPERTY property.

    • getStartDate

      public String getStartDate()
      Returns the role value contained in the value of the START_DATE_PROPERTY property. Returns null if the value of the START_DATE_PROPERTY property is null.

      The start date of the validity of a timesheet. Used together with "endDate" to express repetitive time periods like 15 May to 15 November.

      Returns:
      the role value of the START_DATE_PROPERTY property.
      See Also:

    • setStartDate

      public void setStartDate(String aValue)
      Sets the value of the property that maps to the startDate element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the START_DATE_PROPERTY property is set to null.

      The start date of the validity of a timesheet. Used together with "endDate" to express repetitive time periods like 15 May to 15 November.

      Parameters:
      aValue - the role value to set for the START_DATE_PROPERTY property.

    • getEndDate

      public String getEndDate()
      Returns the role value contained in the value of the END_DATE_PROPERTY property. Returns null if the value of the END_DATE_PROPERTY property is null.

      The end date of the validity of a timesheet. Used together with "startDate" to express repetitive time periods like 15 May to 15 November.

      Returns:
      the role value of the END_DATE_PROPERTY property.
      See Also:

    • setEndDate

      public void setEndDate(String aValue)
      Sets the value of the property that maps to the endDate element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the END_DATE_PROPERTY property is set to null.

      The end date of the validity of a timesheet. Used together with "startDate" to express repetitive time periods like 15 May to 15 November.

      Parameters:
      aValue - the role value to set for the END_DATE_PROPERTY property.

    • getDay

      public TLcdAIXM51CodeDay getDay()
      Returns the role value contained in the value of the DAY_PROPERTY property. Returns null if the value of the DAY_PROPERTY property is null.

      A code indicating the day the timesheet is referring to.

      Returns:
      the role value of the DAY_PROPERTY property.
      See Also:

    • setDay

      public void setDay(TLcdAIXM51CodeDay aValue)
      Sets the value of the property that maps to the day element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the DAY_PROPERTY property is set to null.

      A code indicating the day the timesheet is referring to.

      Parameters:
      aValue - the role value to set for the DAY_PROPERTY property.

    • getDayTil

      public TLcdAIXM51CodeDay getDayTil()
      Returns the role value contained in the value of the DAY_TIL_PROPERTY property. Returns null if the value of the DAY_TIL_PROPERTY property is null.

      A code indicating the days affected by a timesheet, as follows: - if the value of this attribute is left blank, the "endTime", "endEvent", "endTimeRelativeEvent" and "endEventInterpretation" properties must be considered as occurring on the day specified in the attribute "day" (e.g. MON from 07:30 till 16:00); - if the value of this attribute is not blank, the "endTime", "endEvent", "endTimeRelativeEvent" and "endEventInterpretation" properties must be considered as occurring on the day specified in this attribute and the period described by the timesheet is considered to be a continuous one (e.g. MON 07:30 till FRI 16:00);

      Returns:
      the role value of the DAY_TIL_PROPERTY property.
      See Also:

    • setDayTil

      public void setDayTil(TLcdAIXM51CodeDay aValue)
      Sets the value of the property that maps to the dayTil element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the DAY_TIL_PROPERTY property is set to null.

      A code indicating the days affected by a timesheet, as follows: - if the value of this attribute is left blank, the "endTime", "endEvent", "endTimeRelativeEvent" and "endEventInterpretation" properties must be considered as occurring on the day specified in the attribute "day" (e.g. MON from 07:30 till 16:00); - if the value of this attribute is not blank, the "endTime", "endEvent", "endTimeRelativeEvent" and "endEventInterpretation" properties must be considered as occurring on the day specified in this attribute and the period described by the timesheet is considered to be a continuous one (e.g. MON 07:30 till FRI 16:00);

      Parameters:
      aValue - the role value to set for the DAY_TIL_PROPERTY property.

    • getStartTime

      public String getStartTime()
      Returns the role value contained in the value of the START_TIME_PROPERTY property. Returns null if the value of the START_TIME_PROPERTY property is null.

      The time of the day (specified in the "day" attribute) when the period described in the timesheet starts.

      Returns:
      the role value of the START_TIME_PROPERTY property.
      See Also:

    • setStartTime

      public void setStartTime(String aValue)
      Sets the value of the property that maps to the startTime element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the START_TIME_PROPERTY property is set to null.

      The time of the day (specified in the "day" attribute) when the period described in the timesheet starts.

      Parameters:
      aValue - the role value to set for the START_TIME_PROPERTY property.

    • getStartEvent

      public TLcdAIXM51CodeTimeEvent getStartEvent()
      Returns the role value contained in the value of the START_EVENT_PROPERTY property. Returns null if the value of the START_EVENT_PROPERTY property is null.

      A coded reference to an event (like sunset or sunrise), the occurrence of which indicates when the period described in the Timesheet starts.

      Returns:
      the role value of the START_EVENT_PROPERTY property.
      See Also:

    • setStartEvent

      public void setStartEvent(TLcdAIXM51CodeTimeEvent aValue)
      Sets the value of the property that maps to the startEvent element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the START_EVENT_PROPERTY property is set to null.

      A coded reference to an event (like sunset or sunrise), the occurrence of which indicates when the period described in the Timesheet starts.

      Parameters:
      aValue - the role value to set for the START_EVENT_PROPERTY property.

    • getStartTimeRelativeEvent

      public TLcdAIXM51ValDuration getStartTimeRelativeEvent()
      Returns the value of the property that maps to the startTimeRelativeEvent element.

      The number of minutes before or after the event referred to in the "startEvent" attribute when the period described in the Timesheet starts.

      Returns:
      the value of the START_TIME_RELATIVE_EVENT_PROPERTY property.

    • setStartTimeRelativeEvent

      public void setStartTimeRelativeEvent(TLcdAIXM51ValDuration aValue)
      Sets the value of the property that maps to the startTimeRelativeEvent element.

      The number of minutes before or after the event referred to in the "startEvent" attribute when the period described in the Timesheet starts.

      Parameters:
      aValue - the value to set for the START_TIME_RELATIVE_EVENT_PROPERTY property.

    • getStartEventInterpretation

      public TLcdAIXM51CodeTimeEventCombination getStartEventInterpretation()
      Returns the role value contained in the value of the START_EVENT_INTERPRETATION_PROPERTY property. Returns null if the value of the START_EVENT_INTERPRETATION_PROPERTY property is null.

      When both the "startTime" and "startEvent" values are not blank, this attribute explains how the combination of the two attributes should be interpreted, i.e. which of the two moments in time is the beginning of the period described by the timesheet.

      Returns:
      the role value of the START_EVENT_INTERPRETATION_PROPERTY property.
      See Also:

    • setStartEventInterpretation

      public void setStartEventInterpretation(TLcdAIXM51CodeTimeEventCombination aValue)
      Sets the value of the property that maps to the startEventInterpretation element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the START_EVENT_INTERPRETATION_PROPERTY property is set to null.

      When both the "startTime" and "startEvent" values are not blank, this attribute explains how the combination of the two attributes should be interpreted, i.e. which of the two moments in time is the beginning of the period described by the timesheet.

      Parameters:
      aValue - the role value to set for the START_EVENT_INTERPRETATION_PROPERTY property.

    • getEndTime

      public String getEndTime()
      Returns the role value contained in the value of the END_TIME_PROPERTY property. Returns null if the value of the END_TIME_PROPERTY property is null.

      The time of the day when the period described in the timesheet ends.

      Returns:
      the role value of the END_TIME_PROPERTY property.
      See Also:

    • setEndTime

      public void setEndTime(String aValue)
      Sets the value of the property that maps to the endTime element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the END_TIME_PROPERTY property is set to null.

      The time of the day when the period described in the timesheet ends.

      Parameters:
      aValue - the role value to set for the END_TIME_PROPERTY property.

    • getEndEvent

      public TLcdAIXM51CodeTimeEvent getEndEvent()
      Returns the role value contained in the value of the END_EVENT_PROPERTY property. Returns null if the value of the END_EVENT_PROPERTY property is null.

      A coded reference to an event (like sunset or sunrise), the occurrence of which indicates when the period described in the Timesheet ends.

      Returns:
      the role value of the END_EVENT_PROPERTY property.
      See Also:

    • setEndEvent

      public void setEndEvent(TLcdAIXM51CodeTimeEvent aValue)
      Sets the value of the property that maps to the endEvent element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the END_EVENT_PROPERTY property is set to null.

      A coded reference to an event (like sunset or sunrise), the occurrence of which indicates when the period described in the Timesheet ends.

      Parameters:
      aValue - the role value to set for the END_EVENT_PROPERTY property.

    • getEndTimeRelativeEvent

      public TLcdAIXM51ValDuration getEndTimeRelativeEvent()
      Returns the value of the property that maps to the endTimeRelativeEvent element.

      The number of minutes before or after the event referred to in the "endEvent" attribute when the period described in the Timesheet ends.

      Returns:
      the value of the END_TIME_RELATIVE_EVENT_PROPERTY property.

    • setEndTimeRelativeEvent

      public void setEndTimeRelativeEvent(TLcdAIXM51ValDuration aValue)
      Sets the value of the property that maps to the endTimeRelativeEvent element.

      The number of minutes before or after the event referred to in the "endEvent" attribute when the period described in the Timesheet ends.

      Parameters:
      aValue - the value to set for the END_TIME_RELATIVE_EVENT_PROPERTY property.

    • getEndEventInterpretation

      public TLcdAIXM51CodeTimeEventCombination getEndEventInterpretation()
      Returns the role value contained in the value of the END_EVENT_INTERPRETATION_PROPERTY property. Returns null if the value of the END_EVENT_INTERPRETATION_PROPERTY property is null.

      When both the "endTime" and "endEvent" values are not blank, this attribute explains how the combination of the two attributes should be interpreted, i.e. which of the two moments in time is the end of the period described by the timesheet.

      Returns:
      the role value of the END_EVENT_INTERPRETATION_PROPERTY property.
      See Also:

    • setEndEventInterpretation

      public void setEndEventInterpretation(TLcdAIXM51CodeTimeEventCombination aValue)
      Sets the value of the property that maps to the endEventInterpretation element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the END_EVENT_INTERPRETATION_PROPERTY property is set to null.

      When both the "endTime" and "endEvent" values are not blank, this attribute explains how the combination of the two attributes should be interpreted, i.e. which of the two moments in time is the end of the period described by the timesheet.

      Parameters:
      aValue - the role value to set for the END_EVENT_INTERPRETATION_PROPERTY property.

    • getDaylightSavingAdjust

      public TLcdAIXM51CodeYesNo getDaylightSavingAdjust()
      Returns the role value contained in the value of the DAYLIGHT_SAVING_ADJUST_PROPERTY property. Returns null if the value of the DAYLIGHT_SAVING_ADJUST_PROPERTY property is null.

      Indicates that the startTime and endTime values have to be decreased by one hour when Daylight Saving is in force (summer time).

      Returns:
      the role value of the DAYLIGHT_SAVING_ADJUST_PROPERTY property.
      See Also:

    • setDaylightSavingAdjust

      public void setDaylightSavingAdjust(TLcdAIXM51CodeYesNo aValue)
      Sets the value of the property that maps to the daylightSavingAdjust element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the DAYLIGHT_SAVING_ADJUST_PROPERTY property is set to null.

      Indicates that the startTime and endTime values have to be decreased by one hour when Daylight Saving is in force (summer time).

      Parameters:
      aValue - the role value to set for the DAYLIGHT_SAVING_ADJUST_PROPERTY property.

    • getExcluded

      public TLcdAIXM51CodeYesNo getExcluded()
      Returns the role value contained in the value of the EXCLUDED_PROPERTY property. Returns null if the value of the EXCLUDED_PROPERTY property is null.

      Indicates that the time block indicated by the current Timesheet is excluded (subtracted) from the total schedule.

      Returns:
      the role value of the EXCLUDED_PROPERTY property.
      See Also:

    • setExcluded

      public void setExcluded(TLcdAIXM51CodeYesNo aValue)
      Sets the value of the property that maps to the excluded element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the EXCLUDED_PROPERTY property is set to null.

      Indicates that the time block indicated by the current Timesheet is excluded (subtracted) from the total schedule.

      Parameters:
      aValue - the role value to set for the EXCLUDED_PROPERTY property.

    • getAnnotation

      public List<TLcdAIXM51Note> getAnnotation()
      Gets the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      Returns:
      the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      See Also:

    • getExtension

      public List<TLcdAIXM51AbstractExtension> getExtension()
      Gets the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      Returns:
      the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      See Also: