tools.gsf.properties

Class AssetApiPropertyDao

java.lang.Object

tools.gsf.properties.AssetApiPropertyDao

All Implemented Interfaces:

PropertyDao

public final class AssetApiPropertyDao
extends Object
implements PropertyDao

Class representing properties stored as an asset. Can be basic or flex. Property name field must be a core asset field ("name" is usually chosen). Other fields can be set as needed.

Adding a new property adds it to the current site, as defined by the pubid session variable.

Since:

2011-09-02

Author:

Tony Field

Constructor Summary

Constructors

Constructor and Description
AssetApiPropertyDao(com.fatwire.assetapi.data.AssetDataManager adm, com.fatwire.assetapi.site.SiteManager siteManager, String type, String flexDefName, String propNameAttr, String propDescAttr, String propValueAttr, COM.FutureTense.Interfaces.ICS ics) Property dao backed by a basic or flex asset.

Method Summary

Modifier and Type	Method and Description
void	addToSite(String name, String... site) Add the property specified to the sites specified.
Property	getProperty(String name)
Collection<String>	getPropertyNames()
void	setProperty(Property property) Set (or re-set) a property value
void	setProperty(String name, String description, String value) Convenience method to set (or re-set) a property value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetApiPropertyDao

public AssetApiPropertyDao(com.fatwire.assetapi.data.AssetDataManager adm,
                           com.fatwire.assetapi.site.SiteManager siteManager,
                           String type,
                           String flexDefName,
                           String propNameAttr,
                           String propDescAttr,
                           String propValueAttr,
                           COM.FutureTense.Interfaces.ICS ics)

Property dao backed by a basic or flex asset.

Parameters:

adm - asset data manager

siteManager - site manager

type - asset type to be used

flexDefName - flex definition, if using a flex asset; null if using a basic asset

propNameAttr - attribute name holding property name. Must be a core asset field (i.e. in the main row of the asset) so that lookups can be done properly. Must be a string attribute type.

propDescAttr - attribute name holding the description of the property Must be a string attribute type.

propValueAttr - attribute name holding the property value. Must be a string attribute type.

ics - ics context

Method Detail

getProperty

public Property getProperty(String name)

Specified by:

getProperty in interface PropertyDao

getPropertyNames

public Collection<String> getPropertyNames()

Specified by:

getPropertyNames in interface PropertyDao

setProperty

public void setProperty(String name,
                        String description,
                        String value)

Convenience method to set (or re-set) a property value

Specified by:

setProperty in interface PropertyDao

Parameters:

name - property name

description - property description (optional)

value - value as a string

setProperty

public void setProperty(Property property)

Set (or re-set) a property value

Specified by:

setProperty in interface PropertyDao

Parameters:

property - property object with name and value

addToSite

public void addToSite(String name,
                      String... site)

Description copied from interface: PropertyDao

Add the property specified to the sites specified. The property is NOT un-shared from any other sites using this tag (it only adds additional sites)

Specified by:

addToSite in interface PropertyDao

Parameters:

name - property name

site - site names to add the property to