com.ibm.rpm.applicationadministration.containers
RPMCalendar

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.applicationadministration.containers.RPMCalendar

RPMCalendar
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Related scope: com.ibm.rpm.applicationadministration.scope.CalendarScope

RPMCalendar represents a calendar, it determine the standard working time and non-working time, such as weekends and holidays, or special working shifts for a project or a resource.

Parent is not mandatory, allowed parent type is RPMCalendar.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Related code samples :

Java

C#

Field Summary
RPMCalendar[] calendars
   List of RPMCalendar children
CalendarException[] exceptions
   List of dates for which the working time does not follow the default schedule.
xsd:double hoursPerDay
   The average number of hours per day.
xsd:double hoursPerWeek
   The average number of hours per week.
xsd:string name
    Name of the calendar.
CalendarWeekDay standardFriday
   Friday standard working time.
CalendarWeekDay standardMonday
   Monday standard working time.
CalendarWeekDay standardSaturday
   Saturday standard working time.
CalendarWeekDay standardSunday
   Sunday standard working time.
CalendarWeekDay standardThursday
   Thursday standard working time.
CalendarWeekDay standardTuesday
   Tuesday standard working time.
CalendarWeekDay standardWednesday
   Wednesday standard working time.
xsd:dateTime startDate
   Start date

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.

Field Detail

calendars


RPMCalendar[] calendars
List of RPMCalendar children

Scoping: This field will be used by the API if the scope field calendars is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.

Valid types:
com.ibm.rpm.applicationadministration.containers.RPMCalendar

exceptions


CalendarException[] exceptions
List of dates for which the working time does not follow the default schedule.

Scoping: This field will be used by the API if the scope field exceptions is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.

Valid types:
com.ibm.rpm.applicationadministration.containers.CalendarException[]

hoursPerDay


xsd:double  hoursPerDay
The average number of hours per day.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 24.


hoursPerWeek


xsd:double  hoursPerWeek
The average number of hours per week.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 168.


name


xsd:string  name
Name of the calendar.

Maximum: The maximum length for this field is 50 characters.


standardFriday


CalendarWeekDay standardFriday
Friday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardMonday


CalendarWeekDay standardMonday
Monday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardSaturday


CalendarWeekDay standardSaturday
Saturday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardSunday


CalendarWeekDay standardSunday
Sunday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardThursday


CalendarWeekDay standardThursday
Thursday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardTuesday


CalendarWeekDay standardTuesday
Tuesday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


standardWednesday


CalendarWeekDay standardWednesday
Wednesday standard working time.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


startDate


xsd:dateTime  startDate
Start date

Validation: The year, month and day values will be used by this field.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.applicationadministration.containers.AdministrationModule
com.ibm.rpm.applicationadministration.containers.RPMCalendar