com.fatwire.assetapi.site
Interface SiteManager

public interface SiteManager

Manager class for site CRUD

Method Summary

void	create(java.util.List<Site> sites) Creates a list of Sites
void	delete(java.util.List<java.lang.String> siteNames) Deletes the list of Sites of given names
java.util.List<SiteInfo>	list() Gets the list of SiteInfo exist in Content Server
QueryResultWrapper<java.util.List<SiteInfo>>	list(Condition query, java.util.List<SortOrder> sortorders, int start, int count) Gets the list of SiteInfo exist in Content Server
QueryResultWrapper<java.util.List<Site>>	read(Condition query) Gets a list of Sites that satisfies the Condition passed in
QueryResultWrapper<java.util.List<Site>>	read(Condition query, java.util.List<SortOrder> sortorders, int start, int count) Gets a list of Sites that satisfies the Condition passed in
java.util.List<Site>	read(java.util.List<java.lang.String> siteNames) Gets the list of Sites given the Site names.
void	update(java.util.List<Site> sites) Updates the Site information for the list of passed Sites

Method Detail

list

java.util.List<SiteInfo> list()
                              throws SiteAccessException

Gets the list of SiteInfo exist in Content Server

Returns:

the list of SiteInfo

Throws:

SiteAccessException - throw this exception when error met

list

QueryResultWrapper<java.util.List<SiteInfo>> list(Condition query,
                                                  java.util.List<SortOrder> sortorders,
                                                  int start,
                                                  int count)
                                                  throws SiteAccessException

Gets the list of SiteInfo exist in Content Server

Parameters:

query - the simple Condition that the results will be returned against - only name, description, and id are supported

sortorders - the attributes of site that the results will be sorted upon - only name, description and id are supported

start - the start number where you want to results from

count - the total number sites you want the list contain

Returns:

the list of site SiteInfo

Throws:

SiteAccessException - throw this exception when error met

read

java.util.List<Site> read(java.util.List<java.lang.String> siteNames)
                          throws SiteAccessException

Gets the list of Sites given the Site names. If one wants to read the list of Sites back without using list() method to get the names first, one should use read(Conditin query) method with an empty query or specify null

Parameters:

siteNames - the list of Site names

Returns:

the list of Site of given names

Throws:

SiteAccessException - throw this exception when error met

read

QueryResultWrapper<java.util.List<Site>> read(Condition query)
                                              throws SiteAccessException

Gets a list of Sites that satisfies the Condition passed in

Parameters:

query - the query Condition for the Sites

Returns:

the list of Sites that satisfies the Condition

Throws:

SiteAccessException - throw this exception when error met

read

QueryResultWrapper<java.util.List<Site>> read(Condition query,
                                              java.util.List<SortOrder> sortorders,
                                              int start,
                                              int count)
                                              throws SiteAccessException

Gets a list of Sites that satisfies the Condition passed in

Parameters:

query - the query Condition for the Sites

sortorders - the attributes of site that the results will be sorted upon - only name, description and id are supported

start - the start number where you want to results from

count - the total number sites you want the list contain

Returns:

the list of Sites that satisfies the Condition

Throws:

SiteAccessException - throw this exception when error met

update

void update(java.util.List<Site> sites)
            throws SiteAccessException

Updates the Site information for the list of passed Sites

Parameters:

sites - the list of Sites to update

Throws:

SiteAccessException - throw this exception when error met

create

void create(java.util.List<Site> sites)
            throws SiteAccessException

Creates a list of Sites

Parameters:

sites - the list of Sites

Throws:

SiteAccessException - throw this exception when error met

delete

void delete(java.util.List<java.lang.String> siteNames)
            throws SiteAccessException

Deletes the list of Sites of given names

Parameters:

siteNames - the names of the Sites that will be deleted

Throws:

SiteAccessException