org.alfresco.service.cmr.site

Interface SiteInfo

All Superinterfaces:

PermissionCheckValue

All Known Implementing Classes:

SiteInfoImpl

public interface SiteInfo
extends PermissionCheckValue

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map	getCustomProperties() Get the custom property values
java.io.Serializable	getCustomProperty(org.alfresco.service.namespace.QName name) Get the value of a custom property
java.lang.String	getDescription() Get the description
boolean	getIsPublic() Deprecated. as of version 3.2, replaced by SiteInfo.getVisibility()
org.alfresco.service.cmr.repository.NodeRef	getNodeRef() Get the site node reference
java.lang.String	getShortName() Get the short name
java.lang.String	getSitePreset() Get the site preset
java.lang.String	getTitle() Get the title
SiteVisibility	getVisibility() Get the sites visibility
void	setDescription(java.lang.String description) Set the description
void	setIsPublic(boolean isPublic) Deprecated. as of version 3.2, replaced by SiteInfo.setVisibility(SiteVisibility)
void	setTitle(java.lang.String title) Set the title
void	setVisibility(SiteVisibility visibility) Set the sites visibility

Method Detail

getNodeRef

org.alfresco.service.cmr.repository.NodeRef getNodeRef()

Get the site node reference

Specified by:

getNodeRef in interface PermissionCheckValue

Returns:

NodeRef site node reference, null if not set

getSitePreset

java.lang.String getSitePreset()

Get the site preset

Returns:

String site preset

getShortName

java.lang.String getShortName()

Get the short name

Returns:

String short name

getTitle

java.lang.String getTitle()

Get the title

Returns:

String site title

setTitle

void setTitle(java.lang.String title)

Set the title

Parameters:

title - site title

getDescription

java.lang.String getDescription()

Get the description

Returns:

String site description

setDescription

void setDescription(java.lang.String description)

Set the description

Parameters:

description - site description

setIsPublic

void setIsPublic(boolean isPublic)

Deprecated. as of version 3.2, replaced by SiteInfo.setVisibility(SiteVisibility)

Sets whether this site is public or not. If true the visibility is set to "public", if false the visibility is set to "private"

Parameters:

isPublic - true public, false private

getIsPublic

boolean getIsPublic()

Deprecated. as of version 3.2, replaced by SiteInfo.getVisibility()

Indicates whether the site is public.

Returns:

boolean true if public, false either private or moderated

getVisibility

SiteVisibility getVisibility()

Get the sites visibility

Returns:

SiteVisibility site visibility

setVisibility

void setVisibility(SiteVisibility visibility)

Set the sites visibility

Parameters:

visibility - site visibility

getCustomProperties

java.util.Map getCustomProperties()

Get the custom property values

Returns:

Map map of custom property names and values

getCustomProperty

java.io.Serializable getCustomProperty(org.alfresco.service.namespace.QName name)

Get the value of a custom property

Parameters:

name - name of custom property

Returns:

Serializable value of the property, null if not set or doesn't exist