mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-22 15:12:38 +00:00
cefda8c965
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
124 lines
3.5 KiB
Java
124 lines
3.5 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco 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.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.service.cmr.site;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
public interface SiteInfo
|
|
{
|
|
/**
|
|
* Get the site node reference
|
|
*
|
|
* @return NodeRef site node reference, null if not set
|
|
*/
|
|
public abstract NodeRef getNodeRef();
|
|
|
|
/**
|
|
* Get the site preset
|
|
*
|
|
* @return String site preset
|
|
*/
|
|
public abstract String getSitePreset();
|
|
|
|
/**
|
|
* Get the short name
|
|
*
|
|
* @return String short name
|
|
*/
|
|
public abstract String getShortName();
|
|
|
|
/**
|
|
* Get the title
|
|
*
|
|
* @return String site title
|
|
*/
|
|
public abstract String getTitle();
|
|
|
|
/**
|
|
* Set the title
|
|
*
|
|
* @param title site title
|
|
*/
|
|
public abstract void setTitle(String title);
|
|
|
|
/**
|
|
* Get the description
|
|
*
|
|
* @return String site description
|
|
*/
|
|
public abstract String getDescription();
|
|
|
|
/**
|
|
* Set the description
|
|
*
|
|
* @param description site description
|
|
*/
|
|
public abstract void setDescription(String description);
|
|
|
|
/**
|
|
* Sets whether this site is public or not. If true the visibility is set to "public", if false
|
|
* the visibility is set to "private"
|
|
*
|
|
* @param isPublic true public, false private
|
|
* @deprecated as of version 3.2, replaced by {@link #setVisibility(SiteVisibility)}
|
|
*/
|
|
public abstract void setIsPublic(boolean isPublic);
|
|
|
|
/**
|
|
* Indicates whether the site is public.
|
|
*
|
|
* @return boolean true if public, false either private or moderated
|
|
* @deprecated as of version 3.2, replaced by {@link #getVisibility()}
|
|
*/
|
|
public abstract boolean getIsPublic();
|
|
|
|
/**
|
|
* Get the sites visibility
|
|
*
|
|
* @return SiteVisibility site visibility
|
|
*/
|
|
public abstract SiteVisibility getVisibility();
|
|
|
|
/**
|
|
* Set the sites visibility
|
|
*
|
|
* @param visibility site visibility
|
|
*/
|
|
public abstract void setVisibility(SiteVisibility visibility);
|
|
|
|
/**
|
|
* Get the custom property values
|
|
*
|
|
* @return Map<QName, Serializable> map of custom property names and values
|
|
*/
|
|
public abstract Map<QName, Serializable> getCustomProperties();
|
|
|
|
/**
|
|
* Get the value of a custom property
|
|
*
|
|
* @param name name of custom property
|
|
* @return Serializable value of the property, null if not set or doesn't exist
|
|
*/
|
|
public abstract Serializable getCustomProperty(QName name);
|
|
|
|
} |