|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.activityspace.AClearModel com.plumtree.portalpages.browsing.directory.DirModel
public class DirModel
This model contains data for both the Browse and Edit Modes of the Directory.
Field Summary | |
---|---|
static int |
BEGIN_INDEX
index for object range array returned via GetObjectRange() |
static int |
CARD_CNT
|
static java.lang.String |
CHINESE_LANGUAGE_CODE
|
static java.lang.String |
CHINESE_LOCALE_CODE_CN
|
static java.lang.String |
CHINESE_LOCALE_CODE_HK
|
static java.lang.String |
CHINESE_LOCALE_CODE_MO
|
static java.lang.String |
CHINESE_LOCALE_CODE_SG
|
static java.lang.String |
CHINESE_LOCALE_CODE_TW
|
static java.lang.String |
DEFAULTDATA
|
static int |
END_INDEX
|
static java.lang.String |
ENGLISH_LOCALE_CODE
|
static int |
HEADER_ID_INDEX
|
static int |
HEADER_NAME_INDEX
|
static int |
HEADER_PROPERTIES_SIZE
|
static int |
HEADER_SORT_URL_INDEX
|
static java.lang.String |
HTTP_PREFIX
|
boolean |
m_bOpenDocInNewWindow
User Pref settings |
int |
m_nCurrentCardID
For Card Properties |
int |
m_nCurrentFolderID
|
protected int |
m_nDirMode
Directory mode - Browse, Edit, Disability |
int |
m_nLoadedCardID
For Advanced Card Submission to prevent Card Confirmation page from being displayed more than once if the page is refreshed. |
int |
m_nNumFoldCol
Settable Dir Pref |
int |
m_nRangeBegin
Document Range |
int |
m_nRangeEnd
|
XPDateTime |
m_xpNewTagDate
New Document Date |
XPArrayList |
m_xpPropColumns
Sorting Columns |
XPDateTime |
m_xpUpdateTagDate
Updated Document Date |
static java.lang.String |
STR_MVC_CLASS_NAME
Activity space name |
static java.lang.String |
strCopyTargetFolderTREESUBSPACE
|
static java.lang.String |
strDataSourceTREESUBSPACE
|
static java.lang.String |
strMoveTargetFolderTREESUBSPACE
|
static int |
TOTAL_CNT_INDEX
|
Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel |
---|
m_asOwner |
Constructor Summary | |
---|---|
DirModel()
|
Method Summary | |
---|---|
void |
ABODeleteFolders(int[] arFolderIDs)
|
boolean |
ABOJobIDsToDisplay()
This method returns whether or not there are any job IDs to display. |
void |
AddRemoveObjectTag(java.lang.String tagname,
java.lang.String strid,
int action,
java.lang.String ptsource)
Adds/Removes Tag specified for the Object with given ID based on Action specified. |
void |
AddSelfSelectedRelatedExpert()
|
int[] |
CalculateReportMapping(IPTSearchResponse ptSR,
int nCurrentLevel)
Generates a mapping to an array that mimics what is returned by IPTFolder.QuerySubFolders() |
boolean |
CheckFoldersForDelete()
|
boolean |
CheckForActivityRight(int nActivityRight)
|
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
void |
ClearCardRange()
|
void |
CopyCards(int[] arCardIDs,
int nTargetFolder)
|
void |
CopyFolders(int[] arFolderIDs,
int nTargetFolder)
|
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
IXPPropertyBag |
CreateCardSubmitUploadPropertyBag(java.lang.String _path,
java.lang.String _type,
java.lang.String _docID)
|
void |
CreateDirectoryFolder(java.lang.String strName,
java.lang.String strDescription)
Creates a Directory Folder and calls the PEIs OnBeforeCreateDirectoryFolder and OnAfterCreateDirectoryFolder. |
IPTFilter |
CreateSubFolderSearchFilter(int nCurrentLevel)
|
void |
DeleteCards(int[] arCardIDs)
|
void |
DeleteFolders(int[] arFolderIDs)
|
void |
doApproval(int[] arCardIDs,
int nAction)
|
boolean |
doesPropertyDescribeCard(java.lang.Object[] arCardPropIDs,
int nPropID)
|
boolean |
DoNotShowObject(int nIndex)
Get whether to show this object or not. |
void |
Finish()
Implement some code to execute when the user clicks on "Finish". |
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()
Returns an array with 4 int, [0] start of range, [1] end of range, [2] card count, [3] total count |
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()
|
int |
GetCurrentFolderID()
Get the id of the current folder. |
int |
GetCurrentFolderLevel()
Get the level of the current folder |
java.lang.String |
GetCurrentFolderName()
Get the name of the current folder. |
int |
GetCurrentLowerObjectIndex()
|
int |
GetCurrentUpperObjectIndex()
|
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 |
GetDataSourceProviderName(int nDataSourceID)
|
java.lang.String |
GetDataSourceTREESUBSPACE()
|
int |
GetDirectoryMode()
Gets the current directory mode - Browse or Edit |
boolean |
GetDisplayPaginationHiddenInputs()
Get whether or not to display the hidden inputs needed by the PaginationControl. |
boolean |
GetDisplaySortHiddenInputs()
Get whether or not to display the hidden inputs needed by the SortControl. |
java.lang.String |
GetDocDescriptionType()
|
int |
GetDocumentTypeId()
|
IASQueryResult |
GetFilteredDataSources()
returns a list of data sources that support Card Submission |
int |
GetFirstFolderIndex()
Get the index of the first folder to display. |
int |
GetFolderColumnCount()
Get the number of columns to display. |
java.lang.String |
GetFolderDescriptionType()
|
java.lang.String |
GetFolderName(int nFolderID)
|
IASQueryResult |
GetFolderObjectCount()
Get a list of object names and the number of those objects in the current folder. |
java.lang.String |
GetFolderPath(int nFolderID)
|
IASQueryResult |
GetFolderQueryResult()
Get an IPTQueryResult containing all of the subfolders of the current folder. |
int |
GetFolderSearchMapping(int nIndex)
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. |
IFolderViewHelper |
GetFolderViewHelper()
Retrieves the folder view helper. |
int |
GetHeaderCount()
Gets the count of the object headers. |
boolean |
GetHeaderHasCheckbox()
Returns whether the header has a checkbox or not. |
IXPList |
GetHeaderProperties()
Retrieves the headers to be displayed in a array that includes the header's name, property Id, and sort URL if applicaple. |
HTMLTableRow |
GetHeaderRow()
Returns the header row |
java.lang.String |
GetHeaderText(int nHeaderIndex)
Gets the text of the header at the given index. |
boolean |
GetIsCollapsable()
Gets whether or not the object banner should be collapsable. |
boolean |
GetIsFolderSelected(int nFolderID)
This method returns whether or not the requested folder is currently selected. |
boolean |
GetIsObjectSelected(int nObjectID)
This method returns whether or not the requested object ID is currently selected. |
int |
GetLastFolderIndex()
Get the index of the first folder to display. |
int |
GetLoadedCardID()
|
int |
GetMoreFolderID()
|
java.lang.Object[][] |
GetMoreRelatedResources(int nRelatedResourceID)
|
java.lang.String |
GetMoveTargetFolderTREESUBSPACE()
|
java.lang.String |
GetName()
Return the name of the MVC object. |
java.lang.Object |
GetNewTempData()
This method returns a new temporary data object. |
int |
GetNumDocsPerPage()
|
int |
GetNumFolderColumns()
|
int |
GetNumObjects()
|
int |
GetNumSubSubFolders()
|
int |
GetNumSubSubFoldersToDisplay()
Set the number of sub-subfolders to display after the next page.. |
java.lang.String |
GetObjectBannerText()
this creates a string with the banner sub-header text. |
java.lang.String |
GetObjectBannerTitle()
Gets the name of the current folder. |
int |
GetObjectColumnCount()
Gets the number of columns of objects |
int |
GetObjectCount()
Gets the count of the objects in the query result. |
java.lang.Object |
GetObjectFields(int nIndex,
int nPropID)
Gets the fields from the query result. |
int |
GetObjectID()
|
XPDateTime |
GetObjectNewTagDate()
|
int |
GetObjectSubType(int nIndex)
Get the subtype of the object at the given index. |
IXPList |
GetObjectTags(int docId)
Gets the List of Tags of that are attached to this Object by pathways. |
int |
GetObjectType()
Get the Object Class ID of the type of objects we are currently viewing. |
XPDateTime |
GetObjectUpdateTagDate()
|
java.lang.String |
GetObjectUUID()
|
boolean |
GetObjectViewIsCollapsed()
Get whether the object view is collapsed. |
int |
GetParentDefaultDataSourceIDRecursive()
returns the ID of the Default DataSource for this folder. |
int |
GetParentFolderID()
Get the ID of the parent folder of the current folder. |
java.lang.Object[] |
GetParentFolderIDs()
Get an Object array containing the Integer IDs of all the parent folders (the path) of the current folder. |
java.lang.String |
GetPath()
Get the path to the current folder concatenated with '\'. |
XPException |
GetPathwaysTaggingError()
This method returns an error that happened when Add/Remove/Rename Tag request is sent to pathways. |
XPArrayList |
GetPropColumns()
|
Redirect |
GetRedirectAfterFinish()
Returns the Redirect object (this is were we need to go at the end of the Editor). |
IASQueryResult |
GetRelatedResource(int lRelatedResourceID)
|
int[] |
GetRelatedResourceIDs()
|
int |
GetRelatedResourcesLocation()
|
java.lang.String |
GetRelatedResourceString(int nRelatedResourceID)
|
int |
GetRRCategory()
|
int |
GetRRObjectID()
|
IPTSession |
GetSession()
|
boolean |
GetShowCheckbox()
Returns whether the folders should have checkboxes next to them. |
boolean |
GetShowFolderBanner()
Returns whether the subfolder banner should be shown. |
boolean |
GetShowPagination()
Get whether these objects should use pagination or not. |
boolean |
GetSortable()
Get whether these objects are sortable or not. |
int |
GetSortDirection()
Get the sort direction for the currently sorted header column. |
int |
GetSortedHeader()
Get the column id of the header that is currently sorted (starting with 0). |
java.lang.String |
GetSpaceID()
Get the SpaceID of the parent Activity Space |
int |
GetSubFolderCount()
Get the number of folders at all levels in the hierachy |
int |
GetSubFolderCount(int nLevel)
Get the number of sub folders in the current folder at the specified level. |
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) |
int |
GetWebServiceID(int _nDataSourceID)
|
boolean |
HasAccessToApproveCardInFolder()
|
boolean |
HasAccessToEditCard()
|
boolean |
HasAccessToEditFolder()
|
boolean |
HasSelfSelectExpertRightOnThisFolder()
|
void |
Init(AActivitySpace parent)
This method initializes the model. |
boolean |
InRootFolder()
Returns true if the current folder is the root folder. |
boolean |
InUnclassifiedCardsFolder()
|
boolean |
IsAtMaxFolderLevel()
This method returns whether or not the current folder is at the max level |
boolean |
IsDateProperty(int nPropertyID)
|
boolean |
IsRelatedExpert()
|
boolean |
IsTaggingEnabled()
True if Pathways is enabled and user can tag items, else false. |
boolean |
IsValidSimpleSubmitSource(int _nDataSourceID)
|
boolean |
IsWebDataSource(int nDataSourceID)
Check if the provider for this data source supports web paths. |
void |
LoadBrowsingPropColumns()
|
void |
LoadCardProperties()
|
boolean |
LoadFoldersAndDocuments()
|
void |
LoadNewAndUpdatedDates()
|
void |
LoadUserPrefs()
|
void |
MigrateObjects(int nClassID,
int[] nObjects,
java.lang.String sComment)
This method adds objects into the migration queue. |
void |
MoveCards(int[] arCardIDs,
int nTargetFolder)
|
void |
MoveFolders(int[] arFolderIDs,
int nTargetFolder)
|
int |
OpenFolderByPath(java.lang.String strPath)
|
void |
OpenSubFolder(int ID)
Open the folder with the id ID. |
void |
RaiseError(java.lang.String strError)
Helper method to raise an error |
void |
RaiseError(java.lang.String strError,
java.lang.String strExtended)
Helper method to raise an error |
int |
RefreshItemFromCopyTargetFolderTree()
This method gets the selected items from the tree. |
int |
RefreshItemFromDataSourceTree()
This method gets the selected items from the tree. |
int |
RefreshItemFromMoveTargetFolderTree()
This method gets the selected items from the tree. |
void |
RenameObjectTag(java.lang.String tagname,
java.lang.String strid,
java.lang.String ptsource,
java.lang.String renametag)
Renames Tag specified for the Object with given ID. |
boolean |
RetrieveSubFoldersThroughSearch()
This method returns whether or not subfolders queries are performed through search |
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
IPTSearchResponse |
SearchSubFolders(int nFolderID,
int nCurrentLevel)
|
void |
SetCardID(int nCardID)
|
void |
SetCardRange(int nRangeBegin,
int nRangeEnd)
|
void |
SetCardSubmitDataSource(int nDataSourceID)
|
void |
SetCardSubmitDescription(java.lang.String strDescription)
|
void |
SetCardSubmitError(int _nErrorCode)
Sets the error associated with the card submit. |
void |
SetCardSubmitFolder(int _nFolderID)
Set the folder to use when submitting a document. |
void |
SetCardSubmitMode(int nCardID)
|
void |
SetCardSubmitName(java.lang.String strName)
|
void |
SetCardSubmitURL(java.lang.String strURL)
|
void |
SetDefaultCardRefreshSettings(int nCardID)
|
void |
SetDirectoryMode(int nMode)
Sets the Directory mode - Browse or Edit. |
void |
SetDocumentTypeId(java.lang.String documentTypeId)
|
void |
SetDocUploadParams(java.lang.String _duID,
java.lang.String _duServer)
|
void |
SetFirstItemIndex(int nFirstItemIndex)
Set the index of the first folder to display on a page. |
void |
SetFolderIDAndMode(int ID,
int nMode)
Opens the requested subfolder and sets the mode as appropriate. |
void |
SetFoldersForDeleteCheck(boolean bFolders)
|
void |
SetLastItemIndex(int nLastItemIndex)
Set the index of the first folder to display on a page. |
void |
SetLoadedCardID(int nCardID)
|
void |
SetMoreFolderID(int nFolderID)
|
void |
SetNumColumns(int nNumColumns)
|
void |
SetNumDocsPerPage(int _nNumDocsPerPage)
|
void |
SetObjectType(int nNewObjectType)
This activity space holds only cards, so no need to change the type. |
void |
SetPathwaysTaggingError(XPException e)
This method sets error that happened when tagging request is sent to pathways. |
void |
SetRRCategory(int nCategoryID)
|
void |
SetRRObjectID(int nObjectID)
|
void |
SetSaveTempData(boolean _saveTempData)
|
void |
SetSortByPropID(int nSortByPropID)
|
boolean |
ShowFolderActionBanner()
|
boolean |
ShowObjectBanner()
Get whether to show the banner or not. |
boolean |
ShowRelatedResources()
|
void |
StartCardKeywords(int _nCardID)
start the keywords section. |
void |
SubmitCard()
|
void |
SubmitCard(java.lang.String _strPath,
int _nCSSelectedDataSource)
|
void |
SubmitCard(java.lang.String _path,
java.lang.String _type,
java.lang.String _docID)
|
void |
SubmitCardWithPropertyBag(int[] arFolderIDs,
java.lang.String strLanguage,
int nDocTypeID,
int nDataSourceID,
IXPPropertyBag pbagCardProp,
java.lang.String strCardName,
java.lang.String strCardDescription)
|
void |
SubmitCardWithPropertyBag(int nDataSourceID,
java.lang.String strCardName,
java.lang.String strCardDescription,
IXPPropertyBag pbagCardProp,
int nFolderID)
|
boolean |
SupportsUpload(int _nDataSourceID)
Returns true if the specified data source supports remote document upload. |
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel |
---|
CleanupAllData, GetTempData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final java.lang.String HTTP_PREFIX
public static final java.lang.String ENGLISH_LOCALE_CODE
public static final java.lang.String CHINESE_LANGUAGE_CODE
public static final java.lang.String CHINESE_LOCALE_CODE_CN
public static final java.lang.String CHINESE_LOCALE_CODE_TW
public static final java.lang.String CHINESE_LOCALE_CODE_HK
public static final java.lang.String CHINESE_LOCALE_CODE_MO
public static final java.lang.String CHINESE_LOCALE_CODE_SG
public static final java.lang.String DEFAULTDATA
public static final java.lang.String strDataSourceTREESUBSPACE
public static final java.lang.String strMoveTargetFolderTREESUBSPACE
public static final java.lang.String strCopyTargetFolderTREESUBSPACE
public static final int HEADER_PROPERTIES_SIZE
public static final int HEADER_NAME_INDEX
public static final int HEADER_SORT_URL_INDEX
public static final int HEADER_ID_INDEX
public int m_nCurrentFolderID
public int m_nCurrentCardID
public int m_nLoadedCardID
protected int m_nDirMode
public XPArrayList m_xpPropColumns
public XPDateTime m_xpNewTagDate
public XPDateTime m_xpUpdateTagDate
public int m_nRangeBegin
public int m_nRangeEnd
public boolean m_bOpenDocInNewWindow
public int m_nNumFoldCol
public static final int BEGIN_INDEX
public static final int END_INDEX
public static final int CARD_CNT
public static final int TOTAL_CNT_INDEX
Constructor Detail |
---|
public DirModel()
Method Detail |
---|
public void ABODeleteFolders(int[] arFolderIDs)
ABODeleteFolders
in interface IDirModel
public boolean ABOJobIDsToDisplay()
IDirModelRO
ABOJobIDsToDisplay
in interface IDirModelRO
public void AddSelfSelectedRelatedExpert()
public boolean CheckFoldersForDelete()
CheckFoldersForDelete
in interface IDirModelRO
public boolean CheckForActivityRight(int nActivityRight)
CheckForActivityRight
in interface IDirModelRO
nActivityRight
-
public void CleanupTempData()
IModel
CleanupTempData
in interface IModel
CleanupTempData
in class AClearModel
IModel.CleanupTempData()
public void CopyCards(int[] arCardIDs, int nTargetFolder)
CopyCards
in interface IDirModel
public void CopyFolders(int[] arFolderIDs, int nTargetFolder)
CopyFolders
in interface IDirModel
public java.lang.Object Create()
AClearModel
Create
in interface IManagedObject
Create
in class AClearModel
IManagedObject.Create()
public void CreateDirectoryFolder(java.lang.String strName, java.lang.String strDescription)
IDirModel
CreateDirectoryFolder
in interface IDirModel
strName
- Folder NamestrDescription
- Folder Descriptionpublic void DeleteCards(int[] arCardIDs)
DeleteCards
in interface IDirModel
public void RaiseError(java.lang.String strError, java.lang.String strExtended)
strError
- - Error messagestrError
- - Extended error messagepublic void RaiseError(java.lang.String strError)
strError
- - Error messagepublic void DeleteFolders(int[] arFolderIDs)
DeleteFolders
in interface IDirModel
public void MigrateObjects(int nClassID, int[] nObjects, java.lang.String sComment)
IDirModel
MigrateObjects
in interface IDirModel
public boolean DoNotShowObject(int nIndex)
IObjectModelRO
DoNotShowObject
in interface IObjectModelRO
IObjectModelRO.DoNotShowObject(int)
public void Finish()
IRepostModel
Finish
in interface IRepostModel
public int[] GetABOJobIDs()
IDirModelRO
GetABOJobIDs
in interface IDirModelRO
public XPSortedDictionary GetBasicCardProperties()
GetBasicCardProperties
in interface IDirModelRO
public int GetBrowseBy()
GetBrowseBy
in interface IDirModelRO
public int GetBrowseBySource()
GetBrowseBySource
in interface IDirModelRO
public int GetCardID()
GetCardID
in interface IDirModelRO
public int GetLoadedCardID()
public void SetLoadedCardID(int nCardID)
public XPSortedDictionary GetCardInformation()
GetCardInformation
in interface IDirModelRO
public java.lang.String GetCardName(int nCardID)
GetCardName
in interface IDirModelRO
nCardID
-
public java.lang.String GetCardName()
GetCardName
in interface IDirModelRO
public void StartCardKeywords(int _nCardID)
public int GetObjectID()
GetObjectID
in interface IDirModelRO
public java.lang.String GetObjectUUID()
GetObjectUUID
in interface IDirModelRO
public int GetClassID()
GetClassID
in interface IDirModelRO
ILocNamesModelRO.GetClassID()
public int GetCardRangeBegin()
GetCardRangeBegin
in interface IDirModelRO
public int GetCardSubmitDataSource()
GetCardSubmitDataSource
in interface IDirModelRO
public java.lang.String GetCardSubmitURL(boolean bIsWebDataSource)
GetCardSubmitURL
in interface IDirModelRO
bIsWebDataSource
-
public int GetCardSubmitError()
IDirModelRO
GetCardSubmitError
in interface IDirModelRO
public java.lang.String GetCopyTargetFolderTREESUBSPACE()
GetCopyTargetFolderTREESUBSPACE
in interface IDirModelRO
public int GetCreatedFolderID()
GetCreatedFolderID
in interface IDirModelRO
public int GetCurrentFolderID()
IFolderModelRO
GetCurrentFolderID
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderID()
public int GetCurrentFolderLevel()
IFolderModelRO
GetCurrentFolderLevel
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderLevel()
public java.lang.String GetCurrentFolderName()
IFolderModelRO
GetCurrentFolderName
in interface IFolderModelRO
IFolderModelRO.GetCurrentFolderName()
public int GetCurrentLowerObjectIndex()
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentLowerObjectIndex()
public int GetCurrentUpperObjectIndex()
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetCurrentUpperObjectIndex()
public XPSortedDictionary GetCustomCardProperties()
GetCustomCardProperties
in interface IDirModelRO
public java.lang.String GetDataSourceName(int nDataSourceID)
IDirModelRO
GetDataSourceName
in interface IDirModelRO
nDataSourceID
-
public java.lang.String GetDataSourceProviderName(int nDataSourceID)
public java.lang.String GetDataSourceTREESUBSPACE()
GetDataSourceTREESUBSPACE
in interface IDirModelRO
public int GetDirectoryMode()
GetDirectoryMode
in interface IDirModelRO
public boolean GetDisplayPaginationHiddenInputs()
IObjectModelRO
GetDisplayPaginationHiddenInputs
in interface IObjectModelRO
IObjectModelRO.GetDisplayPaginationHiddenInputs()
public boolean GetDisplaySortHiddenInputs()
IObjectModelRO
GetDisplaySortHiddenInputs
in interface IObjectModelRO
IObjectModelRO.GetDisplaySortHiddenInputs()
public java.lang.String GetDocDescriptionType()
GetDocDescriptionType
in interface IDirModelRO
public IASQueryResult GetFilteredDataSources()
IDirModelRO
GetFilteredDataSources
in interface IDirModelRO
public int GetFirstFolderIndex()
IFolderModelRO
GetFirstFolderIndex
in interface IFolderModelRO
IFolderModelRO.GetFirstFolderIndex()
public int GetFolderColumnCount()
IFolderModelRO
GetFolderColumnCount
in interface IFolderModelRO
IFolderModelRO.GetFolderColumnCount()
public java.lang.String GetFolderDescriptionType()
GetFolderDescriptionType
in interface IDirModelRO
public java.lang.String GetFolderName(int nFolderID)
GetFolderName
in interface IDirModelRO
nFolderID
-
public IASQueryResult GetFolderObjectCount()
IFolderModelRO
GetFolderObjectCount
in interface IFolderModelRO
IFolderModelRO.GetFolderObjectCount()
public java.lang.String GetFolderPath(int nFolderID)
GetFolderPath
in interface IDirModelRO
nFolderID
-
public IASQueryResult GetFolderQueryResult()
IFolderModelRO
GetFolderQueryResult
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderData()
public IPTSearchResponse GetFolderSearchResponse()
IDirModelRO
GetFolderSearchResponse
in interface IDirModelRO
com.plumtree.portalpages.browsing.directory.GetFolderSearchResponse()
public IFolderViewHelper GetFolderViewHelper()
IFolderModelRO
GetFolderViewHelper
in interface IFolderModelRO
IFolderModelRO.GetFolderViewHelper()
public int GetHeaderCount()
IObjectModelRO
GetHeaderCount
in interface IObjectModelRO
IObjectModelRO.GetHeaderCount()
public boolean GetHeaderHasCheckbox()
IObjectModelRO
GetHeaderHasCheckbox
in interface IObjectModelRO
IObjectModelRO.GetHeaderHasCheckbox()
public HTMLTableRow GetHeaderRow()
IObjectModelRO
GetHeaderRow
in interface IObjectModelRO
IObjectModelRO.GetHeaderRow()
public IXPList GetHeaderProperties()
IDirModelRO
GetHeaderProperties
in interface IDirModelRO
public java.lang.String GetHeaderText(int nHeaderIndex)
IObjectModelRO
GetHeaderText
in interface IObjectModelRO
nHeaderIndex
- nHeaderIndex
IObjectModelRO.GetHeaderText(int)
public boolean GetIsCollapsable()
IObjectModelRO
GetIsCollapsable
in interface IObjectModelRO
IObjectModelRO.GetIsCollapsable()
public boolean GetIsFolderSelected(int nFolderID)
IFolderModelRO
GetIsFolderSelected
in interface IFolderModelRO
IFolderModelRO.GetShowCheckbox()
public boolean GetIsObjectSelected(int nObjectID)
IObjectModelRO
GetIsObjectSelected
in interface IObjectModelRO
IObjectModelRO.GetIsObjectSelected(int)
public int GetLastFolderIndex()
IFolderModelRO
GetLastFolderIndex
in interface IFolderModelRO
IFolderModelRO.GetLastFolderIndex()
public int GetMoreFolderID()
GetMoreFolderID
in interface IDirModelRO
public java.lang.Object[][] GetMoreRelatedResources(int nRelatedResourceID)
GetMoreRelatedResources
in interface IDirModelRO
public java.lang.String GetMoveTargetFolderTREESUBSPACE()
GetMoveTargetFolderTREESUBSPACE
in interface IDirModelRO
public java.lang.String GetName()
IMVCObject
GetName
in interface IMVCObject
GetName
in class AClearModel
com.plumtree.xpshared.activityspace.IModel#GetName()
public java.lang.Object GetNewTempData()
AClearModel
GetNewTempData
in class AClearModel
public int GetNumDocsPerPage()
GetNumDocsPerPage
in interface IDirModelRO
public void SetNumDocsPerPage(int _nNumDocsPerPage)
_nNumDocsPerPage
- The Number of cards per page to be set.public int GetNumFolderColumns()
GetNumFolderColumns
in interface IDirModelRO
public int GetNumObjects()
com.plumtree.portalpages.common.objects.IPaginationModelRO#GetNumObjects()
public int GetNumSubSubFolders()
GetNumSubSubFolders
in interface IDirModelRO
public int GetNumSubSubFoldersToDisplay()
IFolderModelRO
GetNumSubSubFoldersToDisplay
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetNumSubSubFolders()
public java.lang.String GetObjectBannerText()
GetObjectBannerText
in interface IDirModelRO
public int[] GetCardRange()
GetCardRange
in interface IDirModelRO
public java.lang.String GetObjectBannerTitle()
IObjectModelRO
GetObjectBannerTitle
in interface IObjectModelRO
IObjectModelRO.GetObjectBannerTitle()
public int GetObjectColumnCount()
IObjectModelRO
GetObjectColumnCount
in interface IObjectModelRO
IObjectModelRO.GetObjectColumnCount()
public int GetObjectCount()
IObjectModelRO
GetObjectCount
in interface IObjectModelRO
IObjectModelRO.GetObjectCount()
public java.lang.Object GetObjectFields(int nIndex, int nPropID)
IObjectModelRO
GetObjectFields
in interface IObjectModelRO
nIndex
- nIndexnPropID
- nPropID
IObjectModelRO.GetObjectFields(int,
int)
public int GetObjectType()
IObjectModelRO
GetObjectType
in interface IObjectModelRO
com.plumtree.portalpages.common.folder.IObjectModelRO#GetObjectType()
public int GetObjectSubType(int nIndex)
IObjectModelRO
GetObjectSubType
in interface IObjectModelRO
nIndex
- index of the object in the list.
com.plumtree.portalpages.common.objects.IObjectModelRO#GetObjectSubType()
public boolean GetObjectViewIsCollapsed()
IObjectModelRO
GetObjectViewIsCollapsed
in interface IObjectModelRO
IObjectModelRO.GetObjectViewIsCollapsed()
public int GetParentDefaultDataSourceIDRecursive()
IDirModelRO
GetParentDefaultDataSourceIDRecursive
in interface IDirModelRO
public int GetParentFolderID()
IFolderModelRO
GetParentFolderID
in interface IFolderModelRO
IFolderModelRO.GetParentFolderID()
public int OpenFolderByPath(java.lang.String strPath)
OpenFolderByPath
in interface IDirModel
public java.lang.Object[] GetParentFolderIDs()
IFolderModelRO
GetParentFolderIDs
in interface IFolderModelRO
IFolderModelRO.GetParentFolderIDs()
public IASQueryResult GetBreadCrumbPath()
GetBreadCrumbPath
in interface IDirModelRO
public java.lang.String GetPath()
IFolderModelRO
GetPath
in interface IFolderModelRO
IFolderModelRO.GetPath()
public XPArrayList GetPropColumns()
GetPropColumns
in interface IDirModelRO
public int GetRRCategory()
GetRRCategory
in interface IDirModelRO
public int GetRRObjectID()
GetRRObjectID
in interface IDirModelRO
public Redirect GetRedirectAfterFinish()
IRepostModel
GetRedirectAfterFinish
in interface IRepostModel
public IASQueryResult GetRelatedResource(int lRelatedResourceID)
GetRelatedResource
in interface IDirModelRO
lRelatedResourceID
-
public int[] GetRelatedResourceIDs()
GetRelatedResourceIDs
in interface IDirModelRO
public java.lang.String GetRelatedResourceString(int nRelatedResourceID)
GetRelatedResourceString
in interface IDirModelRO
nRelatedResourceID
-
public int GetRelatedResourcesLocation()
GetRelatedResourcesLocation
in interface IDirModelRO
public IPTSession GetSession()
GetSession
in interface IDirModelRO
public boolean GetShowCheckbox()
IFolderModelRO
GetShowCheckbox
in interface IFolderModelRO
IFolderModelRO.GetShowCheckbox()
public boolean GetShowFolderBanner()
IFolderModelRO
GetShowFolderBanner
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetShowBanner()
public boolean GetShowPagination()
IObjectModelRO
GetShowPagination
in interface IObjectModelRO
IObjectModelRO.GetShowPagination()
public int GetSortDirection()
ISortModelRO
GetSortDirection
in interface ISortModelRO
com.plumtree.portalpages.common.objects.ISortModelRO#GetSortDirection()
public boolean GetSortable()
IObjectModelRO
GetSortable
in interface IObjectModelRO
IObjectModelRO.GetSortable()
public int GetSortedHeader()
ISortModelRO
GetSortedHeader
in interface ISortModelRO
com.plumtree.portalpages.common.objects.ISortModelRO#GetSortedHeader()
public java.lang.String GetSpaceID()
GetSpaceID
in interface IObjectModelRO
public int GetSubFolderCount()
IFolderModelRO
GetSubFolderCount
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()
public int GetSubFolderCount(int nLevel)
IFolderModelRO
GetSubFolderCount
in interface IFolderModelRO
com.plumtree.portalpages.common.folder.IFolderModelRO#GetFolderCount()
public int GetTotalResults()
GetTotalResults
in interface IDirModelRO
public boolean HasAccessToEditCard()
HasAccessToEditCard
in interface IDirModelRO
public boolean HasAccessToEditFolder()
HasAccessToEditFolder
in interface IDirModelRO
public boolean HasAccessToApproveCardInFolder()
HasAccessToApproveCardInFolder
in interface IDirModelRO
public boolean HasSelfSelectExpertRightOnThisFolder()
HasSelfSelectExpertRightOnThisFolder
in interface IDirModelRO
public int GetSubPortalAccessType()
GetSubPortalAccessType
in interface IDirModelRO
public boolean InRootFolder()
IFolderModelRO
InRootFolder
in interface IFolderModelRO
IFolderModelRO.InRootFolder()
public boolean InUnclassifiedCardsFolder()
InUnclassifiedCardsFolder
in interface IDirModelRO
public void Init(AActivitySpace parent)
IModel
Init
in interface IModel
Init
in class AClearModel
parent
- the parent Activity Spacecom.plumtree.xpshared.activityspace.IModel#Init()
public void LoadBrowsingPropColumns()
public boolean IsAtMaxFolderLevel()
IDirModelRO
IsAtMaxFolderLevel
in interface IDirModelRO
public boolean IsRelatedExpert()
IsRelatedExpert
in interface IDirModelRO
public boolean IsWebDataSource(int nDataSourceID)
IsWebDataSource
in interface IDirModelRO
nDataSourceID
- the data source to check
public void LoadCardProperties()
public boolean LoadFoldersAndDocuments()
public void LoadNewAndUpdatedDates()
public XPDateTime GetObjectNewTagDate()
GetObjectNewTagDate
in interface IDirModelRO
public XPDateTime GetObjectUpdateTagDate()
GetObjectUpdateTagDate
in interface IDirModelRO
public void LoadUserPrefs()
public boolean GetUserPrefOpenDocInNewWindow()
GetUserPrefOpenDocInNewWindow
in interface IDirModelRO
public XPLocale GetUserPrefLocale()
GetUserPrefLocale
in interface IDirModelRO
public XPTimeZone GetUserPrefTimeZone()
GetUserPrefTimeZone
in interface IDirModelRO
public void MoveCards(int[] arCardIDs, int nTargetFolder)
MoveCards
in interface IDirModel
public void MoveFolders(int[] arFolderIDs, int nTargetFolder)
MoveFolders
in interface IDirModel
public void OpenSubFolder(int ID)
IFolderModel
OpenSubFolder
in interface IDirModel
OpenSubFolder
in interface IFolderModel
IFolderModel.OpenSubFolder(int)
public int RefreshItemFromCopyTargetFolderTree()
RefreshItemFromCopyTargetFolderTree
in interface IDirModelRO
public int RefreshItemFromDataSourceTree()
RefreshItemFromDataSourceTree
in interface IDirModelRO
public int RefreshItemFromMoveTargetFolderTree()
RefreshItemFromMoveTargetFolderTree
in interface IDirModelRO
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
IRepostModel
SavePage
in interface IRepostModel
IRepostModel.SavePage(String, XPHashtable)
public void SetCardSubmitMode(int nCardID)
SetCardSubmitMode
in interface IDirModel
public int GetCardSubmitMode()
GetCardSubmitMode
in interface IDirModelRO
public void SetCardID(int nCardID)
SetCardID
in interface IDirModel
public void ClearCardRange()
ClearCardRange
in interface IDirModel
public void SetCardRange(int nRangeBegin, int nRangeEnd)
SetCardRange
in interface IDirModel
public void SetCardSubmitDataSource(int nDataSourceID)
SetCardSubmitDataSource
in interface IDirModel
public void SetCardSubmitURL(java.lang.String strURL)
SetCardSubmitURL
in interface IDirModel
public void SetDocUploadParams(java.lang.String _duID, java.lang.String _duServer)
SetDocUploadParams
in interface IDirModel
public void SetCardSubmitName(java.lang.String strName)
SetCardSubmitName
in interface IDirModel
public void SetCardSubmitDescription(java.lang.String strDescription)
SetCardSubmitDescription
in interface IDirModel
public void SetCardSubmitFolder(int _nFolderID)
IDirModel
SetCardSubmitFolder
in interface IDirModel
public int GetCardSubmitFolder()
GetCardSubmitFolder
in interface IDirModelRO
public void SetCardSubmitError(int _nErrorCode)
IDirModel
SetCardSubmitError
in interface IDirModel
_nErrorCode
- The error generated during card submission.
-1 means no error, and is the default value.public void SetDefaultCardRefreshSettings(int nCardID)
SetDefaultCardRefreshSettings
in interface IDirModel
public void SetDirectoryMode(int nMode)
IDirModel
SetDirectoryMode
in interface IDirModel
public void SetFirstItemIndex(int nFirstItemIndex)
IFolderModel
SetFirstItemIndex
in interface IFolderModel
IFolderModel.SetFirstItemIndex(int)
public void SetFolderIDAndMode(int ID, int nMode)
public void SetFoldersForDeleteCheck(boolean bFolders)
bFolders
- public void SetLastItemIndex(int nLastItemIndex)
IFolderModel
SetLastItemIndex
in interface IFolderModel
IFolderModel.SetLastItemIndex(int)
public void SetMoreFolderID(int nFolderID)
nFolderID
- public void SetNumColumns(int nNumColumns)
com.plumtree.portalpages.common.folder.IFolderModel#SetNumColumns(int)
public void SetObjectType(int nNewObjectType)
IDirModel
SetObjectType
in interface IDirModel
public void SetRRCategory(int nCategoryID)
nCategoryID
- public void SetRRObjectID(int nObjectID)
nObjectID
- public void SetSortByPropID(int nSortByPropID)
nSortByPropID
- public boolean ShowFolderActionBanner()
ShowFolderActionBanner
in interface IDirModelRO
public boolean ShowObjectBanner()
IObjectModelRO
ShowObjectBanner
in interface IObjectModelRO
IObjectModelRO.ShowObjectBanner()
public boolean ShowRelatedResources()
ShowRelatedResources
in interface IDirModelRO
public boolean IsValidSimpleSubmitSource(int _nDataSourceID)
IsValidSimpleSubmitSource
in interface IDirModelRO
public boolean SupportsUpload(int _nDataSourceID)
SupportsUpload
in interface IDirModelRO
public int GetWebServiceID(int _nDataSourceID)
public SearchExecutionWarning GetWarning()
IDirModelRO
GetWarning
in interface IDirModelRO
com.plumtree.portalpages.search.IBaseSearchResultModelRO.GetWarning()
public java.lang.String GetUploadWSURL(int _nDataSourceID)
GetUploadWSURL
in interface IDirModelRO
public void SubmitCard()
SubmitCard
in interface IDirModel
public void SubmitCard(java.lang.String _strPath, int _nCSSelectedDataSource)
SubmitCard
in interface IDirModel
public void SubmitCard(java.lang.String _path, java.lang.String _type, java.lang.String _docID)
SubmitCard
in interface IDirModel
public IXPPropertyBag CreateCardSubmitUploadPropertyBag(java.lang.String _path, java.lang.String _type, java.lang.String _docID)
public void SubmitCardWithPropertyBag(int nDataSourceID, java.lang.String strCardName, java.lang.String strCardDescription, IXPPropertyBag pbagCardProp, int nFolderID)
SubmitCardWithPropertyBag
in interface IDirModel
nFolderID
- the folder to use. If this is -1, the current folder will be used.public void SubmitCardWithPropertyBag(int[] arFolderIDs, java.lang.String strLanguage, int nDocTypeID, int nDataSourceID, IXPPropertyBag pbagCardProp, java.lang.String strCardName, java.lang.String strCardDescription)
SubmitCardWithPropertyBag
in interface IDirModel
public void doApproval(int[] arCardIDs, int nAction)
doApproval
in interface IDirModel
public boolean doesPropertyDescribeCard(java.lang.Object[] arCardPropIDs, int nPropID)
arCardPropIDs
- nPropID
-
public IXPList GetObjectTags(int docId)
ITaggingModel
GetObjectTags
in interface ITaggingModel
docId
- Object Id
public boolean RetrieveSubFoldersThroughSearch()
IDirModelRO
RetrieveSubFoldersThroughSearch
in interface IDirModelRO
public IPTSearchResponse SearchSubFolders(int nFolderID, int nCurrentLevel)
SearchSubFolders
in interface IDirModel
public IPTFilter CreateSubFolderSearchFilter(int nCurrentLevel)
public int GetFolderSearchMapping(int nIndex)
IDirModelRO
GetFolderSearchMapping
in interface IDirModelRO
public int[] CalculateReportMapping(IPTSearchResponse ptSR, int nCurrentLevel)
public boolean IsDateProperty(int nPropertyID)
strURL
-
public XPArrayList GetCustomFields(int _nObjectIndex, XPArrayList xpCustomProps, XPLocale xpLocale, XPTimeZone xpTimeZone)
IDirModelRO
GetCustomFields
in interface IDirModelRO
_nObjectIndex
- xpCustomProps
-
public void SetSaveTempData(boolean _saveTempData)
saveURL
- The m_bCSSaveURL to set.public int GetDocumentTypeId()
GetDocumentTypeId
in interface IDirModelRO
public void SetDocumentTypeId(java.lang.String documentTypeId)
SetDocumentTypeId
in interface IDirModel
public void AddRemoveObjectTag(java.lang.String tagname, java.lang.String strid, int action, java.lang.String ptsource) throws XPIllegalStateException
ITaggingModel
AddRemoveObjectTag
in interface ITaggingModel
tagname
- Name of the Tag that needs to be Added or Removedstrid
- Concatenation of classid and Object Id PTCLASSID_PTOJECTIDaction
- Operation to perform on the Tag, 0 = Add, 1 = Delete, 2 = Edit (delete old tag and add new tag)ptsource
- source of the Object to be specified for Pathways it can be PTPORTAL or PTCOLLAB, for more sources see PathwaysConstants.
XPIllegalStateException
- Throws this exception if pathways is unavailable and a request to Add/Remove Tags is sent.public void RenameObjectTag(java.lang.String tagname, java.lang.String strid, java.lang.String ptsource, java.lang.String renametag) throws XPIllegalStateException
ITaggingModel
RenameObjectTag
in interface ITaggingModel
tagname
- the Source Tag Name to be used for renamingstrid
- Concatenation of classid and Object Id PTCLASSID_PTOJECTIDptsource
- source of the Object to be specified for Pathways it can be PTPORTAL or PTCOLLAB, for more sources see PathwaysConstants.
XPIllegalStateException
- Throws this exception if pathways is unavailable and a request to Add/Remove Tags is sent.public boolean IsTaggingEnabled()
ITaggingModel
IsTaggingEnabled
in interface ITaggingModel
public XPException GetPathwaysTaggingError()
ITaggingModel
GetPathwaysTaggingError
in interface ITaggingModel
public void SetPathwaysTaggingError(XPException e)
ITaggingModel
SetPathwaysTaggingError
in interface ITaggingModel
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |