com.fatwire.assetapi.site

Interface Site

@Exported
public interface Site

The Object that represents a Site inforamtion in Content Server

Method Summary

Modifier and Type	Method and Description
List<String>	getAssetTypes() Gets the list of enabled asset types for the site
String	getCSPrefix() Gets the prefix string for this site; prefix is primarily used in naming asset and in site replication assets named with this prefix when copied with be given new name with new prefix
String	getCSPreview() Gets the preview string for this sie
AssetId	getCSPreviewAsset() Gets the preview asset for this site
String	getDescription() Gets the description for the site
Long	getId() Gets the site id
String	getName() Gets the site name
String	getPubroot() Gets the pub root for this site
List<String>	getUserRoles(String user) Gets the list of roles that this user has in the site
List<String>	getUsers() Gets the list of usernames that are granted access to this site
String	getWebroot() Gets the default webroot for this site
void	setAssetTypes(List<String> assettypes) Sets the list of enabled asset types for the site
void	setCSPrefix(String csprefix) Gets the prefix string for this site; prefix is primarily used in naming asset and in site replication assets named with this prefix when copied with be given new name with new prefix
void	setCSPreview(String cspreview) Sets the preview string for this site
void	setCSPreviewAsset(AssetId assetid) Sets the preview asset for this site
void	setDescription(String desc) Sets the site description
void	setId(Long siteid) Sets the side id
void	setName(String name) Sets the site name
void	setPubroot(String pubroot) Sets the pubroot for this site
void	setUserRoles(String user, List<String> userRoles) Sets the list of roles that this user has in the site
void	setWebroot(String defaultWebroot) Sets the default webroot for this site

Method Detail

getName

String getName()

Gets the site name

Returns:

the site name

setName

void setName(String name)

Sets the site name

Parameters:

name - the name of the site

getDescription

String getDescription()

Gets the description for the site

Returns:

the site description

setDescription

void setDescription(String desc)

Sets the site description

Parameters:

desc - the description of the site

getId

Long getId()

Gets the site id

Returns:

the id of the site

setId

void setId(Long siteid)

Sets the side id

Parameters:

siteid - the id of the site

getAssetTypes

List<String> getAssetTypes()

Gets the list of enabled asset types for the site

Returns:

the asset type list that are enabled for the site

setAssetTypes

void setAssetTypes(List<String> assettypes)

Sets the list of enabled asset types for the site

Parameters:

assettypes - the asset type list that are enabled for the site

getUsers

List<String> getUsers()

Gets the list of usernames that are granted access to this site

Returns:

the list usernames

getUserRoles

List<String> getUserRoles(String user)

Gets the list of roles that this user has in the site

Parameters:

user - the username

Returns:

the list of roles that this user has in the site

setUserRoles

void setUserRoles(String user,
                  List<String> userRoles)

Sets the list of roles that this user has in the site

Parameters:

user - the username

userRoles - the list of roles that this user has in the site

getPubroot

String getPubroot()

Gets the pub root for this site

Returns:

the pub root

setPubroot

void setPubroot(String pubroot)

Sets the pubroot for this site

Parameters:

pubroot - the pubroot name

getCSPreview

String getCSPreview()

Gets the preview string for this sie

Returns:

the preview string

setCSPreview

void setCSPreview(String cspreview)

Sets the preview string for this site

Parameters:

cspreview - the preview string

getCSPrefix

String getCSPrefix()

Gets the prefix string for this site; prefix is primarily used in naming asset and in site replication assets named with this prefix when copied with be given new name with new prefix

Returns:

the prefix string

setCSPrefix

void setCSPrefix(String csprefix)

Gets the prefix string for this site; prefix is primarily used in naming asset and in site replication assets named with this prefix when copied with be given new name with new prefix

Parameters:

csprefix - the prefix string

getCSPreviewAsset

AssetId getCSPreviewAsset()

Gets the preview asset for this site

Returns:

the preview asset

setCSPreviewAsset

void setCSPreviewAsset(AssetId assetid)

Sets the preview asset for this site

Parameters:

assetid - the preview asset

getWebroot

String getWebroot()

Gets the default webroot for this site

Returns:

the default webroot for this site

setWebroot

void setWebroot(String defaultWebroot)

Sets the default webroot for this site

Parameters:

defaultWebroot - default webroot for this site