IMXGanttModel (Maximo API)

All Known Subinterfaces:

IWeekGanttModel

All Known Implementing Classes:

GRSchedule, GWASchedule, MXGanttModel, Schedule
```
public interface IMXGanttModel
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IMXGanttModel.PercentCompleteType` Defines the 3 types of % complete TASK - % comp is 0 or 100 depending on whether or not the task is not complete or complete PHYSICAL - user entered % complete on WO ACTUAL - calculated % complete based on reported hours NONE - Don't show % complete on Main Bar

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsActivity(IMXActivity data)`
`IMXActivity`	`getActivityForId(java.lang.String id)`
`Range`	`getActualStartEnd()` Get the "actual" start/end of the project based simply looking at the project work.
`DateRange`	`getCalculatedProjectMinMax()` This is a calculated project min max.
`java.util.HashMap`	`getCalendarBreakPatternCount()`
`java.util.HashMap`	`getCalendarBreakPatternMap()`
`DateRange`	`getCalendarStartEnd()` Returns the configured Calendar Start End dates.
`IMXActivity`	`getChildNode(IMXActivity activity, int index)`
`int`	`getChildNodeCount(IMXActivity activity)`
`int`	`getDisplayRowCount()` Returns the rows in the Schedule are being displayed.
`IGanttConfigInfo`	`getGanttConfigInfo()`
`java.lang.String`	`getLocalizedScenarioFieldTitle()`
`java.util.ArrayList`	`getMergedNonWorkPeriod()`
`java.util.ArrayList`	`getMergedWorkPeriods()`
`int`	`getPages()` if a Paging Model, then return the number of pages, otherwise, return 1.
`int`	`getPageSize()` if a Paging Model, then return the number of rows in a page, other wise return total rows in the schedule
`IMXActivity`	`getParentForActivity(IMXActivity data)`
`IMXGanttModel.PercentCompleteType`	`getPercentCompleteType()` Returns the current % complete type for the project.
`java.lang.String`	`getProjectDescription()`
`int`	`getProjectEndOffsetDays()`
`java.lang.String`	`getProjectId()`
`java.lang.String`	`getProjectName()`
`int`	`getProjectPercentComplete(IMXGanttModel.PercentCompleteType pcType)`
`Range`	`getProjectStartEnd()` Return the Project's Start/End from SKDPROJECT.
`int`	`getProjectStartOffsetDays()`
`java.lang.String`	`getResourceDisplay()`
`IMXResource`	`getResourceForId(java.lang.String id)`
`IMXActivity`	`getRootNode()`
`java.lang.String`	`getScenarioName()`
`java.util.HashMap`	`getShiftCalendarInfo()`
`java.util.List`	`getShifts()`
`SKDShiftWorkTime`	`getShiftWorkTime(java.lang.String shift)`
`java.util.HashMap`	`getSkdActionInfo()`
`java.lang.Object`	`getUserData(java.lang.String key)` Returns a piece of transient, in-memory stored user data for this model.
`java.util.Locale`	`getUserLocale()`
`java.util.TimeZone`	`getUserTimezone()`
`com.ibm.icu.util.ULocale`	`getUserULocale()`
`java.lang.String`	`getWeekDay()`
`java.util.HashMap`	`getWorkHourList()` Deprecated. use getShiftCalendarInfo()
`java.util.TreeMap`	`getWorkPeriodPatternDaySeq()`
`boolean`	`isAllowPastLoadEnabled()`
`boolean`	`isAlternateAvailEnabled()`
`boolean`	`isComplianceEnabled()`
`boolean`	`isPagingModel()` Return true if the model is a paging model
`java.util.Iterator`	`iterateConstraintsFromActivity(IMXActivity activity)`
`void`	`newConstraintFromActivity(java.lang.Object projectMbo, IMXActivity activity, java.sql.ResultSet resultSet)`
`java.util.Iterator`	`reservationIteratorForResource(IMXResource resource)` Returns an Iterator of Reservations for the given Resource
`void`	`setAssetLocNonWorkHourList(java.util.HashMap assetOpCalMap)`
`void`	`setAssetLocOverlapMap(java.util.HashMap assetOverlapCalMap)`
`void`	`setAssetLocWorkHourList(java.util.HashMap assetMntCalMap)`
`void`	`setCalendarBreakPatternCount(java.util.HashMap daysInShiftPattern)`
`void`	`setCalendarBreakPatternMap(java.util.HashMap calendarBreaks)`
`void`	`setComplianceEnabled(boolean val)`
`void`	`setMergedNonWorkPeriod(java.util.ArrayList mergedWorkPeriods)`
`void`	`setMergedWorkPeriod(java.util.ArrayList workPeriod)`
`void`	`setProjectEndOffsetDays(int projectEndOffsetDays)`
`void`	`setProjectPercentComplete(IMXGanttModel.PercentCompleteType pcType, int val)`
`void`	`setProjectStartOffsetDays(int projectStartOffsetDays)`
`void`	`setProjectType(java.lang.String projType)`
`void`	`setShowMaintOperFlag(boolean showmaintoper)`
`void`	`setUserData(java.lang.String key, java.lang.Object data)` Sets a transient piece of user data in the model.
`void`	`setUseWith(java.lang.String useWith)`
`void`	`setWorkHourList(java.util.HashMap shiftCalMap)`
`void`	`setWorkPeriodPatternDaySeq(java.util.TreeMap workPeriodPatternDaySeq)`

- Method Detail
  - getShifts
```
java.util.List getShifts()
```
  - getShiftWorkTime
```
SKDShiftWorkTime getShiftWorkTime(java.lang.String shift)
```
  - getMergedWorkPeriods
```
java.util.ArrayList getMergedWorkPeriods()
```
  - getShiftCalendarInfo
```
java.util.HashMap getShiftCalendarInfo()
```
  - getWorkHourList
```
java.util.HashMap getWorkHourList()
```
    Deprecated. use getShiftCalendarInfo()
    
    Returns:
    
    getShiftCalendarInfo()
  - getUserData
```
java.lang.Object getUserData(java.lang.String key)
```
    Returns a piece of transient, in-memory stored user data for this model. Never use primatives, since this method will cast to the type, and the value is null, then null pointer will the thrown. User Data is will not be serialized when the model is serialized, so you an store non-serializable objects if needed.
    
    Parameters:
    
    key -
    
    Returns:
    
    Throws:
    
    java.lang.NullPointerException - if data is null, and return type is a java primative
  - setUserData
```
void setUserData(java.lang.String key,
                 java.lang.Object data)
```
    Sets a transient piece of user data in the model. User data is not serialized with the model.
    
    Parameters:
    
    key -
    
    data -
  - getActualStartEnd
```
Range getActualStartEnd()
```
    Get the "actual" start/end of the project based simply looking at the project work. This should include when the real work starts and ends for the project.
    
    Parameters:
    
    model -
    
    Returns:
  - getProjectStartEnd
```
Range getProjectStartEnd()
```
    Return the Project's Start/End from SKDPROJECT. These are the absolute values as defined by the project. It will not include padding, etc.
    
    Returns:
  - getCalendarStartEnd
```
DateRange getCalendarStartEnd()
```
    Returns the configured Calendar Start End dates. We not use the full calendar, but this is amount of known calendar that we have.
    
    Returns:
  - getCalculatedProjectMinMax
```
DateRange getCalculatedProjectMinMax()
```
    This is a calculated project min max. It will include at least the union of Actual start/end and project start/end, and will usually include a 2 week calendar padding on each end, IF we have calendar data.
    
    Returns:
  - reservationIteratorForResource
```
java.util.Iterator reservationIteratorForResource(IMXResource resource)
```
    Returns an Iterator of Reservations for the given Resource
    
    Parameters:
    
    resource -
    
    Returns:
  - getMergedNonWorkPeriod
```
java.util.ArrayList getMergedNonWorkPeriod()
```
  - getGanttConfigInfo
```
IGanttConfigInfo getGanttConfigInfo()
```
  - containsActivity
```
boolean containsActivity(IMXActivity data)
```
  - getParentForActivity
```
IMXActivity getParentForActivity(IMXActivity data)
```
  - getCalendarBreakPatternMap
```
java.util.HashMap getCalendarBreakPatternMap()
```
  - getWorkPeriodPatternDaySeq
```
java.util.TreeMap getWorkPeriodPatternDaySeq()
```
  - getCalendarBreakPatternCount
```
java.util.HashMap getCalendarBreakPatternCount()
```
  - getLocalizedScenarioFieldTitle
```
java.lang.String getLocalizedScenarioFieldTitle()
```
  - getScenarioName
```
java.lang.String getScenarioName()
```
  - getProjectId
```
java.lang.String getProjectId()
```
  - getProjectName
```
java.lang.String getProjectName()
```
  - getProjectDescription
```
java.lang.String getProjectDescription()
```
  - isAlternateAvailEnabled
```
boolean isAlternateAvailEnabled()
```
  - isAllowPastLoadEnabled
```
boolean isAllowPastLoadEnabled()
```
  - getResourceDisplay
```
java.lang.String getResourceDisplay()
```
  - getWeekDay
```
java.lang.String getWeekDay()
```
  - setUseWith
```
void setUseWith(java.lang.String useWith)
```
  - setProjectType
```
void setProjectType(java.lang.String projType)
```
  - setShowMaintOperFlag
```
void setShowMaintOperFlag(boolean showmaintoper)
```
  - setAssetLocWorkHourList
```
void setAssetLocWorkHourList(java.util.HashMap assetMntCalMap)
```
  - setAssetLocNonWorkHourList
```
void setAssetLocNonWorkHourList(java.util.HashMap assetOpCalMap)
```
  - setAssetLocOverlapMap
```
void setAssetLocOverlapMap(java.util.HashMap assetOverlapCalMap)
```
  - setMergedNonWorkPeriod
```
void setMergedNonWorkPeriod(java.util.ArrayList mergedWorkPeriods)
```
  - setMergedWorkPeriod
```
void setMergedWorkPeriod(java.util.ArrayList workPeriod)
```
  - setWorkHourList
```
void setWorkHourList(java.util.HashMap shiftCalMap)
```
  - setCalendarBreakPatternMap
```
void setCalendarBreakPatternMap(java.util.HashMap calendarBreaks)
```
  - setCalendarBreakPatternCount
```
void setCalendarBreakPatternCount(java.util.HashMap daysInShiftPattern)
```
  - setWorkPeriodPatternDaySeq
```
void setWorkPeriodPatternDaySeq(java.util.TreeMap workPeriodPatternDaySeq)
```
  - getPercentCompleteType
```
IMXGanttModel.PercentCompleteType getPercentCompleteType()
```
    Returns the current % complete type for the project. This information is used to show % complete on the main bar. We have 3 types by only 1 type can be used when rendering % complete.
    
    Returns:
  - getProjectPercentComplete
```
int getProjectPercentComplete(IMXGanttModel.PercentCompleteType pcType)
```
    Returns:
  - setProjectPercentComplete
```
void setProjectPercentComplete(IMXGanttModel.PercentCompleteType pcType,
                               int val)
```
  - getDisplayRowCount
```
int getDisplayRowCount()
```
    Returns the rows in the Schedule are being displayed. In the case of server side filtered models, this value would changed to reflect the rows in the schedule.
    
    Returns:
  - isPagingModel
```
boolean isPagingModel()
```
    Return true if the model is a paging model
    
    Returns:
  - getPages
```
int getPages()
```
    if a Paging Model, then return the number of pages, otherwise, return 1.
    
    Returns:
  - getPageSize
```
int getPageSize()
```
    if a Paging Model, then return the number of rows in a page, other wise return total rows in the schedule
    
    Returns:
  - getUserLocale
```
java.util.Locale getUserLocale()
```
  - getUserULocale
```
com.ibm.icu.util.ULocale getUserULocale()
```
  - getUserTimezone
```
java.util.TimeZone getUserTimezone()
```
  - setComplianceEnabled
```
void setComplianceEnabled(boolean val)
```
  - isComplianceEnabled
```
boolean isComplianceEnabled()
```
  - getSkdActionInfo
```
java.util.HashMap getSkdActionInfo()
```
  - getActivityForId
```
IMXActivity getActivityForId(java.lang.String id)
```
  - getResourceForId
```
IMXResource getResourceForId(java.lang.String id)
```
  - getProjectStartOffsetDays
```
int getProjectStartOffsetDays()
```
  - getProjectEndOffsetDays
```
int getProjectEndOffsetDays()
```
  - setProjectStartOffsetDays
```
void setProjectStartOffsetDays(int projectStartOffsetDays)
```
  - setProjectEndOffsetDays
```
void setProjectEndOffsetDays(int projectEndOffsetDays)
```
  - iterateConstraintsFromActivity
```
java.util.Iterator iterateConstraintsFromActivity(IMXActivity activity)
```
  - newConstraintFromActivity
```
void newConstraintFromActivity(java.lang.Object projectMbo,
                               IMXActivity activity,
                               java.sql.ResultSet resultSet)
```
  - getChildNodeCount
```
int getChildNodeCount(IMXActivity activity)
```
  - getChildNode
```
IMXActivity getChildNode(IMXActivity activity,
                         int index)
```
  - getRootNode
```
IMXActivity getRootNode()
```

getShifts

getShiftWorkTime

getMergedWorkPeriods

getShiftCalendarInfo

getWorkHourList

getUserData

setUserData

getActualStartEnd

getProjectStartEnd

getCalendarStartEnd

getCalculatedProjectMinMax

reservationIteratorForResource

getMergedNonWorkPeriod

getGanttConfigInfo

containsActivity

getParentForActivity

getCalendarBreakPatternMap

getWorkPeriodPatternDaySeq

getCalendarBreakPatternCount

getLocalizedScenarioFieldTitle

getScenarioName

getProjectId

getProjectName

getProjectDescription

isAlternateAvailEnabled

isAllowPastLoadEnabled

getResourceDisplay

getWeekDay

setUseWith

setProjectType

setShowMaintOperFlag

setAssetLocWorkHourList

setAssetLocNonWorkHourList

setAssetLocOverlapMap

setMergedNonWorkPeriod

setMergedWorkPeriod

setWorkHourList

setCalendarBreakPatternMap

setCalendarBreakPatternCount

setWorkPeriodPatternDaySeq

getPercentCompleteType

getProjectPercentComplete

setProjectPercentComplete

getDisplayRowCount

isPagingModel

getPages

getPageSize

getUserLocale

getUserULocale

getUserTimezone

setComplianceEnabled

isComplianceEnabled

getSkdActionInfo

getActivityForId

getResourceForId

getProjectStartOffsetDays

getProjectEndOffsetDays

setProjectStartOffsetDays

setProjectEndOffsetDays

iterateConstraintsFromActivity

newConstraintFromActivity

getChildNodeCount

getChildNode

getRootNode