com.plumtree.portalpages.admin.objmgr
Interface IObjMgrModelRO

All Superinterfaces:
IModelRO, IMVCObject
All Known Implementing Classes:
ObjMgrModel

public interface IObjMgrModelRO
extends IModelRO

Author:
Don Hayler

Method Summary
 boolean ABOJobsToDisplay()
          This method returns whether or not there are any job IDs to display.
 boolean CheckAuthSourceForDelete()
          This method checks if any users or groups came from an auth source other than plumtree.
 boolean CheckFoldersForDelete()
          This method checks whether or not the user is trying to delete any folders.
 boolean CheckPageTemplatesForDelete()
          This method checks whether or not the user is trying to delete any page templates.
 java.lang.String GetABOJobFolderName()
          This method returns the folder where the ABO jobs were created.
 int[] GetABOJobIDs()
          This method returns the job IDs for the last ABO deletes, and then clears them.
 java.lang.String[] GetABOJobNames(int[] nABOJobIDs)
          This method returns the job names for the supplied ABO job IDs.
 boolean GetAreAllObjectsExpanded()
          This method is used to determine whether to display the 'expand all' button or the 'collapse all' button.
 IASQueryResult GetBreadCrumbPath()
          This method returns a 2d query result with folder level, id, and name.
 int GetCommunityID(int nFolderID)
          This method returns the community object ID associated with the folder.
 boolean GetCurrentFolderIsCommunity()
          This method returns whether or not the current folder is a community.
 boolean GetCurrentFolderIsSubportal()
          This method returns whether or not the current folder is a subportal.
 int[] GetExpandedObjectTypesArray()
          This method returns an int array of the currently expanded object types.
 java.lang.String GetExpandedObjectTypesString()
          This method returns the string of currently expanded object types suitable for using in an URL.
 java.lang.String GetFolderTreeID()
          This method returns the space ID of the folder select tree.
 boolean GetHasDisplayedObjects(int nClassID)
          This method checks whether or not the current page has any objects that will be displayed for the requested classID.
 int GetPreviousFolderID()
          This method returns the folder ID that we were previously at.
 boolean HasAccessToCreateMenu()
           
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

ABOJobsToDisplay

boolean ABOJobsToDisplay()
This method returns whether or not there are any job IDs to display.

Returns:
boolean true implies there are job ids to display.

CheckAuthSourceForDelete

boolean CheckAuthSourceForDelete()
This method checks if any users or groups came from an auth source other than plumtree. This assumes that any objects to check were set on the model earlier in the request (as they will be deleted between requests).

Returns:
true implies objects did come from an outside auth source

CheckPageTemplatesForDelete

boolean CheckPageTemplatesForDelete()
This method checks whether or not the user is trying to delete any page templates.

Returns:
true implies page templates are being deleted

CheckFoldersForDelete

boolean CheckFoldersForDelete()
This method checks whether or not the user is trying to delete any folders.

Returns:
true implies folders are being deleted

GetABOJobNames

java.lang.String[] GetABOJobNames(int[] nABOJobIDs)
This method returns the job names for the supplied ABO job IDs.

Parameters:
int[] - the ABO job IDs to get the names for.
Returns:
String[] an array of job names for folder deletions.

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.

GetABOJobFolderName

java.lang.String GetABOJobFolderName()
This method returns the folder where the ABO jobs were created.

Returns:
String the folder name where the ABO jobs were created.

GetCommunityID

int GetCommunityID(int nFolderID)
This method returns the community object ID associated with the folder.

Parameters:
int - the community folder ID to check. -1 means check current folder
Returns:
int the ID of the community object, -1 if error

GetPreviousFolderID

int GetPreviousFolderID()
This method returns the folder ID that we were previously at. This is used to return from places like the subportal manager.

Returns:
int the previous folder ID.

GetAreAllObjectsExpanded

boolean GetAreAllObjectsExpanded()
This method is used to determine whether to display the 'expand all' button or the 'collapse all' button.

Returns:
boolean true implies all object expanded button has been clicked.

GetCurrentFolderIsCommunity

boolean GetCurrentFolderIsCommunity()
This method returns whether or not the current folder is a community.

Returns:
boolean true implies is a community

GetCurrentFolderIsSubportal

boolean GetCurrentFolderIsSubportal()
This method returns whether or not the current folder is a subportal.

Returns:
boolean true implies is a subportal

GetExpandedObjectTypesArray

int[] GetExpandedObjectTypesArray()
This method returns an int array of the currently expanded object types.

Returns:
int[] the expanded object types.

GetExpandedObjectTypesString

java.lang.String GetExpandedObjectTypesString()
This method returns the string of currently expanded object types suitable for using in an URL.

Returns:
String the expanded object types.

GetFolderTreeID

java.lang.String GetFolderTreeID()
This method returns the space ID of the folder select tree.

Returns:
String the space ID of the folder select tree

GetHasDisplayedObjects

boolean GetHasDisplayedObjects(int nClassID)
This method checks whether or not the current page has any objects that will be displayed for the requested classID.

Parameters:
int - nClassID the class ID to check for

GetBreadCrumbPath

IASQueryResult GetBreadCrumbPath()
This method returns a 2d query result with folder level, id, and name.

Returns:
IASQueryResult

HasAccessToCreateMenu

boolean HasAccessToCreateMenu()
See Also:
ObjMgrModel.HasAccessToCreateMenu()



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.