|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.classtypedescriptors.APTClassTypeDesc
public abstract class APTClassTypeDesc
Parent implementation for PTClassTypeDesc. This class will be extended by classes which define extensible and non-extensible PTClassTypeDescs. This class implements GetRedirectViewObjectMetaData (standard for most, to be overriden by some), GetRedirectViewObject (which defers to GetRedirectOpenObject), and provides some helper methods for retrieving arguments. If a specific class type needs to be supported by the Object Lock Manager / "Admin UI->Release Item Locks" page, extending class should simply implement a default constructor and set the values of hasObjectLockManager, objectLockManagerMsgID and objectLockManagerMsgFileName fields accordingly. By default, this abstract class will set these values to not support Object Lock Manager
Field Summary | |
---|---|
protected boolean |
hasObjectLockManager
|
protected java.lang.String |
objectLockManagerMsgFileName
|
protected int |
objectLockManagerMsgID
|
Constructor Summary | |
---|---|
APTClassTypeDesc()
|
Method Summary | |
---|---|
boolean |
AppearsInGlobalObjPropMap()
Returns a boolean that tells the client if this class type appears in the global object property map utility. |
abstract boolean |
AppearsInMainCreateNewClassMenu()
Returns a boolean that tells the client if this class type should appear in the main create new object menu. |
java.lang.String |
ConstructFriendlyURL(FriendlyURL url,
AActivitySpace space)
Generates a friendly URL to the implementing class type. |
abstract int |
GetClassID()
Returns the class ID of the class type. |
java.lang.String |
GetClassKey()
Returns the key for this class type. |
ClassTypeEnum |
GetClassType()
Returns the class type. |
abstract java.lang.String |
GetClassTypeLocalizedName(java.lang.String _strLangID)
Returns the localized name for the class type. |
abstract int |
GetCreateActivityID()
This method returns the Activity Rights ID that the user needs to have in order to have access to make changes to this class type. |
abstract HTMLImg |
GetDefaultIcon()
Returns the default icon for items of this class type. |
int |
GetDefaultOpenerMode()
Returns the default opener mode for this class type. |
int[] |
GetDependentClassTypeIDs()
This method lets you specify what kind of PTClassTypes depend on this PTClassType. |
java.lang.String |
GetObjectLockManagerLocalizedName(java.lang.String strLangID)
Returns the localized name that will be displayed on the left navigation menu of "Admin UI->Release Item Locks" page. |
abstract Redirect |
GetRedirectCreateNew(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the create mode. |
abstract Redirect |
GetRedirectOpenObject(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the edit mode. |
Redirect |
GetRedirectSearchBrowse(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the search basic mode. |
Redirect |
GetRedirectSearchEdit(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the search basic mode. |
Redirect |
GetRedirectViewObject(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the view mode. |
Redirect |
GetRedirectViewObjectMetaData(XPHashtable _htArguments,
AActivitySpace _asParent,
java.lang.Object _userSession)
This method is called by the Common Opener in the meta mode. |
abstract int[] |
GetRelatedClassTypeIDs()
This method lets you associate the class ID for this PTClassType with other class IDs. |
boolean |
HasCreateActivityRight(IPTSession _ptSession)
Returns a boolean indicating whether the user has enough rights to make changes to this class type. |
abstract boolean |
HasGlobalClassTypeMap()
Returns a boolean that tells the client if this class type is on the global class type map. |
boolean |
HasObjectLockManager()
Returns a boolean that tells the client if this class included/supported on the "Admin UI->Release Item Locks" page. |
abstract boolean |
IsExtensible()
Returns a boolean that tells the client if this class type is extensible. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean hasObjectLockManager
protected int objectLockManagerMsgID
protected java.lang.String objectLockManagerMsgFileName
Constructor Detail |
---|
public APTClassTypeDesc()
Method Detail |
---|
public abstract boolean AppearsInMainCreateNewClassMenu()
IPTClassTypeDesc
AppearsInMainCreateNewClassMenu
in interface IPTClassTypeDesc
public boolean AppearsInGlobalObjPropMap()
IPTClassTypeDesc
AppearsInGlobalObjPropMap
in interface IPTClassTypeDesc
public abstract int GetClassID()
IPTClassTypeDesc
GetClassID
in interface IPTClassTypeDesc
public java.lang.String GetClassKey()
IClassTypeDesc
GetClassKey
in interface IClassTypeDesc
public ClassTypeEnum GetClassType()
IClassTypeDesc
GetClassType
in interface IClassTypeDesc
public abstract java.lang.String GetClassTypeLocalizedName(java.lang.String _strLangID)
IPTClassTypeDesc
GetClassTypeLocalizedName
in interface IPTClassTypeDesc
_strLangID
- The language to retrieve the name for.
public abstract int GetCreateActivityID()
public abstract HTMLImg GetDefaultIcon()
IPTClassTypeDesc
GetDefaultIcon
in interface IPTClassTypeDesc
public int GetDefaultOpenerMode()
IClassTypeDesc
GetDefaultOpenerMode
in interface IClassTypeDesc
public abstract Redirect GetRedirectCreateNew(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IClassTypeDesc
GetRedirectCreateNew
in interface IClassTypeDesc
_htArguments
- Arguments to reach the new space._asParent
- The parent activity space._userSession
- The current session.
public abstract Redirect GetRedirectOpenObject(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IClassTypeDesc
GetRedirectOpenObject
in interface IClassTypeDesc
_htArguments
- Arguments to reach the new space._asParent
- The parent activity space._userSession
- The current session.
public Redirect GetRedirectSearchBrowse(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IClassTypeDesc
GetRedirectSearchBrowse
in interface IClassTypeDesc
_htArguments
- Arguments to reach the new space._asParent
- The parent activity space._userSession
- The current session.
public Redirect GetRedirectSearchEdit(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IClassTypeDesc
GetRedirectSearchEdit
in interface IClassTypeDesc
_htArguments
- Arguments to reach the new space._asParent
- The parent activity space._userSession
- The current session.
public Redirect GetRedirectViewObject(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IPTClassTypeDesc
GetRedirectViewObject
in interface IPTClassTypeDesc
GetRedirectViewObject
in interface IClassTypeDesc
_htArguments
- contains the URL path._asParent
- The parent activity space._userSession
- The current session.
public Redirect GetRedirectViewObjectMetaData(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
IClassTypeDesc
GetRedirectViewObjectMetaData
in interface IClassTypeDesc
_htArguments
- Arguments to reach the new space._asParent
- The parent activity space._userSession
- The current session.
public abstract int[] GetRelatedClassTypeIDs()
IPTClassTypeDesc
GetRelatedClassTypeIDs
in interface IPTClassTypeDesc
public int[] GetDependentClassTypeIDs()
IPTClassTypeDesc
GetDependentClassTypeIDs
in interface IPTClassTypeDesc
public boolean HasCreateActivityRight(IPTSession _ptSession)
_ptSession
- The current Plumtree session.
public abstract boolean HasGlobalClassTypeMap()
IPTClassTypeDesc
HasGlobalClassTypeMap
in interface IPTClassTypeDesc
public abstract boolean IsExtensible()
IPTClassTypeDesc
IsExtensible
in interface IPTClassTypeDesc
public boolean HasObjectLockManager()
IPTClassTypeDesc
HasObjectLockManager
in interface IPTClassTypeDesc
public java.lang.String GetObjectLockManagerLocalizedName(java.lang.String strLangID)
IPTClassTypeDesc
GetObjectLockManagerLocalizedName
in interface IPTClassTypeDesc
public java.lang.String ConstructFriendlyURL(FriendlyURL url, AActivitySpace space)
IPTClassTypeDesc
ConstructFriendlyURL
in interface IPTClassTypeDesc
url
- FriendlyURL containing the information for the url
IPTClassTypeDesc#ConstructFriendlyURL(String, int, String)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |