|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.plumtree.uiinfrastructure.editor.EditorModel
com.plumtree.uiinfrastructure.approval.AApprovalModel
public abstract class AApprovalModel
| Field Summary |
|---|
| Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel |
|---|
m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType |
| Constructor Summary | |
|---|---|
AApprovalModel()
|
|
| Method Summary | |
|---|---|
abstract boolean |
AddColumnsHeaderForEachItem()
|
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
void |
ClearCache()
|
void |
ClearCache(ApprovalItemType type)
|
abstract boolean |
DisplayDescriptionImmediatelyUnderTitle()
|
boolean |
DisplayItemComment()
|
abstract boolean |
DisplayItemTypeHeaderAboveActionbar()
|
boolean |
DisplayViewItems()
|
boolean |
DoSortDate()
|
boolean |
DoSortName()
|
boolean |
DoSortSubmittedBy()
|
boolean |
GetAddComment()
|
IXPEnumerator |
GetAllCachedItems()
|
abstract boolean |
GetAllowClearingOfApprovalRequests()
|
abstract boolean |
GetAllowClearingOfItem(AItemDescriptor item)
|
int |
GetCurrentPageIndex(ApprovalItemType type)
Call this method to obtain the index of the page being viewed for the given ApprovalItemType |
ApprovalItemType |
GetCurrentType()
Call this method to obtain the ApprovalItemType currently being viewed. |
abstract ApprovalItemType |
GetDefaultItemType()
Call this method to determine the default ApprovalItemType displayed by the view. |
abstract boolean |
GetDisableRadioSelection()
|
abstract boolean |
GetDisplayHeadersForItemTypesWithNoItems()
|
abstract boolean |
GetDisplayInstances(ApprovalItemType type)
Concrete subclasses must implement this method to return a boolean value indicating whether instance information is displayed for the specified type. |
abstract boolean |
GetDisplaySelectAllButton()
|
abstract boolean |
GetDisplayStatusColumn()
|
abstract boolean |
GetDisplayTypeHeader(ApprovalItemType type)
Concrete subclasses must implement this method to return a boolean indicating whether or not a header banner should be displayed for the specified type. |
abstract java.lang.String |
GetEmptyTypeSectionSubTitle(ApprovalItemType type)
Concrete subclasses must implement this method to return a string that is displayed in sections containg no items awaiting approval. |
int |
GetHighItemIndexForCurrentPage(ApprovalItemType type)
Call this method to obtain the index of the last item on the current page for a specific ApprovalItemType. |
int |
GetHighItemIndexForGivenPage(int iPageIndex,
ApprovalItemType type)
|
AItemDescriptor |
GetItemDescriptor(java.lang.String sID)
Call this method to obtain a specific AItemDescriptor object. |
IXPEnumerator |
GetItemDescriptors(ApprovalItemType type)
Call this method to obtain an enumeration of AItemDescriptor objects. |
java.lang.String |
GetItemID()
|
int |
GetLowItemIndexForCurrentPage(ApprovalItemType type)
Call this method to obtain the index of the first item on the current page for a specific ApprovalItemType. |
int |
GetLowItemIndexForGivenPage(int iPageIndex,
ApprovalItemType type)
|
abstract java.lang.String |
GetName()
Concrete subclasses must implement this method to return the name of the model. |
java.lang.String |
GetNoItemsDescription()
|
int |
GetNumPagesAvailable(ApprovalItemType type)
|
int |
GetPageSize()
Get the size of a page. |
abstract java.lang.String |
GetSubTitle()
Concrete subclasses must implement this method to return the subtitle. |
abstract XPArrayList |
GetSupportedItemTypes()
Concrete subclasses must implement this method to return an XPArrayList of those ItemTypes that are supporeted by the model. |
abstract java.lang.String |
GetTitle()
Concrete subclasses must implement this method to return the title. |
int |
GetTypeCount(ApprovalItemType type)
Call this method to obtain the count of items awaiting approval of the specified type. |
void |
GotoPage(ApprovalItemType type,
int iPageNumber)
|
abstract XPArrayList |
InternalGetItemDescriptors(ApprovalItemType type,
int iLow,
int iHigh)
Concrete subclasses must implement this method to return an XPArrayList of AItemDescriptor objects. |
abstract int |
InternalGetTypeCount(ApprovalItemType type)
Concrete subclasses must implement this method to return the count of specified ApprovalItemType. |
abstract boolean |
IsDateSortable()
|
abstract boolean |
IsDescriptionEditable()
|
abstract boolean |
IsNameSortable()
|
boolean |
IsNextPageAvailable(ApprovalItemType type)
Call this method to determine if there is another page of items of a given type. |
boolean |
IsPageAvailable(ApprovalItemType type,
int iPageNumber)
|
boolean |
IsPreviousPageAvailable(ApprovalItemType type)
Call this method to determine if there is a previous page of items of a given type. |
abstract boolean |
IsSubmittedBySortable()
|
abstract boolean |
IsTitleEditable()
|
void |
NextPage(ApprovalItemType type)
Call this method to move the view to the next page of items of the specified type. |
void |
PreviousPage(ApprovalItemType type)
Call this method to move the view to the previous page of items of the specified type. |
void |
SetAddComment(boolean b)
|
void |
SetCurrentPageIndex(ApprovalItemType type,
int i)
Call this method to set the index of the page being viewed of the given ApprovalItemType. |
void |
SetCurrentType(ApprovalItemType type)
Call this method to set the type currently being viewed. |
void |
SetDoSortDate(boolean b)
|
void |
SetDoSortName(boolean b)
|
void |
SetDoSortSubmittedBy(boolean b)
|
void |
SetItemID(java.lang.String s)
|
void |
SetNoItemsDescription(java.lang.String s)
|
void |
SetPageHighIndex(int _index)
set the size of a page. |
void |
SetPageLowIndex(int _index)
set the low item index of a page. |
| Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel |
|---|
Cancel, CheckEditorAccessAndStart, CleanupAllData, Create, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnComeBackFromSubEditor, DoTaskOnStartEditor, Finish, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, Init, SavePage, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
|---|
CleanupAllData, Init |
| Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject |
|---|
Create |
| Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO |
|---|
GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly |
| Constructor Detail |
|---|
public AApprovalModel()
| Method Detail |
|---|
public void SetNoItemsDescription(java.lang.String s)
public java.lang.String GetNoItemsDescription()
GetNoItemsDescription in interface IApprovalModelROpublic abstract boolean AddColumnsHeaderForEachItem()
AddColumnsHeaderForEachItem in interface IApprovalModelROpublic void CleanupTempData()
IModel
CleanupTempData in interface IModelCleanupTempData in class EditorModelIModel.CleanupTempData()public abstract boolean DisplayDescriptionImmediatelyUnderTitle()
DisplayDescriptionImmediatelyUnderTitle in interface IApprovalModelROpublic boolean DoSortDate()
public boolean DoSortName()
public boolean DoSortSubmittedBy()
DoSortSubmittedBy in interface IApprovalModelROpublic boolean GetAddComment()
GetAddComment in interface IApprovalModelROpublic boolean DisplayItemComment()
DisplayItemComment in interface IApprovalModelROpublic boolean DisplayViewItems()
DisplayViewItems in interface IApprovalModelROpublic abstract boolean GetAllowClearingOfApprovalRequests()
GetAllowClearingOfApprovalRequests in interface IApprovalModelROpublic abstract boolean GetAllowClearingOfItem(AItemDescriptor item)
GetAllowClearingOfItem in interface IApprovalModelROitem -
public int GetCurrentPageIndex(ApprovalItemType type)
GetCurrentPageIndex in interface IApprovalModelROtype - ApprovalItemType
public ApprovalItemType GetCurrentType()
public abstract ApprovalItemType GetDefaultItemType()
GetDefaultItemType in interface IApprovalModelROpublic abstract boolean GetDisableRadioSelection()
GetDisableRadioSelection in interface IApprovalModelROpublic abstract boolean DisplayItemTypeHeaderAboveActionbar()
DisplayItemTypeHeaderAboveActionbar in interface IApprovalModelROpublic abstract boolean GetDisplayHeadersForItemTypesWithNoItems()
GetDisplayHeadersForItemTypesWithNoItems in interface IApprovalModelROpublic abstract boolean GetDisplayInstances(ApprovalItemType type)
GetDisplayInstances in interface IApprovalModelROtype - ApprovalItemType
public abstract boolean GetDisplayTypeHeader(ApprovalItemType type)
GetDisplayTypeHeader in interface IApprovalModelROtype - ApprovalItemType
public abstract java.lang.String GetEmptyTypeSectionSubTitle(ApprovalItemType type)
GetEmptyTypeSectionSubTitle in interface IApprovalModelROtype - ApprovalItemType
public int GetHighItemIndexForCurrentPage(ApprovalItemType type)
GetHighItemIndexForCurrentPage in interface IApprovalModelROtype - ApprovalItemType
public int GetHighItemIndexForGivenPage(int iPageIndex,
ApprovalItemType type)
GetHighItemIndexForGivenPage in interface IApprovalModelROiPageIndex - type -
public java.lang.String GetItemID()
GetItemID in interface IApprovalModelROpublic int GetLowItemIndexForCurrentPage(ApprovalItemType type)
GetLowItemIndexForCurrentPage in interface IApprovalModelROtype - ApprovalItemType
public int GetLowItemIndexForGivenPage(int iPageIndex,
ApprovalItemType type)
GetLowItemIndexForGivenPage in interface IApprovalModelROiPageIndex - type -
public abstract java.lang.String GetName()
GetName in interface IMVCObjectGetName in class EditorModelpublic int GetNumPagesAvailable(ApprovalItemType type)
GetNumPagesAvailable in interface IApprovalModelROtype -
public int GetPageSize()
public void SetPageHighIndex(int _index)
public void SetPageLowIndex(int _index)
public abstract java.lang.String GetSubTitle()
GetSubTitle in interface IApprovalModelROpublic abstract XPArrayList GetSupportedItemTypes()
GetSupportedItemTypes in interface IApprovalModelROpublic abstract java.lang.String GetTitle()
GetTitle in interface IApprovalModelRO
public void GotoPage(ApprovalItemType type,
int iPageNumber)
type - iPageNumber -
public abstract XPArrayList InternalGetItemDescriptors(ApprovalItemType type,
int iLow,
int iHigh)
type - ApprovalItemType
public abstract int InternalGetTypeCount(ApprovalItemType type)
type - ApprovalItemType
public abstract boolean IsDateSortable()
IsDateSortable in interface IApprovalModelROpublic abstract boolean IsDescriptionEditable()
IsDescriptionEditable in interface IApprovalModelROpublic abstract boolean IsNameSortable()
IsNameSortable in interface IApprovalModelROpublic boolean IsNextPageAvailable(ApprovalItemType type)
IsNextPageAvailable in interface IApprovalModelROtype - Pass the ApprovalItemType
public boolean IsPageAvailable(ApprovalItemType type,
int iPageNumber)
type - iPageNumber -
public boolean IsPreviousPageAvailable(ApprovalItemType type)
IsPreviousPageAvailable in interface IApprovalModelROtype - Pass the ApprovalItemType
public abstract boolean IsSubmittedBySortable()
IsSubmittedBySortable in interface IApprovalModelROpublic abstract boolean IsTitleEditable()
IsTitleEditable in interface IApprovalModelROpublic void ClearCache()
public void ClearCache(ApprovalItemType type)
type - public IXPEnumerator GetAllCachedItems()
public abstract boolean GetDisplayStatusColumn()
GetDisplayStatusColumn in interface IApprovalModelROpublic abstract boolean GetDisplaySelectAllButton()
GetDisplaySelectAllButton in interface IApprovalModelROpublic AItemDescriptor GetItemDescriptor(java.lang.String sID)
type - ApprovalItemTypesID - String id of the specific AItemDescriptor wanted.
public IXPEnumerator GetItemDescriptors(ApprovalItemType type)
GetItemDescriptors in interface IApprovalModelROtype - ApprovalItemType
public int GetTypeCount(ApprovalItemType type)
GetTypeCount in interface IApprovalModelROtype - ApprovalItemType
public void NextPage(ApprovalItemType type)
type - ApprovalItemTypepublic void PreviousPage(ApprovalItemType type)
type - ApprovalItemTypepublic void SetAddComment(boolean b)
b - public void SetCurrentType(ApprovalItemType type)
type - ApprovalItemTypepublic void SetDoSortDate(boolean b)
b - public void SetDoSortName(boolean b)
b - public void SetDoSortSubmittedBy(boolean b)
b - public void SetItemID(java.lang.String s)
s -
public void SetCurrentPageIndex(ApprovalItemType type,
int i)
type - ApprovalItemTypei - int
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||