|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDirModelRO
This model contains data for both the Browse and Edit Modes of the Directory. The folder and document queries are cached in the model.
Method Summary | |
---|---|
boolean |
ABOJobIDsToDisplay()
This method returns whether or not there are any job IDs to display. |
boolean |
CheckFoldersForDelete()
|
boolean |
CheckForActivityRight(int nActivityRight)
|
int[] |
GetABOJobIDs()
This method returns the job IDs for the last ABO deletes, and then clears them. |
XPSortedDictionary |
GetBasicCardProperties()
|
IASQueryResult |
GetBreadCrumbPath()
|
int |
GetBrowseBy()
|
int |
GetBrowseBySource()
|
int |
GetCardID()
|
XPSortedDictionary |
GetCardInformation()
|
java.lang.String |
GetCardName()
|
java.lang.String |
GetCardName(int nCardID)
|
int[] |
GetCardRange()
|
int |
GetCardRangeBegin()
|
int |
GetCardSubmitDataSource()
|
int |
GetCardSubmitError()
Retrieve any errors generated during card submission using the REST API. |
int |
GetCardSubmitFolder()
|
int |
GetCardSubmitMode()
|
java.lang.String |
GetCardSubmitURL(boolean bIsWebDataSource)
|
int |
GetClassID()
|
java.lang.String |
GetCopyTargetFolderTREESUBSPACE()
|
int |
GetCreatedFolderID()
|
XPSortedDictionary |
GetCustomCardProperties()
|
XPArrayList |
GetCustomFields(int _nObjectIndex,
XPArrayList xpCustomProps,
XPLocale xpLocale,
XPTimeZone xpTimeZone)
Returns an array list of the values for each custom property in xpCustomProps for the document in index _nObjectIndex. |
java.lang.String |
GetDataSourceName(int nDataSourceID)
returns the name of a given datasource. |
java.lang.String |
GetDataSourceTREESUBSPACE()
|
int |
GetDirectoryMode()
Gets the current directory mode - Browse or Edit |
java.lang.String |
GetDocDescriptionType()
|
int |
GetDocumentTypeId()
|
IASQueryResult |
GetFilteredDataSources()
returns a list of data sources that support Card Submission |
java.lang.String |
GetFolderDescriptionType()
|
java.lang.String |
GetFolderName(int nFolderID)
|
java.lang.String |
GetFolderPath(int nFolderID)
|
int |
GetFolderSearchMapping(int nUnmappedIndex)
Retrieves the index within the SearchResponse that corresponds to the ordering that would have been returned from IPTCatalog.QuerySubfolders() |
IPTSearchResponse |
GetFolderSearchResponse()
Get an IPTSearchResponse containing all of the subfolders of the current folder. |
IXPList |
GetHeaderProperties()
Retrieves the headers to be displayed in a array that includes the header's name, property Id, and sort URL if applicaple. |
int |
GetMoreFolderID()
|
java.lang.Object[][] |
GetMoreRelatedResources(int nRelatedResourceID)
|
java.lang.String |
GetMoveTargetFolderTREESUBSPACE()
|
int |
GetNumDocsPerPage()
|
int |
GetNumFolderColumns()
|
int |
GetNumSubSubFolders()
|
java.lang.String |
GetObjectBannerText()
this creates a string with the banner sub-header text. |
int |
GetObjectID()
|
XPDateTime |
GetObjectNewTagDate()
|
XPDateTime |
GetObjectUpdateTagDate()
|
java.lang.String |
GetObjectUUID()
|
int |
GetParentDefaultDataSourceIDRecursive()
returns the ID of the Default DataSource for this folder. |
XPArrayList |
GetPropColumns()
|
IASQueryResult |
GetRelatedResource(int nRelatedResourceID)
|
int[] |
GetRelatedResourceIDs()
|
int |
GetRelatedResourcesLocation()
|
java.lang.String |
GetRelatedResourceString(int nRelatedResourceID)
|
int |
GetRRCategory()
|
int |
GetRRObjectID()
|
IPTSession |
GetSession()
|
int |
GetSubPortalAccessType()
|
int |
GetTotalResults()
|
java.lang.String |
GetUploadWSURL(int _nDataSourceID)
Returns the webservice's upload url if it supports uploads and it is set. |
XPLocale |
GetUserPrefLocale()
|
boolean |
GetUserPrefOpenDocInNewWindow()
|
XPTimeZone |
GetUserPrefTimeZone()
|
SearchExecutionWarning |
GetWarning()
return a warning from the last search query(used in browse by search) |
boolean |
HasAccessToApproveCardInFolder()
|
boolean |
HasAccessToEditCard()
|
boolean |
HasAccessToEditFolder()
|
boolean |
HasSelfSelectExpertRightOnThisFolder()
|
boolean |
InUnclassifiedCardsFolder()
|
boolean |
IsAtMaxFolderLevel()
This method returns whether or not the current folder is at the max level |
boolean |
IsRelatedExpert()
|
boolean |
IsValidSimpleSubmitSource(int _nDataSourceID)
|
boolean |
IsWebDataSource(int nDataSourceID)
|
int |
RefreshItemFromCopyTargetFolderTree()
returns the currently selected Copy TargetFolder ID |
int |
RefreshItemFromDataSourceTree()
returns the currently selected DataSource ID |
int |
RefreshItemFromMoveTargetFolderTree()
returns the currently selected Move TargetFolder ID |
boolean |
RetrieveSubFoldersThroughSearch()
This method returns whether or not subfolders queries are performed through search |
boolean |
ShowFolderActionBanner()
|
boolean |
ShowRelatedResources()
|
boolean |
SupportsUpload(int _nDataSourceID)
Returns true if the specified data source supports remote document upload. |
Methods inherited from interface com.plumtree.portalpages.common.folder.IFolderModel |
---|
OpenSubFolder, SetFirstItemIndex, SetLastItemIndex |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData, Init |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject |
---|
GetName |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IManagedObject |
---|
Create |
Methods inherited from interface com.plumtree.portalpages.common.folder.IFolderModelRO |
---|
GetCurrentFolderID, GetCurrentFolderLevel, GetCurrentFolderName, GetFirstFolderIndex, GetFolderColumnCount, GetFolderObjectCount, GetFolderQueryResult, GetFolderViewHelper, GetIsFolderSelected, GetLastFolderIndex, GetNumSubSubFoldersToDisplay, GetParentFolderID, GetParentFolderIDs, GetPath, GetShowCheckbox, GetShowFolderBanner, GetSubFolderCount, GetSubFolderCount, InRootFolder |
Methods inherited from interface com.plumtree.portalpages.common.objects.IObjectModelRO |
---|
DoNotShowObject, GetDisplayPaginationHiddenInputs, GetDisplaySortHiddenInputs, GetHeaderCount, GetHeaderHasCheckbox, GetHeaderRow, GetHeaderText, GetIsCollapsable, GetIsObjectSelected, GetObjectBannerTitle, GetObjectColumnCount, GetObjectCount, GetObjectFields, GetObjectSubType, GetObjectType, GetObjectViewIsCollapsed, GetShowPagination, GetSortable, GetSpaceID, ShowObjectBanner |
Method Detail |
---|
boolean ABOJobIDsToDisplay()
boolean CheckFoldersForDelete()
SearchExecutionWarning GetWarning()
boolean CheckForActivityRight(int nActivityRight)
nActivityRight
-
int[] GetABOJobIDs()
XPSortedDictionary GetBasicCardProperties()
int GetBrowseBy()
int GetBrowseBySource()
int GetCardID()
XPSortedDictionary GetCardInformation()
java.lang.String GetCardName()
java.lang.String GetCardName(int nCardID)
nCardID
-
int GetCardRangeBegin()
int[] GetCardRange()
int GetCardSubmitDataSource()
java.lang.String GetCardSubmitURL(boolean bIsWebDataSource)
bIsWebDataSource
-
int GetCardSubmitFolder()
int GetCardSubmitError()
java.lang.String GetCopyTargetFolderTREESUBSPACE()
int GetCreatedFolderID()
XPSortedDictionary GetCustomCardProperties()
java.lang.String GetDataSourceName(int nDataSourceID)
java.lang.String GetDataSourceTREESUBSPACE()
int GetDirectoryMode()
java.lang.String GetDocDescriptionType()
IASQueryResult GetFilteredDataSources()
java.lang.String GetFolderDescriptionType()
java.lang.String GetFolderName(int nFolderID)
nFolderID
-
java.lang.String GetFolderPath(int nFolderID)
nFolderID
-
int GetMoreFolderID()
java.lang.Object[][] GetMoreRelatedResources(int nRelatedResourceID)
nRelatedResourceID
-
java.lang.String GetMoveTargetFolderTREESUBSPACE()
int GetNumDocsPerPage()
int GetNumFolderColumns()
int GetNumSubSubFolders()
java.lang.String GetObjectBannerText()
int GetParentDefaultDataSourceIDRecursive()
XPArrayList GetPropColumns()
int GetRRCategory()
int GetRRObjectID()
IASQueryResult GetRelatedResource(int nRelatedResourceID)
nRelatedResourceID
-
int[] GetRelatedResourceIDs()
java.lang.String GetRelatedResourceString(int nRelatedResourceID)
nRelatedResourceID
-
int GetRelatedResourcesLocation()
int GetTotalResults()
boolean HasAccessToEditCard()
boolean HasAccessToEditFolder()
boolean HasSelfSelectExpertRightOnThisFolder()
int GetSubPortalAccessType()
boolean InUnclassifiedCardsFolder()
boolean IsAtMaxFolderLevel()
boolean IsRelatedExpert()
boolean IsWebDataSource(int nDataSourceID)
nDataSourceID
-
int RefreshItemFromCopyTargetFolderTree()
int RefreshItemFromDataSourceTree()
int RefreshItemFromMoveTargetFolderTree()
boolean ShowFolderActionBanner()
boolean ShowRelatedResources()
XPDateTime GetObjectNewTagDate()
XPDateTime GetObjectUpdateTagDate()
IPTSession GetSession()
boolean GetUserPrefOpenDocInNewWindow()
XPLocale GetUserPrefLocale()
XPTimeZone GetUserPrefTimeZone()
int GetCardSubmitMode()
boolean HasAccessToApproveCardInFolder()
IASQueryResult GetBreadCrumbPath()
boolean IsValidSimpleSubmitSource(int _nDataSourceID)
boolean SupportsUpload(int _nDataSourceID)
java.lang.String GetUploadWSURL(int _nDataSourceID)
boolean RetrieveSubFoldersThroughSearch()
IPTSearchResponse GetFolderSearchResponse()
int GetFolderSearchMapping(int nUnmappedIndex)
IXPList GetHeaderProperties()
XPArrayList GetCustomFields(int _nObjectIndex, XPArrayList xpCustomProps, XPLocale xpLocale, XPTimeZone xpTimeZone)
_nObjectIndex
- xpCustomProps
- xpLocale
- xpTimeZone
-
int GetClassID()
int GetObjectID()
java.lang.String GetObjectUUID()
int GetDocumentTypeId()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |