i_cmsconstants.java

java 编写的程序

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/core/I_CmsConstants.java,v $
* Date   : $Date: 2002/04/30 09:33:23 $
* Version: $Revision: 1.198 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* For further information about OpenCms, please see the
* OpenCms Website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

package com.opencms.core;

/**
 * This interface is a pool for cms-constants. All classes may implement this
 * class to get access to this contsnats.
 *
 * @author Andreas Schouten
 * @author Michael Emmerich
 * @author Michaela Schleich
 *
 * @version $Revision: 1.198 $ $Date: 2002/04/30 09:33:23 $
 */
public interface I_CmsConstants {

    /**
     * The copyright message for OpenCms.
     */
    static String C_COPYRIGHT[] =  {
        "",
        "Copyright (C) 2001 The OpenCms Group",
        "OpenCms comes with ABSOLUTELY NO WARRANTY",
        "This is free software, and you are welcome to",
        "redistribute it under certain conditions.",
        "Please see the GNU Lesser General Public Licence for",
        "further details.",
        ""
    };

    /**
     * Replacekey for the webapplication name (used in opencms.properties)
     */
    static final String C_WEB_APP_REPLACE_KEY = "${WEB_APP_NAME}";

    /**
     * The minimum-size of a passwordstring.
     */
    static final int C_PASSWORD_MINIMUMSIZE = 4;

    /**
     * The maximum length of a resource name (incl. path).
     */
    static final int C_MAX_LENGTH_RESOURCE_NAME = 240;

    /**
     * This flag is set for enabled entrys in the database.
     * (GROUP_FLAGS for example)
     */
    static final int C_FLAG_ENABLED = 0;

    /**
     * This flag is set for disabled entrys in the database.
     * (GROUP_FLAGS for example)
     */
    static final int C_FLAG_DISABLED = 1;

    /**
     * Flag constant: Projectmanager
     * flag for groups
     */
    static final int C_FLAG_GROUP_PROJECTMANAGER = 2;

    /**
     * Flag constant: ProjectCoWorker
     * flag for groups
     */
    static final int C_FLAG_GROUP_PROJECTCOWORKER = 4;

    /**
     * Flag constant: Role (for coworkers)
     * flag for groups
     */
    static final int C_FLAG_GROUP_ROLE = 8;

    /** Path to the workplace ini file */
    static final String C_PATH_INTERNAL_TEMPLATES = "/content/internal/";

    /** Path to the root of all modules */
    public static final String C_MODULES_PATH = "/system/modules/";

    /** prefix for temporary files */
    public static final String C_TEMP_PREFIX = "~";

    /**
     * The last index, that was used for resource-types.
     */
    final static String C_TYPE_LAST_INDEX = "lastIndex";

    /**
     * The resource type-id for a folder.
     */
    final static int C_TYPE_FOLDER = 0;

    /**
     * The resource type-id for a folder.
     */
    final static String C_TYPE_FOLDER_NAME = "folder";

    /** The resource type-name for an image. */
    final static String C_TYPE_IMAGE_NAME = "image";

    /**
     * The resource type-name for a page file.
     */
    final static String C_TYPE_PAGE_NAME = "page";

    /**
     * The resource type-name for plain files.
     */
    final static String C_TYPE_PLAIN_NAME = "plain";

    /**
     * The resource type-name for compatiblePlain files. This type is
     * used by the opencms system to show the user that this resource doesent
     * fit to the new standard in the folder content.
     */
    final static String C_TYPE_COMPATIBLEPLAIN_NAME = "compatiblePlain";

    /**
     * The resource type-name for body files.
     */
    final static String C_TYPE_BODY_NAME = "body";

    /**
     * Property for resource title
     */
    static final String C_PROPERTY_TITLE = "Title";

    /**
     * Property for resource navigation title
     */
    static final String C_PROPERTY_NAVTEXT = "NavText";

    /**
     * Property for resource navigation title
     */
    static final String C_PROPERTY_VISIBLE = "visiblemethod";

    /**
     * Property for resource export name. When resource is exported
     * by the static export this name is used instead of the realname.
     */
    static final String C_PROPERTY_EXPORTNAME = "exportname";

    /**
     * Property for resource export name. When resource is exported
     * by the static export this name is used instead of the realname.
     */
    static final String C_PROPERTY_EXPORT = "export";

    /**
     * Property for resource navigation title
     */
    static final String C_PROPERTY_ACTIV = "activemethod";

    /**
     * Property for resource navigation position
     */
    static final String C_PROPERTY_NAVPOS = "NavPos";

    /**
     * Property for template type
     */
    static final String C_PROPERTY_TEMPLATETYPE = "TemplateType";

    /**
     * Property for keywords
     */
    static final String C_PROPERTY_KEYWORDS = "Keywords";

    /**
     * Property for the description
     */
    static final String C_PROPERTY_DESCRIPTION = "Description";

    /**
     * Property for the description
     */
    static final String C_PROPERTY_CHANNELID = "ChannelId";

    /**
     * This is the group for guests.
     */
    static final String C_GROUP_GUEST = "Guests";

    /**
     * This is the group for administrators.
     */
    static final String C_GROUP_ADMIN = "Administrators";

    /**
     * This is the group for projectleaders. It is the only group, which
     * can create new projects.
     */
    static final String C_GROUP_PROJECTLEADER = "Projectmanager";

    /**
     * This is the group for users. If you are in this group, you can use
     * the workplace.
     */
    static final String C_GROUP_USERS = "Users";

    /**
     * This is the group for guests.
     */
    static final String C_USER_GUEST = "Guest";

    /**
     * This is the group for administrators.
     */
    static final String C_USER_ADMIN = "Admin";

    /**
     * A user-type
     */
    static final int C_USER_TYPE_SYSTEMUSER = 0;

    /**
     * A user-type
     */
    static final int C_USER_TYPE_WEBUSER = 1;

    /**
     * A user-type
     */
    static final int C_USER_TYPE_SYSTEMANDWEBUSER = 2;

    /**
     * Key for additional info address.
     */
    final static String C_ADDITIONAL_INFO_ZIPCODE = "USER_ZIPCODE";

    /**
     * Key for additional info address.
     */
    final static String C_ADDITIONAL_INFO_TOWN = "USER_TOWN";

    /**
     * Key for additional info flags.
     */
    final static String C_ADDITIONAL_INFO_PREFERENCES = "USER_PREFERENCES";

    /** Key for additional info explorer settings. */
    final static String C_ADDITIONAL_INFO_EXPLORERSETTINGS = "USER_EXPLORERSETTINGS";

    /** Key for additional info task settings. */
    final static String C_ADDITIONAL_INFO_TASKSETTINGS = "USER_TASKSETTINGS";

    /** Key for additional info start settings. */
    final static String C_ADDITIONAL_INFO_STARTSETTINGS = "USER_STARTSETTINGS";

    /**
     * This constant is used to order the tasks by date.
     */
    static final int C_TASK_ORDER_BY_DATE = 1;

    /**
     * This constant is used to order the tasks by name.
     */
    static final int C_TASK_ORDER_BY_NAME = 2;

    // TODO: add order-criteria here.

    /**
     * This constant defines the onlineproject. This is the project which
     * is used to show the resources for guestusers
     */
    static final String C_PROJECT_ONLINE = "Online";

    /**
     * This constant defines the onlineproject. This is the project which
     * is used to show the resources for guestusers
     */
    static final int C_PROJECT_ONLINE_ID = 1;

    /**
     * This constant defines a normal project-type.
     */
    static final int C_PROJECT_TYPE_NORMAL = 0;

    /**
     * This constant defines a temporary project-type.
     * The project will be deleted after publishing
     */
    static final int C_PROJECT_TYPE_TEMPORARY = 1;

    /**
     * This constant defines a invisible project-type.
     * The project exists only for temporary files
     * and will never be displayed, published or deleted
     */
    static final int C_PROJECT_TYPE_INVISIBLE = 3;

    /**
     * This constant defines a unlocked project.
     * Resources may be changed in this project.
     */
    static final int C_PROJECT_STATE_UNLOCKED = 0;

    /**
     * This constant defines a locked project.
     * Resources can't be changed in this project.
     */
    static final int C_PROJECT_STATE_LOCKED = 1;

    /**
     * This constant defines a project in a archive.
     * Resources can't be changed in this project. Its state will never
     * go back to the previos one.
     */
    static final int C_PROJECT_STATE_ARCHIVE = 2;

    /**
     * This constant defines a project that is invisible.
     * The project is invisible for users. It is needed
     * for creating and editing temporary files
     */
    static final int C_PROJECT_STATE_INVISIBLE = 3;

    /**
     * This id will be returned for resources with no id.
     * (filesystem resources)
     */
    final static int C_UNKNOWN_ID = -1;

    /**
     * Owner may read this resource
     */
    final static int C_ACCESS_OWNER_READ = 1;

    /**
     * Owner may write this resource
     */
    final static int C_ACCESS_OWNER_WRITE = 2;

    /**
     * Owner may view this resource
     */
    final static int C_ACCESS_OWNER_VISIBLE = 4;

    /**
     * Group may read this resource
     */
    final static int C_ACCESS_GROUP_READ = 8;

    /**
     * Group may write this resource
     */
    final static int C_ACCESS_GROUP_WRITE = 16;

    /**
     * Group may view this resource
     */
    final static int C_ACCESS_GROUP_VISIBLE = 32;

    /**
     *  may read this resource
     */
    final static int C_ACCESS_PUBLIC_READ = 64;

    /**
     *  may write this resource
     */
    final static int C_ACCESS_PUBLIC_WRITE = 128;

    /**
     *  may view this resource
     */
    final static int C_ACCESS_PUBLIC_VISIBLE = 256;

    /**
     * This is an internal resource, it can't be launched directly.
     */
    final static int C_ACCESS_INTERNAL_READ = 512;

    /**
     * All may read this resource.
     */
    final static int C_ACCESS_READ = C_ACCESS_OWNER_READ + C_ACCESS_GROUP_READ + C_ACCESS_PUBLIC_READ;

    /**
     * All may write this resource.
     */
    final static int C_ACCESS_WRITE = C_ACCESS_OWNER_WRITE + C_ACCESS_GROUP_WRITE + C_ACCESS_PUBLIC_WRITE;

    /**
     * All may view this resource.
     */
    final static int C_ACCESS_VISIBLE = C_ACCESS_OWNER_VISIBLE + C_ACCESS_GROUP_VISIBLE + C_ACCESS_PUBLIC_VISIBLE;

    /**
     * Owner has full access to this resource.
     */
    final static int C_ACCESS_OWNER = C_ACCESS_OWNER_READ + C_ACCESS_OWNER_WRITE + C_ACCESS_OWNER_VISIBLE;