|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
All administrative objects in Plumtree are stored in a foldering system. The folders are called Admin Folders, and the Admin Catalog is the container for the Admin Folders.
IPTAdminCatalog| Method Summary | |
IPTAdminCatalog |
GetAdminCatalog()
Returns the Admin Catalog |
java.lang.Object[][] |
GetDefaultOrderBy()
Returns the default order by as a 1x2 array. |
int |
GetFolderLevel()
Returns the folder level (the number of ancestor folders) |
int |
GetFolderType()
Returns the folder type. |
int |
GetJobType()
Returns the job type associated with this folder |
int |
GetParentFolderID()
Returns the ID of the folder containing this folder, or 0 if no parent |
java.lang.Object[] |
GetParentIDs()
Returns the IDs of folders that contain this folder as an array |
java.lang.String |
GetPath()
Returns the path to this admin folder as a string. |
IPTQueryResult |
GetPathAsQueryResult()
Returns path as query result, which includes PT_PROPID_OBJECTID and PT_PROPID_NAME. |
IPTQueryResult |
QueryObjects(boolean bSecureCountOnly)
Queries objects that are in this folder based on class ids. |
IPTQueryResult |
QueryObjectsCount(boolean bSecureCountOnly)
Returns the type of objects that are in this folder along with the count of how many each is. |
IPTQueryResult |
QuerySubfolders(int lPropIDMask,
int lDepth,
int vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
Queries the subfolders. |
IPTQueryResult |
QuerySubfolders(int lPropIDMask,
int lDepth,
java.lang.Object vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
Queries the subfolders. |
int |
QuerySubfoldersCount()
Returns the number of immediate subfolders |
void |
SetDefaultOrderBy(java.lang.Object[][] Value)
Sets the default order by. |
void |
SetFolderType(int Value)
Sets the folder type. |
void |
SetJobType(int Value)
Sets the job type of the folder |
| Methods inherited from interface com.plumtree.server.IPTObject |
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified |
| Methods inherited from interface com.plumtree.server.IPTLocalizable |
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang |
| Methods inherited from interface com.plumtree.server.IPTUnknown |
GetInterfaces |
| Method Detail |
public java.lang.String GetPath()
public java.lang.Object[] GetParentIDs()
public int GetFolderLevel()
public java.lang.Object[][] GetDefaultOrderBy()
PT_PROPIDS,
PT_ORDERBY_SETTINGSpublic void SetDefaultOrderBy(java.lang.Object[][] Value)
vValue - 1x2 Object arrayPT_PROPIDS,
PT_ORDERBY_SETTINGSpublic IPTAdminCatalog GetAdminCatalog()
IPTAdminCatalogpublic int GetParentFolderID()
public int QuerySubfoldersCount()
public IPTQueryResult QuerySubfolders(int lPropIDMask,
int lDepth,
int vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
lPropIDMask - prop ids to querylDepth - 0 or 1vOrderBy - can be an Object[][] with 2 columns and one row. The
first column holds the property ID to order by, from PT_PROPIDS. The
second column holds the order to order, from PT_ORDERBY_SETTINGSlSkipRows - number of rows to skip at the beginning, or 0 for nonelMaxRows - maximum number of rows to return, or -1 for allvQueryFilter - is a 2D array with 3 columns. The first column holds
the property id, from PT_PROPIDS. The second column holds the operator,
from PT_FILTEROPS. The third column holds the value to be matched.PT_PROPIDS,
PT_ORDERBY_SETTINGS
public IPTQueryResult QuerySubfolders(int lPropIDMask,
int lDepth,
java.lang.Object vOrderBy,
int lSkipRows,
int lMaxRows,
java.lang.Object[][] vQueryFilter)
lPropIDMask - prop ids to querylDepth - 0 or 1vOrderBy - a PT_PROPIDS to order the result bylSkipRows - number of rows to skip at the beginning, or -1 for nonelMaxRows - maximum number of rows to return, or -1 for allvQueryFilter - is a 2D array with 3 columns. The first column holds
the property id, from PT_PROPIDS. The second column holds the operator,
from PT_FILTEROPS. The third column holds the value to be matched.PT_PROPIDS,
PT_ORDERBY_SETTINGS,
PT_FILTEROPSpublic IPTQueryResult QueryObjectsCount(boolean bSecureCountOnly)
bSecureCountOnly - only accepts falsepublic IPTQueryResult QueryObjects(boolean bSecureCountOnly)
bSecureCountOnly - secure or insecure queries supportedpublic int GetJobType()
PT_ADMIN_FOLDER_JOB_TYPESpublic void SetJobType(int Value)
lJobType - one of PT_ADMIN_FOLDER_JOB_TYPESPT_ADMIN_FOLDER_JOB_TYPESpublic int GetFolderType()
PT_ADMIN_FOLDER_TYPESpublic void SetFolderType(int Value)
lFolderType - one of PT_ADMIN_FOLDER_TYPES.public IPTQueryResult GetPathAsQueryResult()
IPTQueryResult,
PT_PROPIDS
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||