|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.taskapi.portalui.TaskAPIUICommon
public class TaskAPIUICommon
Common functions used by other TaskAPI packages.
Field Summary | |
---|---|
static int |
INVALID_OBJECTID
|
Constructor Summary | |
---|---|
TaskAPIUICommon()
|
Method Summary | |
---|---|
static java.lang.String |
GetActivitySpaceName(AActivitySpace owner)
Gets the name of the provided Activityspace. |
static java.lang.Object |
GetASModel(AActivitySpace owner,
java.lang.String strModelName)
Gets the specified Activityspace Model object. |
static boolean |
GetASModelExist(AActivitySpace owner,
java.lang.String strModelName)
Helper method to check if the specified Model object exists in the current Activityspace. |
static AActivitySpace |
GetEnvTypeObject(IEnvironment env)
|
static FullURL[] |
GetFullURLFromListEntryIterator(AActivitySpace owner,
ICPListEntryIterator cpList)
Helper function to convert an ICPListEntryIterator object to an array with FullURL s. |
static GatewayModel |
GetGatewayPageModel(AActivitySpace owner)
Gets the GatewayModel object. |
static boolean |
GetGatewayPageModelExists(AActivitySpace owner)
Checks if the GatewayModel exists in the current Activityspace. |
static AActivitySpace |
GetMyPageOrCommunityAActivitySpace(IEnvironment env)
Method to determine and obtain if object is a valid MyPage or CommunityPage AActivitySpace. |
static MyPortalModel |
GetMyPortalPageModel(AActivitySpace owner)
Gets the MyPortalModel object. |
static boolean |
GetMyPortalPageModelExists(AActivitySpace owner)
Checks if the MyPortalModel exists in the current Activityspace. |
static NavigationModel |
GetNavigationModel(AActivitySpace owner)
Deprecated. All functionality is available from TaskAPI functions, no need for NavigationModel . |
static boolean |
GetNavigationModelExists(AActivitySpace owner)
Helper method that checks whether or not the NavigationModel object is present on the activityspace. |
static IPTSession |
GetPTSession(AActivitySpace owner)
Gets the Plumtree Session from the Activityspace. |
static SiteMapModel |
GetSiteMapPageModel(AActivitySpace owner)
Gets the SiteMapModel object. |
static boolean |
GetSiteMapPageModelExists(AActivitySpace owner)
Checks if the SiteMapModel exists in the current Activityspace. |
static boolean |
IsCurrentActivitySpace(AActivitySpace owner,
java.lang.String strASName)
Checks if the current Activityspace is the specified Activityspace type, E.g. |
static boolean |
IsCurrentDisplayPage(AActivitySpace owner,
java.lang.String strPageName)
Checks if the current DisplayPage is the specified DisplayPage type, E.g. |
static boolean |
IsCurrentPageInEditDefaultProfileMode(AActivitySpace owner)
Checks if the current page is an Edit Default Profile page. |
static boolean |
IsCurrentPageInPreviewMode(AActivitySpace owner)
Checks if the current Page is a Preview Page. |
static boolean |
UseFriendlyURLS(int classId)
Checks whether the classId supports friendly URLs This method is primarily used to check if specific opener links should generate friendly URLs or regular opener URLs. |
static boolean |
UseFriendlyURLS(int classId,
java.lang.String queryStringArgs)
Checks whether the classId supports friendly URLs also considering any additional query string parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int INVALID_OBJECTID
Constructor Detail |
---|
public TaskAPIUICommon()
Method Detail |
---|
public static final AActivitySpace GetEnvTypeObject(IEnvironment env) throws XPIllegalArgumentException, XPClassCastException
env
- IEnvironment type
XPIllegalArgumentException
- If the provided IEnvironment is null
XPClassCastException
- If the provided IEnvironment is not of the required AActivityspace typepublic static final AActivitySpace GetMyPageOrCommunityAActivitySpace(IEnvironment env) throws XPIllegalArgumentException, XPClassCastException
env
- IEnvironment type
XPIllegalArgumentException
- If the provided IEnvironment is null
XPClassCastException
public static FullURL[] GetFullURLFromListEntryIterator(AActivitySpace owner, ICPListEntryIterator cpList)
ICPListEntryIterator
object to an array with FullURL
s.
Used for backwards compatibility.
owner
- Current Activityspace.cpList
- ICPListEntryIterator with URL data.
FullURL
objects with the URL, URL Title from the ICPListEntryIterator
.
Icons and other components are not included.public static final IPTSession GetPTSession(AActivitySpace owner)
owner
- Current Activityspace.
XPIllegalArgumentException
- If the provided AActivityspace is null
.
XPClassCastException
- If the provided AActivityspace has not been initialized correctly.public static boolean GetNavigationModelExists(AActivitySpace owner)
owner
- Current Activityspace object.
true
implies the NavigationModel is present, false
otherwise.
XPIllegalArgumentException
- If the provided AActivityspace is nullpublic static NavigationModel GetNavigationModel(AActivitySpace owner)
NavigationModel
.
owner
- AActivityspace object
XPIllegalArgumentException
- If the provided AActivityspace is null
or the NavigationModel
is not available on the current Activity Space.public static boolean GetASModelExist(AActivitySpace owner, java.lang.String strModelName)
owner
- Current Activityspace.strModelName
- Name of the Model object, defined as a static constant on every model object
named STR_MVC_CLASS_NAME
true
if the specified model exists on the activutyspace, false
otherwise.public static java.lang.Object GetASModel(AActivitySpace owner, java.lang.String strModelName)
owner
- Current Activityspace.strModelName
- Name of the Model object, defined as a static constant on every model object
named STR_MVC_CLASS_NAME
null
if it does not exist.public static MyPortalModel GetMyPortalPageModel(AActivitySpace owner)
MyPortalModel
object.
owner
- Current Activityspace.
MyPortalModel
object, or null
if MyPortalModel was not foundpublic static boolean GetMyPortalPageModelExists(AActivitySpace owner)
MyPortalModel
exists in the current Activityspace.
owner
- Current Activityspace.
true
if the MyPortalModel exists, false
otherwise.public static SiteMapModel GetSiteMapPageModel(AActivitySpace owner)
SiteMapModel
object.
owner
- Current Activityspace.
SiteMapModel
object, or null
if MyPortalModel was not foundpublic static boolean GetSiteMapPageModelExists(AActivitySpace owner)
SiteMapModel
exists in the current Activityspace.
owner
- Current Activityspace.
true
if the SiteMapModel exists, false
otherwise.public static GatewayModel GetGatewayPageModel(AActivitySpace owner)
GatewayModel
object.
owner
- Current Activityspace.
SiteMapModel
object, or null
if GatewayModel was not foundpublic static boolean GetGatewayPageModelExists(AActivitySpace owner)
GatewayModel
exists in the current Activityspace.
owner
- Current Activityspace.
true
if the GatewayModel exists, false
otherwise.public static java.lang.String GetActivitySpaceName(AActivitySpace owner)
owner
- Current Activityspace.
public static boolean IsCurrentPageInPreviewMode(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current page
is a preview page, false otherwise.public static boolean IsCurrentPageInEditDefaultProfileMode(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current page is a Edit Default Profile page, false
otherwise.public static boolean IsCurrentActivitySpace(AActivitySpace owner, java.lang.String strASName)
owner
- Current Activityspace.strASName
- Name of Activityspace type to check for.
true
if the current Activityspace is of the specified type, false
if not or Activityspace name is null
.public static boolean IsCurrentDisplayPage(AActivitySpace owner, java.lang.String strPageName)
owner
- Current Activityspace.strPageName
- Name of the DisplayPage, defined on each DisplayPage as a static constant named
STR_MVC_CLASS_NAME
.
true
if the current DisplayPage is of the specified type, false
if not or DisplayPage name is null
.public static final boolean UseFriendlyURLS(int classId)
classId
- Class Id of the object type to create URL for
public static final boolean UseFriendlyURLS(int classId, java.lang.String queryStringArgs)
classId
- Class Id of the object type to create URL forqueryStringArgs
- Any query string parameters on the URL
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |