com.plumtree.server
Interface IPTAdminFolder

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTAdminFolder
extends IPTObject

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.

Author:
michaels
See Also:
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
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetPath

java.lang.String GetPath()
Returns the path to this admin folder as a string. NOT LOCALIZED. Should call GetPathAsQueryResult instead.

Returns:
path string

GetParentIDs

java.lang.Object[] GetParentIDs()
Returns the IDs of folders that contain this folder as an array

Returns:
Object[] of parent ids

GetFolderLevel

int GetFolderLevel()
Returns the folder level (the number of ancestor folders)

Returns:
int

GetDefaultOrderBy

java.lang.Object[][] GetDefaultOrderBy()
Returns the default order by as a 1x2 array. The first element is the prop id to order by. The second element is whether it's ascending or descending.

Returns:
Object[][]
See Also:
PT_PROPIDS, PT_ORDERBY_SETTINGS

SetDefaultOrderBy

void SetDefaultOrderBy(java.lang.Object[][] Value)
Sets the default order by. Takes in a 1x2 array The first element is the prop id to order by. The second element is whether it's ascending or descending.

Parameters:
vValue - 1x2 Object array
See Also:
PT_PROPIDS, PT_ORDERBY_SETTINGS

GetAdminCatalog

IPTAdminCatalog GetAdminCatalog()
Returns the Admin Catalog

Returns:
IPTAdminCatalog
See Also:
IPTAdminCatalog

GetParentFolderID

int GetParentFolderID()
Returns the ID of the folder containing this folder, or 0 if no parent

Returns:
int

QuerySubfoldersCount

int QuerySubfoldersCount()
Returns the number of immediate subfolders

Returns:
int

QuerySubfolders

IPTQueryResult QuerySubfolders(int lPropIDMask,
                               int lDepth,
                               int vOrderBy,
                               int lSkipRows,
                               int lMaxRows,
                               java.lang.Object[][] vQueryFilter)
Queries the subfolders. This can be immediate (depth 0 or child depth 1).

Parameters:
lPropIDMask - prop ids to query
lDepth - 0 or 1
vOrderBy - 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_SETTINGS
lSkipRows - number of rows to skip at the beginning, or 0 for none
lMaxRows - maximum number of rows to return, or -1 for all
vQueryFilter - 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.
Returns:
IPTQueryResult
See Also:
PT_PROPIDS, PT_ORDERBY_SETTINGS

QuerySubfolders

IPTQueryResult QuerySubfolders(int lPropIDMask,
                               int lDepth,
                               java.lang.Object vOrderBy,
                               int lSkipRows,
                               int lMaxRows,
                               java.lang.Object[][] vQueryFilter)
Queries the subfolders. This can be immediate (depth 0 or child depth 1).

Parameters:
lPropIDMask - prop ids to query
lDepth - 0 or 1
vOrderBy - a PT_PROPIDS to order the result by
lSkipRows - number of rows to skip at the beginning, or -1 for none
lMaxRows - maximum number of rows to return, or -1 for all
vQueryFilter - 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.
Returns:
IPTQueryResult
See Also:
PT_PROPIDS, PT_ORDERBY_SETTINGS, PT_FILTEROPS

QueryObjectsCount

IPTQueryResult QueryObjectsCount(boolean bSecureCountOnly)
Returns the type of objects that are in this folder along with the count of how many each is. The result is returned in a query result with prop ids PT_PROPID_CLASSID and PT_PROPID_OBJECTCOUNT.

Parameters:
bSecureCountOnly - only accepts false
Returns:
IPTQueryResult

QueryObjects

IPTQueryResult QueryObjects(boolean bSecureCountOnly)
Queries objects that are in this folder based on class ids. Queries can be either secure (only returns objects the current user has access to), or insecure. The resulting IPTQueryResult will have 2 pieces of information: PT_PROPID_CLASS and PT_PROPID_OBJECTID.

Parameters:
bSecureCountOnly - secure or insecure queries supported
Returns:
IPTQueryResult

GetJobType

int GetJobType()
Returns the job type associated with this folder

Returns:
PT_ADMIN_FOLDER_JOB_TYPES
See Also:
PT_ADMIN_FOLDER_JOB_TYPES

SetJobType

void SetJobType(int Value)
Sets the job type of the folder

Parameters:
lJobType - one of PT_ADMIN_FOLDER_JOB_TYPES
See Also:
PT_ADMIN_FOLDER_JOB_TYPES

GetFolderType

int GetFolderType()
Returns the folder type.

Returns:
Can be regular folder, subportal folder, or community folder as defined in PT_ADMIN_FOLDER_TYPES.
See Also:
PT_ADMIN_FOLDER_TYPES

SetFolderType

void SetFolderType(int Value)
Sets the folder type.

Parameters:
lFolderType - one of PT_ADMIN_FOLDER_TYPES.

GetPathAsQueryResult

IPTQueryResult GetPathAsQueryResult()
Returns path as query result, which includes PT_PROPID_OBJECTID and PT_PROPID_NAME. Then name is correctly localized.

Returns:
IPTQueryResult
See Also:
IPTQueryResult, PT_PROPIDS


Copyright 2008 Plumtree Software Inc. All Rights Reserved.