com.plumtree.portalpages.browsing.directory
Interface IDirModelRO

All Superinterfaces:

IFolderModel, IFolderModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IObjectModelRO

All Known Subinterfaces:

IDirModel

All Known Implementing Classes:

DirModel

public interface IDirModelRO
extends IModelRO, IFolderModel, IFolderModelRO, IObjectModelRO

This model contains data for both the Browse and Edit Modes of the Directory. The folder and document queries are cached in the model.

Author:

StephenC

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.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

ABOJobIDsToDisplay

boolean ABOJobIDsToDisplay()

This method returns whether or not there are any job IDs to display.

Returns:

boolean true implies there are job ids to display.

CheckFoldersForDelete

boolean CheckFoldersForDelete()

Returns:

GetWarning

SearchExecutionWarning GetWarning()

return a warning from the last search query(used in browse by search)

CheckForActivityRight

boolean CheckForActivityRight(int nActivityRight)

Parameters:

nActivityRight -

Returns:

GetABOJobIDs

int[] GetABOJobIDs()

This method returns the job IDs for the last ABO deletes, and then clears them.

Returns:

int[] an array of job IDs for folder deletions.

GetBasicCardProperties

XPSortedDictionary GetBasicCardProperties()

Returns:

GetBrowseBy

int GetBrowseBy()

Returns:

GetBrowseBySource

int GetBrowseBySource()

Returns:

GetCardID

int GetCardID()

GetCardInformation

XPSortedDictionary GetCardInformation()

Returns:

GetCardName

java.lang.String GetCardName()

Returns:

GetCardName

java.lang.String GetCardName(int nCardID)

Parameters:

nCardID -

Returns:

GetCardRangeBegin

int GetCardRangeBegin()

GetCardRange

int[] GetCardRange()

GetCardSubmitDataSource

int GetCardSubmitDataSource()

Returns:

GetCardSubmitURL

java.lang.String GetCardSubmitURL(boolean bIsWebDataSource)

Parameters:

bIsWebDataSource -

Returns:

GetCardSubmitFolder

int GetCardSubmitFolder()

Returns:

the folder the card was submitted into (either the current folder, or the card submit override folder).

GetCardSubmitError

int GetCardSubmitError()

Retrieve any errors generated during card submission using the REST API.

Returns:

The error generated during card submission. -1 if there was no error.

GetCopyTargetFolderTREESUBSPACE

java.lang.String GetCopyTargetFolderTREESUBSPACE()

Returns:

GetCreatedFolderID

int GetCreatedFolderID()

Returns:

GetCustomCardProperties

XPSortedDictionary GetCustomCardProperties()

Returns:

GetDataSourceName

java.lang.String GetDataSourceName(int nDataSourceID)

returns the name of a given datasource.

GetDataSourceTREESUBSPACE

java.lang.String GetDataSourceTREESUBSPACE()

Returns:

GetDirectoryMode

int GetDirectoryMode()

Gets the current directory mode - Browse or Edit

Returns:

int Directory mode constant

GetDocDescriptionType

java.lang.String GetDocDescriptionType()

GetFilteredDataSources

IASQueryResult GetFilteredDataSources()

returns a list of data sources that support Card Submission

GetFolderDescriptionType

java.lang.String GetFolderDescriptionType()

Returns:

GetFolderName

java.lang.String GetFolderName(int nFolderID)

Parameters:

nFolderID -

Returns:

GetFolderPath

java.lang.String GetFolderPath(int nFolderID)

Parameters:

nFolderID -

Returns:

GetMoreFolderID

int GetMoreFolderID()

Returns:

GetMoreRelatedResources

java.lang.Object[][] GetMoreRelatedResources(int nRelatedResourceID)

Parameters:

nRelatedResourceID -

Returns:

GetMoveTargetFolderTREESUBSPACE

java.lang.String GetMoveTargetFolderTREESUBSPACE()

Returns:

GetNumDocsPerPage

int GetNumDocsPerPage()

Returns:

GetNumFolderColumns

int GetNumFolderColumns()

Returns:

GetNumSubSubFolders

int GetNumSubSubFolders()

Returns:

GetObjectBannerText

java.lang.String GetObjectBannerText()

this creates a string with the banner sub-header text.

GetParentDefaultDataSourceIDRecursive

int GetParentDefaultDataSourceIDRecursive()

returns the ID of the Default DataSource for this folder. It will recursively search up the ancestors to

GetPropColumns

XPArrayList GetPropColumns()

Returns:

GetRRCategory

int GetRRCategory()

Returns:

GetRRObjectID

int GetRRObjectID()

Returns:

GetRelatedResource

IASQueryResult GetRelatedResource(int nRelatedResourceID)

Parameters:

nRelatedResourceID -

Returns:

GetRelatedResourceIDs

int[] GetRelatedResourceIDs()

GetRelatedResourceString

java.lang.String GetRelatedResourceString(int nRelatedResourceID)

Parameters:

nRelatedResourceID -

Returns:

GetRelatedResourcesLocation

int GetRelatedResourcesLocation()

Returns:

GetTotalResults

int GetTotalResults()

Returns:

HasAccessToEditCard

boolean HasAccessToEditCard()

Returns:

HasAccessToEditFolder

boolean HasAccessToEditFolder()

Returns:

HasSelfSelectExpertRightOnThisFolder

boolean HasSelfSelectExpertRightOnThisFolder()

Returns:

GetSubPortalAccessType

int GetSubPortalAccessType()

Returns:

InUnclassifiedCardsFolder

boolean InUnclassifiedCardsFolder()

Returns:

IsAtMaxFolderLevel

boolean IsAtMaxFolderLevel()

This method returns whether or not the current folder is at the max level

Returns:

boolean

IsRelatedExpert

boolean IsRelatedExpert()

Returns:

IsWebDataSource

boolean IsWebDataSource(int nDataSourceID)

Parameters:

nDataSourceID -

Returns:

RefreshItemFromCopyTargetFolderTree

int RefreshItemFromCopyTargetFolderTree()

returns the currently selected Copy TargetFolder ID

RefreshItemFromDataSourceTree

int RefreshItemFromDataSourceTree()

returns the currently selected DataSource ID

RefreshItemFromMoveTargetFolderTree

int RefreshItemFromMoveTargetFolderTree()

returns the currently selected Move TargetFolder ID

ShowFolderActionBanner

boolean ShowFolderActionBanner()

Returns:

ShowRelatedResources

boolean ShowRelatedResources()

Returns:

GetObjectNewTagDate

XPDateTime GetObjectNewTagDate()

Returns:

GetObjectUpdateTagDate

XPDateTime GetObjectUpdateTagDate()

Returns:

GetSession

IPTSession GetSession()

Returns:

GetUserPrefOpenDocInNewWindow

boolean GetUserPrefOpenDocInNewWindow()

Returns:

GetUserPrefLocale

XPLocale GetUserPrefLocale()

Returns:

GetUserPrefTimeZone

XPTimeZone GetUserPrefTimeZone()

Returns:

GetCardSubmitMode

int GetCardSubmitMode()

Returns:

HasAccessToApproveCardInFolder

boolean HasAccessToApproveCardInFolder()

Returns:

GetBreadCrumbPath

IASQueryResult GetBreadCrumbPath()

Returns:

IsValidSimpleSubmitSource

boolean IsValidSimpleSubmitSource(int _nDataSourceID)

Returns:

boolean true if the specified data source is valid for simple submit (i.e. web, or remote document upload).

SupportsUpload

boolean SupportsUpload(int _nDataSourceID)

Returns true if the specified data source supports remote document upload.

Returns:

boolean

GetUploadWSURL

java.lang.String GetUploadWSURL(int _nDataSourceID)

Returns the webservice's upload url if it supports uploads and it is set.

Returns:

String

RetrieveSubFoldersThroughSearch

boolean RetrieveSubFoldersThroughSearch()

This method returns whether or not subfolders queries are performed through search

Returns:

boolean

GetFolderSearchResponse

IPTSearchResponse GetFolderSearchResponse()

Get an IPTSearchResponse containing all of the subfolders of the current folder.

GetFolderSearchMapping

int GetFolderSearchMapping(int nUnmappedIndex)

Retrieves the index within the SearchResponse that corresponds to the ordering that would have been returned from IPTCatalog.QuerySubfolders()

GetHeaderProperties

IXPList GetHeaderProperties()

Retrieves the headers to be displayed in a array that includes the header's name, property Id, and sort URL if applicaple.

Returns:

GetCustomFields

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.

Parameters:

_nObjectIndex -

xpCustomProps -

xpLocale -

xpTimeZone -

Returns:

GetClassID

int GetClassID()

Returns:

GetObjectID

int GetObjectID()

Returns:

GetObjectUUID

java.lang.String GetObjectUUID()

Returns:

GetDocumentTypeId

int GetDocumentTypeId()

Returns: