com.plumtree.uiinfrastructure.opener.types
Interface IClassTypeDesc

All Known Subinterfaces:
IPTClassTypeDesc, IPTClassTypeDesc, IUIClassTypeDesc
All Known Implementing Classes:
APTClassTypeDesc, APTClassTypeDesc, APTExtClassTypeDesc, APTExtClassTypeDesc, APTNonExtClassTypeDesc, APTNonExtClassTypeDesc, AUIClassTypeDesc, PTAdminFolders, PTAuthSources, PTCommunities, PTCommunityTemplates, PTCrawlers, PTDataSources, PTDocFolders, PTDocTypes, PTDocuments, PTExternalOperations, PTFilters, PTGlobalObjects, PTGroups, PTGuestLogins, PTInvitations, PTJobs, PTMyPages, PTNetworkedSearches, PTPages, PTPageTemplates, PTPortletBundles, PTPortlets, PTPortletTemplates, PTProfilePages, PTProfileSections, PTProfileSources, PTProperties, PTRemoteServers, PTSavedSearches, PTSiteMapFolders, PTSubPortals, PTTaxonomist, PTUsers, PTWebServices, UIActivitySpaces, UIGateway

public interface IClassTypeDesc

Interface for IClassTypeDesc.

Author:
John Osborne

Method Summary
 java.lang.String GetClassKey()
          Returns the key for this class type.
 ClassTypeEnum GetClassType()
          Returns the class type.
 int GetDefaultOpenerMode()
          Returns the default opener mode for this class type.
 Redirect GetRedirectCreateNew(XPHashtable _htArguments, AActivitySpace _asParent, java.lang.Object _userSession)
          This method is called by the Common Opener in the create mode.
 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.
 

Method Detail

GetClassType

ClassTypeEnum GetClassType()
Returns the class type.

Returns:
The class type.

GetClassKey

java.lang.String GetClassKey()
Returns the key for this class type.

Returns:
The key for this class type.

GetDefaultOpenerMode

int GetDefaultOpenerMode()
Returns the default opener mode for this class type.

Returns:
The default opener mode for this class type.

GetRedirectCreateNew

Redirect GetRedirectCreateNew(XPHashtable _htArguments,
                              AActivitySpace _asParent,
                              java.lang.Object _userSession)
This method is called by the Common Opener in the create mode. Depending on what class type you are dealing with, the Common Opener will invoke the correct implemented method. Some class types may need to override this so that they can put additional control arguments in.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the create activity space for the particular class/object.

GetRedirectOpenObject

Redirect GetRedirectOpenObject(XPHashtable _htArguments,
                               AActivitySpace _asParent,
                               java.lang.Object _userSession)
This method is called by the Common Opener in the edit mode. Depending on what class type you are dealing with, the Common Opener will invoke the correct implemented method. Some class types may need to override this so that they can put additional control arguments in.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the edit activity space for the particular class/object.

GetRedirectSearchBrowse

Redirect GetRedirectSearchBrowse(XPHashtable _htArguments,
                                 AActivitySpace _asParent,
                                 java.lang.Object _userSession)
This method is called by the Common Opener in the search basic mode. This is a helper method that will return one of the four main modes.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the meta activity space for the particular class/object.

GetRedirectSearchEdit

Redirect GetRedirectSearchEdit(XPHashtable _htArguments,
                               AActivitySpace _asParent,
                               java.lang.Object _userSession)
This method is called by the Common Opener in the search basic mode. This is a helper method that will return one of the four main modes.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the meta activity space for the particular class/object.

GetRedirectViewObject

Redirect GetRedirectViewObject(XPHashtable _htArguments,
                               AActivitySpace _asParent,
                               java.lang.Object _userSession)
This method is called by the Common Opener in the view mode. Depending on what class type you are dealing with, the Common Opener will invoke the correct implemented method. Some class types may need to override this so that they can put additional control arguments in.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the view activity space for the particular class/object.

GetRedirectViewObjectMetaData

Redirect GetRedirectViewObjectMetaData(XPHashtable _htArguments,
                                       AActivitySpace _asParent,
                                       java.lang.Object _userSession)
This method is called by the Common Opener in the meta mode. Depending on what class type you are dealing with, the Common Opener will invoke the correct implemented method. Some class types may need to override this so that they can put additional control arguments in.

Parameters:
_htArguments - Arguments to reach the new space.
_asParent - The parent activity space.
_userSession - The current session.
Returns:
A redirect that will bring you to the meta activity space for the particular class/object.



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