Package org.alfresco.service.cmr.site

Interface SiteInfo

All Superinterfaces:

PermissionCheckValue

All Known Implementing Classes:

SiteInfoImpl

@AlfrescoPublicApi
public interface SiteInfo
extends PermissionCheckValue

Method Summary

Modifier and Type	Method	Description
Date	getCreatedDate()	Get the site created date
Map<QName,Serializable>	getCustomProperties()	Get the custom property values
Serializable	getCustomProperty(QName name)	Get the value of a custom property
String	getDescription()	Get the description
boolean	getIsPublic()	Deprecated. as of version 3.2, replaced by getVisibility()
Date	getLastModifiedDate()	Get the site last modified date
NodeRef	getNodeRef()	Get the site node reference
String	getShortName()	Get the short name
String	getSitePreset()	Get the site preset
String	getTitle()	Get the title
SiteVisibility	getVisibility()	Get the sites visibility
void	setCreatedDate(Date createdDate)	Set the site created date
void	setDescription(String description)	Set the description
void	setIsPublic(boolean isPublic)	Deprecated. as of version 3.2, replaced by setVisibility(SiteVisibility)
void	setLastModifiedDate(Date lastModifiedDate)	Set the site last modified date
void	setTitle(String title)	Set the title
void	setVisibility(SiteVisibility visibility)	Set the sites visibility

Method Detail

getNodeRef

NodeRef getNodeRef()

Get the site node reference

Specified by:

getNodeRef in interface PermissionCheckValue

Returns:

NodeRef site node reference, null if not set

getSitePreset

String getSitePreset()

Get the site preset

Returns:

String site preset

getShortName

String getShortName()

Get the short name

Returns:

String short name

getTitle

String getTitle()

Get the title

Returns:

String site title

setTitle

void setTitle(String title)

Set the title

Parameters:

title - site title

getDescription

String getDescription()

Get the description

Returns:

String site description

setDescription

void setDescription(String description)

Set the description

Parameters:

description - site description

setIsPublic

void setIsPublic(boolean isPublic)

Deprecated.

as of version 3.2, replaced by 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 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

Map<QName,Serializable> getCustomProperties()

Get the custom property values

Returns:

map of custom property names and values

getCustomProperty

Serializable getCustomProperty(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

getCreatedDate

Date getCreatedDate()

Get the site created date

Returns:

Date site created date

setCreatedDate

void setCreatedDate(Date createdDate)

Set the site created date

Parameters:

createdDate - site created date

getLastModifiedDate

Date getLastModifiedDate()

Get the site last modified date

Returns:

Date site last modified date

setLastModifiedDate

void setLastModifiedDate(Date lastModifiedDate)

Set the site last modified date

Parameters:

lastModifiedDate - site last modified date