com.opencms.defaults
Class A_CmsBackoffice

java.lang.Object
  |
  +--com.opencms.template.A_CmsTemplate
        |
        +--com.opencms.template.CmsXmlTemplate
              |
              +--com.opencms.workplace.CmsWorkplaceDefault
                    |
                    +--com.opencms.defaults.A_CmsBackoffice

All Implemented Interfaces:

I_CmsConstants, I_CmsLogChannels, I_CmsTemplate, I_CmsWpConstants, I_CmsXmlTemplate

Direct Known Subclasses:

A_CmsChannelBackoffice, CmsChannelBackoffice

public abstract class A_CmsBackoffice

extends CmsWorkplaceDefault

implements I_CmsConstants

Abstract class for generic backoffice display. It automatically generates the

• head section with filters and buttons,
• body section with the table data,
• lock states of the entries. if there are any,
• delete dialog,
• lock dialog.

calls the

• edit dialog of the calling backoffice class
• new dialog of the calling backoffice class

using the content definition class defined by the getContentDefinition method. The methods and data provided by the content definition class is accessed by reflection. This way it is possible to re-use this class for any content definition class, that just has to extend the A_CmsContentDefinition class! Creation date: (27.10.00 10:04:42)

Version:

$Revision: 1.58 $

Author:

Michael Knoll, Michael Emmerich

Field Summary

protected static String[]	C_ACCESS_FLAGS
protected static int	C_DEFAULT_PERMISSIONS Default value of permission
static int	C_NO_ACCESS
static int	C_NOT_LOCKED

Fields inherited from class com.opencms.template.CmsXmlTemplate

C_BODY_ELEMENT, C_DEBUG, C_FRAME_SELECTOR, m_cache

Fields inherited from interface com.opencms.core.I_CmsConstants

C_ACCESS_DEFAULT_FLAGS, C_ACCESS_GROUP, C_ACCESS_GROUP_READ, C_ACCESS_GROUP_VISIBLE, C_ACCESS_GROUP_WRITE, C_ACCESS_INTERNAL_READ, C_ACCESS_OWNER, C_ACCESS_OWNER_READ, C_ACCESS_OWNER_VISIBLE, C_ACCESS_OWNER_WRITE, C_ACCESS_PUBLIC, C_ACCESS_PUBLIC_READ, C_ACCESS_PUBLIC_VISIBLE, C_ACCESS_PUBLIC_WRITE, C_ACCESS_READ, C_ACCESS_VISIBLE, C_ACCESS_WRITE, C_ADDITIONAL_INFO_EXPLORERSETTINGS, C_ADDITIONAL_INFO_PREFERENCES, C_ADDITIONAL_INFO_STARTSETTINGS, C_ADDITIONAL_INFO_TASKSETTINGS, C_ADDITIONAL_INFO_TOWN, C_ADDITIONAL_INFO_ZIPCODE, C_AT_LEAST_ONCE, C_CLUSTERURL, C_CONFIGURATION_CACHE, C_CONFIGURATION_CLASS, C_CONFIGURATION_REGISTRY, C_CONFIGURATION_RESOURCEBROKER, C_COPYRIGHT, C_DEFAULT_SITE, C_DELETE_HISTORY, C_ENABLE_HISTORY, C_ERRPREFIX, C_ERRSPERATOR, C_EXPORT_TAG_ACCESS, C_EXPORT_TAG_ADDRESS, C_EXPORT_TAG_CREATOR, C_EXPORT_TAG_DATE, C_EXPORT_TAG_DEFAULTGROUP, C_EXPORT_TAG_DESCRIPTION, C_EXPORT_TAG_DESTINATION, C_EXPORT_TAG_EMAIL, C_EXPORT_TAG_EXPORT, C_EXPORT_TAG_FILE, C_EXPORT_TAG_FIRSTNAME, C_EXPORT_TAG_FLAGS, C_EXPORT_TAG_GROUP, C_EXPORT_TAG_GROUPDATA, C_EXPORT_TAG_GROUPNAME, C_EXPORT_TAG_INFO, C_EXPORT_TAG_LASTMODIFIED, C_EXPORT_TAG_LASTNAME, C_EXPORT_TAG_LAUNCHER_START_CLASS, C_EXPORT_TAG_MODULEXPORT, C_EXPORT_TAG_NAME, C_EXPORT_TAG_OC_VERSION, C_EXPORT_TAG_PARENTGROUP, C_EXPORT_TAG_PASSWORD, C_EXPORT_TAG_PROJECT, C_EXPORT_TAG_PROPERTIES, C_EXPORT_TAG_PROPERTY, C_EXPORT_TAG_RECOVERYPASSWORD, C_EXPORT_TAG_SECTION, C_EXPORT_TAG_SOURCE, C_EXPORT_TAG_TYPE, C_EXPORT_TAG_USER, C_EXPORT_TAG_USERDATA, C_EXPORT_TAG_USERGROUPDATA, C_EXPORT_TAG_USERGROUPS, C_EXPORT_TAG_USERINFO, C_EXPORT_TAG_VALUE, C_EXPORT_TAG_VERSION, C_EXPORT_VERSION, C_EXPORT_XMLFILENAME, C_EXPORTONLYFILES, C_EXPORTONLYUSERS, C_EXPORTPOINT, C_EXPORTPOINT_PATH, C_EXPORTUSERSFILES, C_FCONTENT, C_FELEMENT, C_FILE, C_FILECONTENT, C_FILES_IMPORTED, C_FLAG_DISABLED, C_FLAG_ENABLED, C_FLAG_GROUP_PROJECTCOWORKER, C_FLAG_GROUP_PROJECTMANAGER, C_FLAG_GROUP_ROLE, C_FOLDER, C_FOLDER_SEPARATOR, C_GROUP, C_GROUP_ADMIN, C_GROUP_GUEST, C_GROUP_PROJECTLEADER, C_GROUP_USERS, C_LINKCHECKTABLE_DATE, C_MAX_LENGTH_RESOURCE_NAME, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES, C_MODULE_PROPERTY_ADDITIONAL_RESOURCES_SEPARATOR, C_MODUS_AUTO, C_MODUS_EXPORT, C_MODUS_EXTERN, C_MODUS_OFFLINE, C_MODUS_ONLINE, C_MOUNTPOINT_FILESYSTEM, C_MOUNTPOINT_MYSQL, C_NEVER, C_NO_FILES_IMPORTED, C_ORDER_AGENTUSER, C_ORDER_ENDTIME, C_ORDER_ID, C_ORDER_INITIATORUSER, C_ORDER_NAME, C_ORDER_ORIGINALUSER, C_ORDER_PERCENTAGE, C_ORDER_PRIORITY, C_ORDER_ROLE, C_ORDER_STARTTIME, C_ORDER_STATE, C_ORDER_TASKTYPE, C_ORDER_TIMEOUT, C_ORDER_WAKEUPTIME, C_PASSWORD_MINIMUMSIZE, C_PROJECT_ONLINE, C_PROJECT_ONLINE_ID, C_PROJECT_STATE_ARCHIVE, C_PROJECT_STATE_INVISIBLE, C_PROJECT_STATE_LOCKED, C_PROJECT_STATE_UNLOCKED, C_PROJECT_TYPE_INVISIBLE, C_PROJECT_TYPE_NORMAL, C_PROJECT_TYPE_TEMPORARY, C_PROPERTY_ACTIV, C_PROPERTY_CHANNELID, C_PROPERTY_CONTENT_ENCODING, C_PROPERTY_DEFAULT_FILE, C_PROPERTY_DESCRIPTION, C_PROPERTY_EXPORT, C_PROPERTY_EXPORTNAME, C_PROPERTY_KEYWORDS, C_PROPERTY_NAVPOS, C_PROPERTY_NAVTEXT, C_PROPERTY_RELATIVEROOT, C_PROPERTY_TEMPLATETYPE, C_PROPERTY_TITLE, C_PROPERTY_VISIBLE, C_PUBLISH_METHOD_LINK, C_REGISTRY_DESTINATION, C_REGISTRY_HISTORY, C_REGISTRY_KNOWNLAUNCHERS, C_REGISTRY_LAUNCHER, C_REGISTRY_SOURCE, C_REQUEST_CONSOLE, C_REQUEST_HTTP, C_RESPONSE_CONSOLE, C_RESPONSE_HTTP, C_ROOT, C_ROOT_TEMPLATE_NAME, C_ROOTNAME_COS, C_ROOTNAME_VFS, C_SESSION_ADMIN_POS, C_SESSION_BROADCASTMESSAGE, C_SESSION_CONTENT_ENCODING, C_SESSION_CURRENTGROUP, C_SESSION_DATA, C_SESSION_IS_DIRTY, C_SESSION_MESSAGEPENDING, C_SESSION_MODULE_VECTOR, C_SESSION_PROJECT, C_SESSION_THREAD_ERROR, C_SESSION_USERNAME, C_SORT_ASC, C_SORT_DESC, C_START_ACCESSFLAGS, C_START_DEFAULTGROUP, C_START_LANGUAGE, C_START_LOCKDIALOG, C_START_PROJECT, C_START_VIEW, C_STATE_CHANGED, C_STATE_DELETED, C_STATE_NEW, C_STATE_UNCHANGED, C_STATICEXPORT_PATH, C_STATICEXPORT_START, C_SYNCHRONISATION_PATH, C_SYNCHRONISATION_PROJECT, C_SYNCHRONISATION_RESOURCE, C_SYNCHRONISATION_RESOURCETAG, C_SYSTEMPROPERTY_CRONTABLE, C_SYSTEMPROPERTY_EXPORTPATH, C_SYSTEMPROPERTY_EXTENSIONS, C_SYSTEMPROPERTY_LINKCHECKTABLE, C_SYSTEMPROPERTY_MIMETYPES, C_SYSTEMPROPERTY_MOUNTPOINT, C_SYSTEMPROPERTY_RESOURCE_TYPE, C_TABLE_CHANNELID, C_TASK_FILTER, C_TASK_MESSAGES, C_TASK_MESSAGES_ACCEPTED, C_TASK_MESSAGES_COMPLETED, C_TASK_MESSAGES_FORWARDED, C_TASK_MESSAGES_MEMBERS, C_TASK_ORDER_BY_DATE, C_TASK_ORDER_BY_NAME, C_TASK_PRIORITY_HIGH, C_TASK_PRIORITY_LOW, C_TASK_PRIORITY_NORMAL, C_TASK_STATE_ENDED, C_TASK_STATE_HALTED, C_TASK_STATE_NOTENDED, C_TASK_STATE_PREPARE, C_TASK_STATE_START, C_TASK_STATE_STARTED, C_TASK_VIEW_ALL, C_TASKLOG_SYSTEM, C_TASKLOG_USER, C_TASKORDER_NONE, C_TASKORDER_STARTDATE, C_TASKORDER_TIMEOUT, C_TASKS_ACTIVE, C_TASKS_ALL, C_TASKS_DONE, C_TASKS_NEW, C_TASKS_OPEN, C_TASKSORDER_TASKNAME, C_TEMP_PREFIX, C_TFACCESS, C_TFGROUP, C_TFILEOBJ, C_TFILES, C_TFNAME, C_TFPROPERTYINFO, C_TFPROPERTYNAME, C_TFPROPERTYTYPE, C_TFPROPERTYVALUE, C_TFTYPE, C_TFTYPENAME, C_TFUSER, C_TGDESC, C_TGFLAG, C_TGNAME, C_TGPARENTGROUP, C_TGROUPOBJ, C_TGROUPS, C_TGROUPUSERS, C_TGUSER, C_TUADDINFO, C_TUDESC, C_TUDGROUP, C_TUDISABLED, C_TUEMAIL, C_TUFIRSTNAME, C_TUFLAG, C_TUGROUP, C_TUINFOKEY, C_TUINFOVALUE, C_TULOGIN, C_TUNAME, C_TUPASSWD, C_TUSERGROUPS, C_TUSEROBJ, C_TUSERS, C_TYPE_BODY_NAME, C_TYPE_COMPATIBLEPLAIN_NAME, C_TYPE_FOLDER, C_TYPE_FOLDER_NAME, C_TYPE_IMAGE_NAME, C_TYPE_LAST_INDEX, C_TYPE_PAGE_NAME, C_TYPE_PLAIN_NAME, C_UNKNOWN_ID, C_UNKNOWN_INT, C_UNKNOWN_LAUNCHER, C_UNKNOWN_LAUNCHER_ID, C_UNKNOWN_LONG, C_URL_PREFIX_EXPORT, C_URL_PREFIX_HTTP, C_URL_PREFIX_HTTPS, C_URL_PREFIX_SERVERNAME, C_USER, C_USER_ADMIN, C_USER_GUEST, C_USER_TYPE_SYSTEMANDWEBUSER, C_USER_TYPE_SYSTEMUSER, C_USER_TYPE_WEBUSER, C_WEB_APP_REPLACE_KEY, C_WEEKS_HISTORY, C_WHATEVER, C_XML_BODY_ELEMENT

Fields inherited from interface com.opencms.workplace.I_CmsWpConstants

C_ADMIN_BACK_BUTTON, C_BOXTEMPLATE, C_BUTTON_ACTION, C_BUTTON_ALT, C_BUTTON_HREF, C_BUTTON_METHOD, C_BUTTON_NAME, C_BUTTON_STYLE, C_BUTTON_VALUE, C_BUTTON_WIDTH, C_BUTTONTEMPLATE, C_CONTEXTMENUE_TEMPLATEFILE, C_DEFAULT_LANGUAGE, C_DOWNBROWSER_MAXENTRIES, C_EDIT_ACTION_EXIT, C_EDIT_ACTION_SAVE, C_EDIT_ACTION_SAVEEXIT, C_ERROR_LINK, C_ERROR_MESSAGE, C_ERROR_MSG_BUTTON, C_ERROR_MSG_DETAILS, C_ERROR_MSG_REASON, C_ERROR_REASON, C_ERROR_SUGGESTION, C_ERROR_TITLE, C_ERRORTEMPLATE, C_FILELIST_ACCESS, C_FILELIST_ACCESS_VALUE, C_FILELIST_CHANGED, C_FILELIST_CHANGED_VALUE, C_FILELIST_CLASS_VALUE, C_FILELIST_COLUMN_ACCESS, C_FILELIST_COLUMN_CHANGED, C_FILELIST_COLUMN_CUSTOMIZED, C_FILELIST_COLUMN_CUSTOMIZED_VALUE, C_FILELIST_COLUMN_GROUP, C_FILELIST_COLUMN_LOCKED, C_FILELIST_COLUMN_NAME, C_FILELIST_COLUMN_OWNER, C_FILELIST_COLUMN_SIZE, C_FILELIST_COLUMN_STATE, C_FILELIST_COLUMN_TITLE, C_FILELIST_COLUMN_TYPE, C_FILELIST_CUSTOMTEMPLATE, C_FILELIST_DISPLAYMETHOD, C_FILELIST_GROUP, C_FILELIST_GROUP_VALUE, C_FILELIST_ICON_VALUE, C_FILELIST_LINK_VALUE, C_FILELIST_LOCK_VALUE, C_FILELIST_LOCKED, C_FILELIST_LOCKED_VALUE, C_FILELIST_METHOD, C_FILELIST_NAME, C_FILELIST_NAME_VALUE, C_FILELIST_OWNER, C_FILELIST_OWNER_VALUE, C_FILELIST_SIZE, C_FILELIST_SIZE_VALUE, C_FILELIST_STATE, C_FILELIST_STATE_VALUE, C_FILELIST_SUFFIX_VALUE, C_FILELIST_TEMPLATE, C_FILELIST_TITLE, C_FILELIST_TITLE_VALUE, C_FILELIST_TYPE, C_FILELIST_TYPE_VALUE, C_FILETYPELIST_TEMPLATEFILE, C_GROUPS_NAME, C_ICON_ACTION, C_ICON_ACTIVE_METHOD, C_ICON_DEFAULT, C_ICON_EXTENSION, C_ICON_HREF, C_ICON_LABEL, C_ICON_NAME, C_ICON_PREFIX, C_ICON_TARGET, C_ICON_TEMPLATEFILE, C_ICON_VISIBLE_METHOD, C_INPUT_ACTION, C_INPUT_CLASS, C_INPUT_LENGTH, C_INPUT_METHOD, C_INPUT_NAME, C_INPUT_SIZE, C_INPUT_VALUE, C_INPUTTEMPLATE, C_LABEL_VALUE, C_LABELTEMPLATE, C_LANG_BUTTON, C_LANG_ICON, C_LANG_LABEL, C_LANG_TITLE, C_MACRO_OPENCMS_CONTEXT, C_MESSAGE_BUTTON1, C_MESSAGE_BUTTON2, C_MESSAGE_FILENAME, C_MESSAGE_LINK1, C_MESSAGE_LINK2, C_MESSAGE_MESSAGE1, C_MESSAGE_MESSAGE2, C_MESSAGE_TITLE, C_MODULE_PACKETNAME, C_MODULELIST_AUTHOR, C_MODULELIST_DATECREATED, C_MODULELIST_DATEUPLOADED, C_MODULELIST_IDX, C_MODULELIST_METHOD, C_MODULELIST_NAME, C_MODULELIST_NICE_NAME, C_MODULELIST_TEMPLATEFILE, C_MODULELIST_VERSION, C_PANEL_EXPLORER, C_PANEL_LINK, C_PANEL_NAME, C_PANEL_START, C_PANEL_TASK, C_PANEL_USER, C_PANELTEMPLATE, C_PARA_ACTION, C_PARA_CANCEL, C_PARA_CONTENT, C_PARA_DEFAULT, C_PARA_DELETE, C_PARA_DESCRIPTION, C_PARA_EXPLORERSETTINGS, C_PARA_FILE, C_PARA_FILECONTENT, C_PARA_FILELIST, C_PARA_FILTER, C_PARA_FLAGS, C_PARA_FOLDER, C_PARA_FOLDERTREE, C_PARA_FORMNAME, C_PARA_INITIAL, C_PARA_JSFILE, C_PARA_KEYWORDS, C_PARA_LAYOUT, C_PARA_LINK, C_PARA_LOCK, C_PARA_MAXPAGE, C_PARA_NAME, C_PARA_NAVPOS, C_PARA_NAVTEXT, C_PARA_NEWACCESS, C_PARA_NEWFILE, C_PARA_NEWFOLDER, C_PARA_NEWGROUP, C_PARA_NEWOWNER, C_PARA_NEWPWD, C_PARA_NEWPWDREPEAT, C_PARA_NEWTYPE, C_PARA_OK, C_PARA_OLDPANEL, C_PARA_OLDPWD, C_PARA_PAGE, C_PARA_PANEL, C_PARA_PREVIOUSLIST, C_PARA_PROJECT, C_PARA_PROPERTYDEF, C_PARA_STARTPROJECTID, C_PARA_STARTSETTINGS, C_PARA_STARTTASKID, C_PARA_SUBMIT, C_PARA_TASKSETTINGS, C_PARA_TEMPLATE, C_PARA_TITLE, C_PARA_UNLOCK, C_PARA_URL, C_PARA_USERSETTINGS, C_PARA_VARIABLE, C_PARA_VIEW, C_PARA_VIEWFILE, C_PICBROWSER_MAXIMAGES, C_PREFERENCES_UPDATE, C_PREFSSCROLLER_TEMPLATEFILE, C_PROJECTLIST_DATECREATED, C_PROJECTLIST_DESCRIPTION, C_PROJECTLIST_IDX, C_PROJECTLIST_LOCKSTATE, C_PROJECTLIST_MENU, C_PROJECTLIST_METHOD, C_PROJECTLIST_NAME, C_PROJECTLIST_NAME_ESCAPED, C_PROJECTLIST_OWNER, C_PROJECTLIST_PROJECTID, C_PROJECTLIST_PROJECTMANAGER, C_PROJECTLIST_PROJECTWORKER, C_PROJECTLIST_STATE, C_PROJECTLIST_STATE_LOCKED, C_PROJECTLIST_STATE_UNLOCKED, C_PROJECTLIST_TEMPLATEFILE, C_PROJECTNEW_DESCRIPTION, C_PROJECTNEW_DONE, C_PROJECTNEW_ERROR, C_PROJECTNEW_FOLDER, C_PROJECTNEW_GROUP, C_PROJECTNEW_MANAGERGROUP, C_PROJECTNEW_NAME, C_PROJECTNEW_TYPE, C_RADIO_IMAGEENTRY, C_RADIO_IMAGENAME, C_RADIO_IMAGEOPTION, C_RADIO_LINK, C_RADIO_METHOD, C_RADIO_NAME, C_RADIO_ORDER, C_RADIO_RADIONAME, C_RADIO_SELECTEDENTRY, C_RADIO_SELECTEDOPTION, C_RADIOTEMPLATE, C_SELECTBOX_CLASS, C_SELECTBOX_CLASSNAME, C_SELECTBOX_DIV, C_SELECTBOX_EDITORVIEWS, C_SELECTBOX_EDITORVIEWS_ALLOWED, C_SELECTBOX_EDITORVIEWS_CLASSES, C_SELECTBOX_EDITORVIEWS_DEFAULT, C_SELECTBOX_EDITORVIEWS_TEMPLATES, C_SELECTBOX_FONTS, C_SELECTBOX_METHOD, C_SELECTBOX_NAME, C_SELECTBOX_ONCHANGE, C_SELECTBOX_OPTIONNAME, C_SELECTBOX_OPTIONVALUE, C_SELECTBOX_SIZE, C_SELECTBOX_WIDTH, C_SESSION_MODULE_ADMIN_DATA, C_SESSION_MODULE_ADMIN_PROP_DESCR, C_SESSION_MODULE_ADMIN_PROP_NAMES, C_SESSION_MODULE_ADMIN_PROP_TYP, C_SESSION_MODULE_ADMIN_PROP_VAL, C_SESSION_MODULE_CHECKSUM, C_SESSION_MODULE_DELETE_STEP, C_SESSION_MODULE_EXCLUSION, C_SESSION_MODULE_INUSE, C_SESSION_MODULE_MISSFILES, C_SESSION_MODULE_PROJECTFILES, C_SESSION_MODULE_PROPFILES, C_SESSION_TASK_ALLPROJECTS, C_SESSION_TASK_FILTER, C_SYSTEM_PICS_EXPORT_PATH, C_TAG_ERRORBOX, C_TAG_ERRORPAGE, C_TAG_INPUTFIELD, C_TAG_LABEL, C_TAG_MESSAGEBOX, C_TAG_MODULELIST_DEFAULT, C_TAG_PANEL_BGACTIVE, C_TAG_PANEL_BGINACTIVE, C_TAG_PANEL_ENDSEQ, C_TAG_PANEL_SEPBGTEXT, C_TAG_PANEL_STARTSEQ, C_TAG_PANEL_TEXTACTIVE, C_TAG_PANEL_TEXTINACTIVE, C_TAG_PASSWORD, C_TAG_PROJECTLIST_DEFAULT, C_TAG_PROJECTLIST_SNAPLOCK, C_TAG_SELECTBOX_CLASS, C_TAG_SELECTBOX_END, C_TAG_SELECTBOX_OPTION, C_TAG_SELECTBOX_SELOPTION, C_TAG_SELECTBOX_START, C_TAG_SELECTBOX_START_DIV, C_TAG_STARTUP, C_TAG_SUBMITBUTTON, C_TASKDOCU_TEMPLATEFILE, C_TASKLIST_TEMPLATEFILE, C_TASKLOGTYPE_ACCEPTED, C_TASKLOGTYPE_CALL, C_TASKLOGTYPE_COMMENT, C_TASKLOGTYPE_CREATED, C_TASKLOGTYPE_DUECHANGED, C_TASKLOGTYPE_FORWARDED, C_TASKLOGTYPE_OK, C_TASKLOGTYPE_PRIORITYCHANGED, C_TASKLOGTYPE_REACTIVATED, C_TASKLOGTYPE_TAKE, C_TASKPARA_ACCEPTATION, C_TASKPARA_ALL, C_TASKPARA_COMPLETION, C_TASKPARA_DELIVERY, C_USERPREF_FILELIST, C_USERS_NAME, C_VFS_DIR_DEFAULTBODIES, C_VFS_DIR_INTERNAL, C_VFS_DIR_LOCALES, C_VFS_DIR_TEMPLATES, C_VFS_GALLERY_DOWNLOAD, C_VFS_GALLERY_EXTERNALLINKS, C_VFS_GALLERY_HTML, C_VFS_GALLERY_PICS, C_VFS_NEW_STRUCTURE, C_VFS_PATH_BODIES, C_VFS_PATH_DEFAULT_BODIES, C_VFS_PATH_DEFAULT_INTERNAL, C_VFS_PATH_DEFAULT_TEMPLATES, C_VFS_PATH_DEFAULTMODULE, C_VFS_PATH_GALLERIES, C_VFS_PATH_HELP, C_VFS_PATH_LOCALES, C_VFS_PATH_MODULEDEMOS, C_VFS_PATH_MODULES, C_VFS_PATH_SCRIPTS, C_VFS_PATH_SYSTEM, C_VFS_PATH_SYSTEMPICS, C_VFS_PATH_WORKPLACE, C_WP_CHANNEL_TREE, C_WP_EXPLORER_FILELIST, C_WP_EXPLORER_PREFERENCES, C_WP_EXPLORER_TREE, C_WP_FOLDER_TREE, C_WP_RELOAD

Fields inherited from interface com.opencms.boot.I_CmsLogChannels

C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING

Constructor Summary

A_CmsBackoffice()

Method Summary

Object	checkbox(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) user-method to create a checkbox with the according hidden field
abstract String	getBackofficeUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the backoffice url of the module.
byte[]	getContent(CmsObject cms, String templateFile, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
byte[]	getContentCopy(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
protected Object	getContentDefinition(CmsObject cms, Class cdClass) Gets the content definition class method constructor
protected Object	getContentDefinition(CmsObject cms, Class cdClass, Integer id) Gets the content definition class method constructor
protected Object	getContentDefinition(CmsObject cms, Class cdClass, String id) Gets the content definition class method constructor
abstract Class	getContentDefinitionClass() Gets the content definition class
byte[]	getContentDelete(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
byte[]	getContentDirectPublish(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
String	getContentEdit(CmsObject cms, CmsXmlWpTemplateFile templateFile, A_CmsContentDefinition cd, String elementName, Enumeration keys, Hashtable parameters, String templateSelector) Gets the content of a edited entry form.
byte[]	getContentEdit(CmsObject cms, CmsXmlWpTemplateFile templateFile, String elementName, Hashtable parameters, String templateSelector) Gets the content of a edited entry form.
byte[]	getContentHistory(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
String	getContentNew(CmsObject cms, CmsXmlWpTemplateFile template, A_CmsContentDefinition cd, String elementName, Enumeration keys, Hashtable parameters, String templateSelector) The new version of the getContentNew methos.
byte[]	getContentNew(CmsObject cms, CmsXmlWpTemplateFile templateFile, String elementName, Hashtable parameters, String templateSelector) The old version of the getContentNew methos.
byte[]	getContentPermissions(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
byte[]	getContentUndelete(CmsObject cms, CmsXmlWpTemplateFile template, String elementName, Hashtable parameters, String templateSelector) Gets the content of a given template file.
abstract String	getCreateUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the create url of the module.
String	getDeleteUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the edit url of the module.
abstract String	getEditUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the edit url of the module.
Integer	getFilter(CmsObject cms, CmsXmlLanguageFile lang, Vector names, Vector values, Hashtable parameters) This method creates the selectbox in the head-frame
Integer	getHistory(CmsObject cms, CmsXmlLanguageFile lang, Vector names, Vector values, Hashtable parameters) Gets all versions of the resource from the history.
String	getHistoryUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the history url of the module.
String	getPreviewUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the preview url of the module.
String	getPublishUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the publish url of the module.
Integer	getSelectedPage(CmsObject cms, CmsXmlLanguageFile lang, Vector names, Vector values, Hashtable parameters) This method creates the selectbox with all avaiable Pages to select from.
String	getSetupUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the setup url of the module.
String	getUndeleteUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the undelete url of the module.
String	getUrl(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) Gets the redirect url of the module.
Object	handleCheckbox(CmsObject cms, String tagcontent, A_CmsXmlContent doc, Object userObject) User method that handles a checkbox in the input form of the backoffice.
boolean	isExtendedList() Checks if the extended list should be used for displaying the cd
String	readSaveGroupName(CmsObject cms, int id)
String	readSaveUserName(CmsObject cms, int id)

Methods inherited from class com.opencms.workplace.CmsWorkplaceDefault

bubblesort, checkJavaProperty, checkPort, doNotShow, getCacheDirectives, getConfigFile, getConstantSelectEntries, getFonts, getKey, getLastUrl, getOwnTemplateFile, isAdmin, isAdminFalse, isCacheable, isNotOnlineProject, isOnlineProject, isProjectManager, isStreamable, isTheAdminUser, picsUrl, resourcesUri, scriptsUri, startProcessing, userName

Methods inherited from class com.opencms.template.CmsXmlTemplate

collectCacheDirectives, counter, createElement, getClassName, getContent, getDescription, getEncoding, getFileUri, getFrameQueryString, getFrameTarget, getKeywords, getMethodCacheDirectives, getPathUri, getProperty, getQueryString, getRequestIp, getServletPath, getSessionId, getStylesheet, getTemplateClassName, getTemplateFileName, getTemplateSelector, getTitle, getTitleEscaped, getUri, getUriWithParameter, isTemplateCacheSet, mergeAbsolutePath, mergeAbsoluteUrl, parameters, registerVariantDeps, setEncoding, setTemplateCache, shouldReload, templateElement, throwException, throwException, throwException

Methods inherited from class com.opencms.template.A_CmsTemplate

debugPrint, isExportable, isProxyPrivateCacheable, isProxyPublicCacheable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.opencms.template.I_CmsTemplate

isExportable, isProxyPrivateCacheable, isProxyPublicCacheable

Field Detail

C_NOT_LOCKED

public static int C_NOT_LOCKED

C_NO_ACCESS

public static int C_NO_ACCESS

C_DEFAULT_PERMISSIONS

protected static final int C_DEFAULT_PERMISSIONS

Default value of permission

See Also:

Constant Field Values

C_ACCESS_FLAGS

protected static final String[] C_ACCESS_FLAGS

Constructor Detail

A_CmsBackoffice

public A_CmsBackoffice()

Method Detail

getBackofficeUrl

public abstract String getBackofficeUrl(CmsObject cms,
                                        String tagcontent,
                                        A_CmsXmlContent doc,
                                        Object userObject)
                                 throws Exception

Gets the backoffice url of the module.

Returns:

A string with the backoffice url

Exception

getCreateUrl

public abstract String getCreateUrl(CmsObject cms,
                                    String tagcontent,
                                    A_CmsXmlContent doc,
                                    Object userObject)
                             throws Exception

Gets the create url of the module.

Returns:

a string with the create url

Exception

getEditUrl

public abstract String getEditUrl(CmsObject cms,
                                  String tagcontent,
                                  A_CmsXmlContent doc,
                                  Object userObject)
                           throws Exception

Gets the edit url of the module.

Returns:

A string with the edit url

Exception

getDeleteUrl

public String getDeleteUrl(CmsObject cms,
                           String tagcontent,
                           A_CmsXmlContent doc,
                           Object userObject)
                    throws Exception

Gets the edit url of the module.

Returns:

A string with the edit url

Exception

getUndeleteUrl

public String getUndeleteUrl(CmsObject cms,
                             String tagcontent,
                             A_CmsXmlContent doc,
                             Object userObject)
                      throws Exception

Gets the undelete url of the module.

Returns:

A string with the undelete url

Exception

getPublishUrl

public String getPublishUrl(CmsObject cms,
                            String tagcontent,
                            A_CmsXmlContent doc,
                            Object userObject)
                     throws Exception

Gets the publish url of the module.

Returns:

A string with the publish url

Exception

getHistoryUrl

public String getHistoryUrl(CmsObject cms,
                            String tagcontent,
                            A_CmsXmlContent doc,
                            Object userObject)
                     throws Exception

Gets the history url of the module.

Returns:

A string with the history url

Exception

getUrl

public String getUrl(CmsObject cms,
                     String tagcontent,
                     A_CmsXmlContent doc,
                     Object userObject)
              throws Exception

Gets the redirect url of the module. This URL is called, when an entry of the file list is selected

Returns:

A string with the url.

Exception

getSetupUrl

public String getSetupUrl(CmsObject cms,
                          String tagcontent,
                          A_CmsXmlContent doc,
                          Object userObject)
                   throws Exception

Gets the setup url of the module. This is the url of the setup page for this module.

Returns:

A string with the setup url.

Exception

getPreviewUrl

public String getPreviewUrl(CmsObject cms,
                            String tagcontent,
                            A_CmsXmlContent doc,
                            Object userObject)
                     throws Exception

Gets the preview url of the module. This is the url of the preview page for this module.

Returns:

A string with the setup url.

Exception

getContent

public byte[] getContent(CmsObject cms,
                         String templateFile,
                         String elementName,
                         Hashtable parameters,
                         String templateSelector)
                  throws CmsException

Gets the content of a given template file. This method displays any content provided by a content definition class on the template. The used backoffice class does not need to use a special getContent method. It just has to extend the methods of this class! Using reflection, this method creates the table headline and table content with the layout provided by the template automatically!

Specified by:

getContent in interface I_CmsTemplate

Overrides:

getContent in class CmsXmlTemplate

Parameters:

cms - A_CmsObject Object for accessing system resources

templateFile - Filename of the template file

elementName - not used here.

parameters - not used here.

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

See Also:

CmsXmlTemplate.getContent(CmsObject, String, String, Hashtable, String)

getContentDefinitionClass

public abstract Class getContentDefinitionClass()

Gets the content definition class

Returns:

class content definition class Must be implemented in the extending backoffice class!

getContentDefinition

protected Object getContentDefinition(CmsObject cms,
                                      Class cdClass,
                                      Integer id)

Gets the content definition class method constructor

Returns:

content definition object

getContentDefinition

protected Object getContentDefinition(CmsObject cms,
                                      Class cdClass)

Gets the content definition class method constructor

Returns:

content definition object

getContentDefinition

protected Object getContentDefinition(CmsObject cms,
                                      Class cdClass,
                                      String id)

Gets the content definition class method constructor

Returns:

content definition object

readSaveUserName

public String readSaveUserName(CmsObject cms,
                               int id)

Parameters:

cms - A CmsObject to read the user with

id - The id of the user to read

Returns:

The name of the user, or the id (as a String) in case the user has been deleted

readSaveGroupName

public String readSaveGroupName(CmsObject cms,
                                int id)

Parameters:

cms - A CmsObject to read the group with

id - The id of the group to read

Returns:

The name of the group, or the id (as a String) in case the group has been deleted

getContentDelete

public byte[] getContentDelete(CmsObject cms,
                               CmsXmlWpTemplateFile template,
                               String elementName,
                               Hashtable parameters,
                               String templateSelector)
                        throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the delete dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getContentUndelete

public byte[] getContentUndelete(CmsObject cms,
                                 CmsXmlWpTemplateFile template,
                                 String elementName,
                                 Hashtable parameters,
                                 String templateSelector)
                          throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the delete dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getContentCopy

public byte[] getContentCopy(CmsObject cms,
                             CmsXmlWpTemplateFile template,
                             String elementName,
                             Hashtable parameters,
                             String templateSelector)
                      throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the delete dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getContentDirectPublish

public byte[] getContentDirectPublish(CmsObject cms,
                                      CmsXmlWpTemplateFile template,
                                      String elementName,
                                      Hashtable parameters,
                                      String templateSelector)
                               throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the direct publish dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getContentHistory

public byte[] getContentHistory(CmsObject cms,
                                CmsXmlWpTemplateFile template,
                                String elementName,
                                Hashtable parameters,
                                String templateSelector)
                         throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the history dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getHistory

public Integer getHistory(CmsObject cms,
                          CmsXmlLanguageFile lang,
                          Vector names,
                          Vector values,
                          Hashtable parameters)
                   throws CmsException

Gets all versions of the resource from the history.

The given vectors names and values will be filled with the appropriate information to be used for building a select box.

Parameters:

cms - CmsObject Object for accessing system resources.

names - Vector to be filled with the appropriate values in this method.

values - Vector to be filled with the appropriate values in this method.

parameters - Hashtable containing all user parameters (not used here).

Returns:

Index representing the current value in the vectors.

Throws:

CmsException

getContentPermissions

public byte[] getContentPermissions(CmsObject cms,
                                    CmsXmlWpTemplateFile template,
                                    String elementName,
                                    Hashtable parameters,
                                    String templateSelector)
                             throws CmsException

Gets the content of a given template file.

While processing the template file the table entry entryTitle will be displayed in the delete dialog

Parameters:

cms - A_CmsObject Object for accessing system resources

elementName - not used here

parameters - get the parameters action for the button activity and id for the used content definition instance object

templateSelector - template section that should be processed.

Returns:

Processed content of the given template file.

Throws:

CmsException

getContentNew

public byte[] getContentNew(CmsObject cms,
                            CmsXmlWpTemplateFile templateFile,
                            String elementName,
                            Hashtable parameters,
                            String templateSelector)
                     throws CmsException

The old version of the getContentNew methos. Only available for compatilibility resons. Per default, it uses the edit dialog. If you want to use a seperate input form, you have to create a new one and write your own getContentNew method in your backoffice class.

CmsException

getContentNew

public String getContentNew(CmsObject cms,
                            CmsXmlWpTemplateFile template,
                            A_CmsContentDefinition cd,
                            String elementName,
                            Enumeration keys,
                            Hashtable parameters,
                            String templateSelector)
                     throws CmsException

The new version of the getContentNew methos. Only this one should be used from now on. Per default, it uses the edit dialog. If you want to use a seperate input form, you have to create a new one and write your own getContentNew method in your backoffice class.

CmsException

getContentEdit

public byte[] getContentEdit(CmsObject cms,
                             CmsXmlWpTemplateFile templateFile,
                             String elementName,
                             Hashtable parameters,
                             String templateSelector)
                      throws CmsException

Gets the content of a edited entry form. Has to be overwritten in your backoffice class if the old way of writeing BackOffices is used. Only available for compatibility reasons.

CmsException

getContentEdit

public String getContentEdit(CmsObject cms,
                             CmsXmlWpTemplateFile templateFile,
                             A_CmsContentDefinition cd,
                             String elementName,
                             Enumeration keys,
                             Hashtable parameters,
                             String templateSelector)
                      throws CmsException

Gets the content of a edited entry form. Has to be overwritten in your backoffice class if the new way of writeing BackOffices is used.

CmsException

isExtendedList

public boolean isExtendedList()

Checks if the extended list should be used for displaying the cd

Returns:

boolean Is true the extended list should be used

getFilter

public Integer getFilter(CmsObject cms,
                         CmsXmlLanguageFile lang,
                         Vector names,
                         Vector values,
                         Hashtable parameters)
                  throws CmsException

This method creates the selectbox in the head-frame

CmsException

handleCheckbox

public Object handleCheckbox(CmsObject cms,
                             String tagcontent,
                             A_CmsXmlContent doc,
                             Object userObject)
                      throws CmsException

User method that handles a checkbox in the input form of the backoffice.

CmsException

getSelectedPage

public Integer getSelectedPage(CmsObject cms,
                               CmsXmlLanguageFile lang,
                               Vector names,
                               Vector values,
                               Hashtable parameters)
                        throws CmsException

This method creates the selectbox with all avaiable Pages to select from.

CmsException

checkbox

public Object checkbox(CmsObject cms,
                       String tagcontent,
                       A_CmsXmlContent doc,
                       Object userObject)
                throws CmsException

user-method to create a checkbox with the according hidden field

Parameters:

cms - the CmsObject

tagcontent - params of the user-method

doc -

userObject -

Returns:

Object

CmsException